| <rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Apache Dubbo – Observability of Dubbo</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/</link><description>Recent content in Observability of Dubbo on Apache Dubbo</description><generator>Hugo -- gohugo.io</generator><language>en</language><atom:link href="https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/index.xml" rel="self" type="application/rss+xml"/><item><title>Docs3-V2: Meter</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/meter/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/meter/</guid><description> |
| <h1 id="overview">overview</h1> |
| <h2 id="1-indicator-access-instructions">1. Indicator access instructions</h2> |
| <h2 id="2-indicator-system-design">2. Indicator system design</h2> |
| <p>Dubbo&rsquo;s indicator system involves three parts in total, indicator collection, local aggregation, and indicator push |
| Indicator collection: Push the indicators that need to be monitored inside Dubbo to a unified Collector for storage |
| Local Aggregation: All indicators collected are basic indicators, and some quantile indicators need to be calculated through local aggregation |
| Indicator push: The collected and aggregated indicators are pushed to third-party servers in a certain way, currently only involving Prometheus</p> |
| <h2 id="3-structural-design">3. Structural Design</h2> |
| <ul> |
| <li>Remove the original classes related to Metrics</li> |
| <li>Create new modules dubbo-metrics/dubbo-metrics-api, dubbo-metrics/dubbo-metrics-prometheus, MetricsConfig as the configuration class of the module</li> |
| <li>Use micrometer, use basic types in Collector to represent indicators, such as Long, Double, etc., and introduce micrometer in dubbo-metrics-api, and use micrometer to convert internal indicators</li> |
| </ul> |
| <h2 id="4-data-flow">4. data flow</h2> |
| <p><img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/observability/dataflow.png" alt="img.png"></p> |
| <h2 id="5-goals">5. Goals</h2> |
| <p>The indicator interface will provide a MetricsService, which not only provides interface-level data of the flexible service, but also provides query methods for all indicators. The interface for querying method-level indicators can be declared as follows</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">interface</span> <span style="color:#268bd2">MetricsService</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Default {@link MetricsService} extension name. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> String DEFAULT_EXTENSION_NAME <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;default&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * The contract version of {@link MetricsService}, the future update must make sure compatible. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> String VERSION <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;1.0.0&#34;</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Get metrics by prefixes |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param categories categories |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return metrics - key=MetricCategory value=MetricsEntityList |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>MetricsCategory<span style="color:#719e07">,</span> List<span style="color:#719e07">&lt;</span>MetricsEntity<span style="color:#719e07">&gt;&gt;</span> <span style="color:#268bd2">getMetricsByCategories</span><span style="color:#719e07">(</span>List<span style="color:#719e07">&lt;</span>MetricsCategory<span style="color:#719e07">&gt;</span> categories<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Get metrics by interface and prefixes |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param serviceUniqueName serviceUniqueName (eg.group/interfaceName:version) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param categories categories |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return metrics - key=MetricCategory value=MetricsEntityList |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>MetricsCategory<span style="color:#719e07">,</span> List<span style="color:#719e07">&lt;</span>MetricsEntity<span style="color:#719e07">&gt;&gt;</span> <span style="color:#268bd2">getMetricsByCategories</span><span style="color:#719e07">(</span>String serviceUniqueName<span style="color:#719e07">,</span> List<span style="color:#719e07">&lt;</span>MetricsCategory<span style="color:#719e07">&gt;</span> categories<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">/** |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * Get metrics by interface、method and prefixes |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param serviceUniqueName serviceUniqueName (eg.group/interfaceName:version) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param methodName methodName |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param parameterTypes method parameter types |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @param categories categories |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> * @return metrics - key=MetricCategory value=MetricsEntityList |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"> */</span> |
| </span></span><span style="display:flex;"><span> Map<span style="color:#719e07">&lt;</span>MetricsCategory<span style="color:#719e07">,</span> List<span style="color:#719e07">&lt;</span>MetricsEntity<span style="color:#719e07">&gt;&gt;</span> <span style="color:#268bd2">getMetricsByCategories</span><span style="color:#719e07">(</span>String serviceUniqueName<span style="color:#719e07">,</span> String methodName<span style="color:#719e07">,</span> Class<span style="color:#719e07">&lt;?&gt;[]</span> parameterTypes<span style="color:#719e07">,</span> List<span style="color:#719e07">&lt;</span>MetricsCategory<span style="color:#719e07">&gt;</span> categories<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>Among them, MetricsCategory is designed as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">enum</span> MetricsCategory <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> RT<span style="color:#719e07">,</span> |
| </span></span><span style="display:flex;"><span> QPS<span style="color:#719e07">,</span> |
| </span></span><span style="display:flex;"><span> REQUESTS<span style="color:#719e07">,</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>MetricsEntity is designed as follows</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MetricsEntity</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String name<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> Map<span style="color:#719e07">&lt;</span>String<span style="color:#719e07">,</span> String<span style="color:#719e07">&gt;</span> tags<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> MetricsCategory category<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> Object value<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h1 id="metrics-collection">metrics collection</h1> |
| <h2 id="1-embedding-position">1. Embedding position</h2> |
| <p>The Dubbo architecture diagram is as follows |
| <img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/observability/dubbo.png" alt="img.png"></p> |
| <p>Add a layer of MetricsFilter to the provider, rewrite the invoke method, embed the call link to collect metrics, and use try-catch-finally for processing. The core code is as follows</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">@Activate</span><span style="color:#719e07">(</span>group <span style="color:#719e07">=</span> PROVIDER<span style="color:#719e07">,</span> order <span style="color:#719e07">=</span> <span style="color:#719e07">-</span>1<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MetricsFilter</span> <span style="color:#268bd2">implements</span> Filter<span style="color:#719e07">,</span> ScopeModelAware <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">@Override</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> Result <span style="color:#268bd2">invoke</span><span style="color:#719e07">(</span>Invoker<span style="color:#719e07">&lt;?&gt;</span> invoker<span style="color:#719e07">,</span> Invocation invocation<span style="color:#719e07">)</span> <span style="color:#268bd2">throws</span> RpcException <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> collector<span style="color:#719e07">.</span>increaseTotalRequests<span style="color:#719e07">(</span>interfaceName<span style="color:#719e07">,</span> methodName<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> version<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> collector<span style="color:#719e07">.</span>increaseProcessingRequests<span style="color:#719e07">(</span>interfaceName<span style="color:#719e07">,</span> methodName<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> version<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> Long startTime <span style="color:#719e07">=</span> System<span style="color:#719e07">.</span>currentTimeMillis<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Result invoke <span style="color:#719e07">=</span> invoker<span style="color:#719e07">.</span>invoke<span style="color:#719e07">(</span>invocation<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> collector<span style="color:#719e07">.</span>increaseSucceedRequests<span style="color:#719e07">(</span>interfaceName<span style="color:#719e07">,</span> methodName<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> version<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> invoke<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>RpcException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> collector<span style="color:#719e07">.</span>increaseFailedRequests<span style="color:#719e07">(</span>interfaceName<span style="color:#719e07">,</span> methodName<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> version<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> e<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">finally</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> Long endTime <span style="color:#719e07">=</span> System<span style="color:#719e07">.</span>currentTimeMillis<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> Long rt <span style="color:#719e07">=</span> endTime <span style="color:#719e07">-</span> startTime<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> collector<span style="color:#719e07">.</span>addRT<span style="color:#719e07">(</span>interfaceName<span style="color:#719e07">,</span> methodName<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> version<span style="color:#719e07">,</span> rt<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> collector<span style="color:#719e07">.</span>decreaseProcessingRequests<span style="color:#719e07">(</span>interfaceName<span style="color:#719e07">,</span> methodName<span style="color:#719e07">,</span> group<span style="color:#719e07">,</span> version<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="2-indicator-identification">2. Indicator identification</h2> |
| <p>Use the following five attributes as the isolation level to distinguish and identify different methods, which are also the keys of each ConcurrentHashMap</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">MethodMetric</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String applicationName<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String interfaceName<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String methodName<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String group<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> String version<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="3-basic-indicators">3. Basic indicators</h2> |
| <p>Metrics store all metrics data through MetricsCollector under the common module</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">DefaultMetricsCollector</span> <span style="color:#268bd2">implements</span> MetricsCollector <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> Boolean collectEnabled <span style="color:#719e07">=</span> <span style="color:#cb4b16">false</span><span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> List<span style="color:#719e07">&lt;</span>MetricsListener<span style="color:#719e07">&gt;</span> listeners <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ArrayList<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> ApplicationModel applicationModel<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> String applicationName<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> totalRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> succeedRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> failedRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> processingRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> lastRT <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> LongAccumulator<span style="color:#719e07">&gt;</span> minRT <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> LongAccumulator<span style="color:#719e07">&gt;</span> maxRT <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> avgRT <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> totalRT <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> AtomicLong<span style="color:#719e07">&gt;</span> rtCount <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h1 id="local-aggregation">local aggregation</h1> |
| <p>Local aggregation refers to the process of obtaining quantile indicators by calculating some simple indicators</p> |
| <h2 id="1-parameter-design">1. Parameter Design</h2> |
| <p>When collecting indicators, only the basic indicators are collected by default, and some stand-alone aggregation indicators need to enable service flexibility or start a new thread calculation after local aggregation. If service flexibility is enabled here, local aggregation is enabled by default</p> |
| <h3 id="11-how-to-enable-local-aggregation">1.1 How to enable local aggregation</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:metrics&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:aggregation</span> enable=<span style="color:#2aa198">&#34;true&#34;</span> <span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:metrics&gt;</span> |
| </span></span></code></pre></div><h3 id="12-index-aggregation-parameters">1.2 Index Aggregation Parameters</h3> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dubbo:metrics&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dubbo:aggregation</span> enable=<span style="color:#2aa198">&#34;true&#34;</span> bucket-num=<span style="color:#2aa198">&#34;5&#34;</span> time-window-seconds=<span style="color:#2aa198">&#34;10&#34;</span><span style="color:#268bd2">/&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dubbo:metrics&gt;</span> |
| </span></span></code></pre></div><h2 id="2-specific-indicators">2. Specific indicators</h2> |
| <p>Four key metrics to monitor. They call it the &ldquo;four golden signals&rdquo;: Latency, Traffic, Errors, and Saturation. |
| Dubbo mainly includes the following monitoring indicators:</p> |
| <table> |
| <thead> |
| <tr> |
| <th style="text-align:left"></th> |
| <th style="text-align:left">infrastructure</th> |
| <th style="text-align:left">business monitoring</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td style="text-align:left">Latency</td> |
| <td style="text-align:left">IO wait； RPC Latency；</td> |
| <td style="text-align:left">Interface, average service time, TP90, TP99, TP999, etc.</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Traffic</td> |
| <td style="text-align:left">network and disk IO；</td> |
| <td style="text-align:left">QPS at the service level</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Errors</td> |
| <td style="text-align:left">Downtime; disk (bad disk or file system error); process or port hang; network packet loss;</td> |
| <td style="text-align:left">Error log; business status code, error code trend;</td> |
| </tr> |
| <tr> |
| <td style="text-align:left">Saturation</td> |
| <td style="text-align:left">System resource utilization: CPU, memory, disk, network, etc.; Saturation: number of waiting threads, queue backlog length;</td> |
| <td style="text-align:left">This mainly includes JVM, thread pool, etc.</td> |
| </tr> |
| </tbody> |
| </table> |
| <ul> |
| <li>qps: Get dynamic qps based on sliding window</li> |
| <li>rt: Get dynamic rt based on sliding window</li> |
| <li>Number of failed requests: Get the number of failed requests in the latest time based on the sliding window</li> |
| <li>Number of successful requests: Get the number of successful requests in the latest time based on the sliding window</li> |
| <li>The number of processing requests: Add Filter simple statistics before and after</li> |
| <li>Specific indicators rely on sliding windows, and additionally use AggregateMetricsCollector to collect</li> |
| </ul> |
| <p>The relevant indicators output to Prometheus can be referred to as follows:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span># HELP jvm_gc_live_data_size_bytes Size of long-lived heap memory pool after reclamation |
| </span></span><span style="display:flex;"><span># TYPE jvm_gc_live_data_size_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_gc_live_data_size_bytes 1.6086528E7 |
| </span></span><span style="display:flex;"><span># HELP requests_succeed_aggregate Aggregated Succeed Requests |
| </span></span><span style="display:flex;"><span># TYPE requests_succeed_aggregate gauge |
| </span></span><span style="display:flex;"><span>requests_succeed_aggregate{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 39.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_buffer_memory_used_bytes An estimate of the memory that the Java virtual machine is using for this buffer pool |
| </span></span><span style="display:flex;"><span># TYPE jvm_buffer_memory_used_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_buffer_memory_used_bytes{id=&#34;direct&#34;,} 1.679975E7 |
| </span></span><span style="display:flex;"><span>jvm_buffer_memory_used_bytes{id=&#34;mapped&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_gc_memory_allocated_bytes_total Incremented for an increase in the size of the (young) heap memory pool after one GC to before the next |
| </span></span><span style="display:flex;"><span># TYPE jvm_gc_memory_allocated_bytes_total counter |
| </span></span><span style="display:flex;"><span>jvm_gc_memory_allocated_bytes_total 2.9884416E9 |
| </span></span><span style="display:flex;"><span># HELP requests_total_aggregate Aggregated Total Requests |
| </span></span><span style="display:flex;"><span># TYPE requests_total_aggregate gauge |
| </span></span><span style="display:flex;"><span>requests_total_aggregate{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 39.0 |
| </span></span><span style="display:flex;"><span># HELP system_load_average_1m The sum of the number of runnable entities queued to available processors and the number of runnable entities running on the available processors averaged over a period of time |
| </span></span><span style="display:flex;"><span># TYPE system_load_average_1m gauge |
| </span></span><span style="display:flex;"><span>system_load_average_1m 0.0 |
| </span></span><span style="display:flex;"><span># HELP system_cpu_usage The &#34;recent cpu usage&#34; for the whole system |
| </span></span><span style="display:flex;"><span># TYPE system_cpu_usage gauge |
| </span></span><span style="display:flex;"><span>system_cpu_usage 0.015802269043760128 |
| </span></span><span style="display:flex;"><span># HELP jvm_threads_peak_threads The peak live thread count since the Java virtual machine started or peak was reset |
| </span></span><span style="display:flex;"><span># TYPE jvm_threads_peak_threads gauge |
| </span></span><span style="display:flex;"><span>jvm_threads_peak_threads 40.0 |
| </span></span><span style="display:flex;"><span># HELP requests_processing Processing Requests |
| </span></span><span style="display:flex;"><span># TYPE requests_processing gauge |
| </span></span><span style="display:flex;"><span>requests_processing{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_memory_max_bytes The maximum amount of memory in bytes that can be used for memory management |
| </span></span><span style="display:flex;"><span># TYPE jvm_memory_max_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;profiled nmethods&#39;&#34;,} 1.22912768E8 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;heap&#34;,id=&#34;G1 Survivor Space&#34;,} -1.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;heap&#34;,id=&#34;G1 Old Gen&#34;,} 9.52107008E8 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;nonheap&#34;,id=&#34;Metaspace&#34;,} -1.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;heap&#34;,id=&#34;G1 Eden Space&#34;,} -1.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;non-nmethods&#39;&#34;,} 5828608.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;nonheap&#34;,id=&#34;Compressed Class Space&#34;,} 1.073741824E9 |
| </span></span><span style="display:flex;"><span>jvm_memory_max_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;non-profiled nmethods&#39;&#34;,} 1.22916864E8 |
| </span></span><span style="display:flex;"><span># HELP jvm_threads_states_threads The current number of threads having BLOCKED state |
| </span></span><span style="display:flex;"><span># TYPE jvm_threads_states_threads gauge |
| </span></span><span style="display:flex;"><span>jvm_threads_states_threads{state=&#34;blocked&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span>jvm_threads_states_threads{state=&#34;runnable&#34;,} 10.0 |
| </span></span><span style="display:flex;"><span>jvm_threads_states_threads{state=&#34;waiting&#34;,} 16.0 |
| </span></span><span style="display:flex;"><span>jvm_threads_states_threads{state=&#34;timed-waiting&#34;,} 13.0 |
| </span></span><span style="display:flex;"><span>jvm_threads_states_threads{state=&#34;new&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span>jvm_threads_states_threads{state=&#34;terminated&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_buffer_total_capacity_bytes An estimate of the total capacity of the buffers in this pool |
| </span></span><span style="display:flex;"><span># TYPE jvm_buffer_total_capacity_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_buffer_total_capacity_bytes{id=&#34;direct&#34;,} 1.6799749E7 |
| </span></span><span style="display:flex;"><span>jvm_buffer_total_capacity_bytes{id=&#34;mapped&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP rt_p99 Response Time P99 |
| </span></span><span style="display:flex;"><span># TYPE rt_p99 gauge |
| </span></span><span style="display:flex;"><span>rt_p99{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 1.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_memory_used_bytes The amount of used memory |
| </span></span><span style="display:flex;"><span># TYPE jvm_memory_used_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;heap&#34;,id=&#34;G1 Survivor Space&#34;,} 1048576.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;profiled nmethods&#39;&#34;,} 1.462464E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;heap&#34;,id=&#34;G1 Old Gen&#34;,} 1.6098728E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;nonheap&#34;,id=&#34;Metaspace&#34;,} 4.0126952E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;heap&#34;,id=&#34;G1 Eden Space&#34;,} 8.2837504E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;non-nmethods&#39;&#34;,} 1372032.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;nonheap&#34;,id=&#34;Compressed Class Space&#34;,} 4519248.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_used_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;non-profiled nmethods&#39;&#34;,} 5697408.0 |
| </span></span><span style="display:flex;"><span># HELP qps Query Per Seconds |
| </span></span><span style="display:flex;"><span># TYPE qps gauge |
| </span></span><span style="display:flex;"><span>qps{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 0.3333333333333333 |
| </span></span><span style="display:flex;"><span># HELP rt_min Min Response Time |
| </span></span><span style="display:flex;"><span># TYPE rt_min gauge |
| </span></span><span style="display:flex;"><span>rt_min{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_buffer_count_buffers An estimate of the number of buffers in the pool |
| </span></span><span style="display:flex;"><span># TYPE jvm_buffer_count_buffers gauge |
| </span></span><span style="display:flex;"><span>jvm_buffer_count_buffers{id=&#34;mapped&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span>jvm_buffer_count_buffers{id=&#34;direct&#34;,} 10.0 |
| </span></span><span style="display:flex;"><span># HELP system_cpu_count The number of processors available to the Java virtual machine |
| </span></span><span style="display:flex;"><span># TYPE system_cpu_count gauge |
| </span></span><span style="display:flex;"><span>system_cpu_count 2.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_classes_loaded_classes The number of classes that are currently loaded in the Java virtual machine |
| </span></span><span style="display:flex;"><span># TYPE jvm_classes_loaded_classes gauge |
| </span></span><span style="display:flex;"><span>jvm_classes_loaded_classes 7325.0 |
| </span></span><span style="display:flex;"><span># HELP rt_total Total Response Time |
| </span></span><span style="display:flex;"><span># TYPE rt_total gauge |
| </span></span><span style="display:flex;"><span>rt_total{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 2783.0 |
| </span></span><span style="display:flex;"><span># HELP rt_last Last Response Time |
| </span></span><span style="display:flex;"><span># TYPE rt_last gauge |
| </span></span><span style="display:flex;"><span>rt_last{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_gc_memory_promoted_bytes_total Count of positive increases in the size of the old generation memory pool before GC to after GC |
| </span></span><span style="display:flex;"><span># TYPE jvm_gc_memory_promoted_bytes_total counter |
| </span></span><span style="display:flex;"><span>jvm_gc_memory_promoted_bytes_total 1.4450952E7 |
| </span></span><span style="display:flex;"><span># HELP jvm_gc_pause_seconds Time spent in GC pause |
| </span></span><span style="display:flex;"><span># TYPE jvm_gc_pause_seconds summary |
| </span></span><span style="display:flex;"><span>jvm_gc_pause_seconds_count{action=&#34;end of minor GC&#34;,cause=&#34;Metadata GC Threshold&#34;,} 2.0 |
| </span></span><span style="display:flex;"><span>jvm_gc_pause_seconds_sum{action=&#34;end of minor GC&#34;,cause=&#34;Metadata GC Threshold&#34;,} 0.026 |
| </span></span><span style="display:flex;"><span>jvm_gc_pause_seconds_count{action=&#34;end of minor GC&#34;,cause=&#34;G1 Evacuation Pause&#34;,} 37.0 |
| </span></span><span style="display:flex;"><span>jvm_gc_pause_seconds_sum{action=&#34;end of minor GC&#34;,cause=&#34;G1 Evacuation Pause&#34;,} 0.156 |
| </span></span><span style="display:flex;"><span># HELP jvm_gc_pause_seconds_max Time spent in GC pause |
| </span></span><span style="display:flex;"><span># TYPE jvm_gc_pause_seconds_max gauge |
| </span></span><span style="display:flex;"><span>jvm_gc_pause_seconds_max{action=&#34;end of minor GC&#34;,cause=&#34;Metadata GC Threshold&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span>jvm_gc_pause_seconds_max{action=&#34;end of minor GC&#34;,cause=&#34;G1 Evacuation Pause&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP rt_p95 Response Time P95 |
| </span></span><span style="display:flex;"><span># TYPE rt_p95 gauge |
| </span></span><span style="display:flex;"><span>rt_p95{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 0.0 |
| </span></span><span style="display:flex;"><span># HELP requests_total Total Requests |
| </span></span><span style="display:flex;"><span># TYPE requests_total gauge |
| </span></span><span style="display:flex;"><span>requests_total{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 27738.0 |
| </span></span><span style="display:flex;"><span># HELP process_cpu_usage The &#34;recent cpu usage&#34; for the Java Virtual Machine process |
| </span></span><span style="display:flex;"><span># TYPE process_cpu_usage gauge |
| </span></span><span style="display:flex;"><span>process_cpu_usage 8.103727714748784E-4 |
| </span></span><span style="display:flex;"><span># HELP rt_max Max Response Time |
| </span></span><span style="display:flex;"><span># TYPE rt_max gauge |
| </span></span><span style="display:flex;"><span>rt_max{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 4.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_gc_max_data_size_bytes Max size of long-lived heap memory pool |
| </span></span><span style="display:flex;"><span># TYPE jvm_gc_max_data_size_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_gc_max_data_size_bytes 9.52107008E8 |
| </span></span><span style="display:flex;"><span># HELP jvm_threads_live_threads The current number of live threads including both daemon and non-daemon threads |
| </span></span><span style="display:flex;"><span># TYPE jvm_threads_live_threads gauge |
| </span></span><span style="display:flex;"><span>jvm_threads_live_threads 39.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_threads_daemon_threads The current number of live daemon threads |
| </span></span><span style="display:flex;"><span># TYPE jvm_threads_daemon_threads gauge |
| </span></span><span style="display:flex;"><span>jvm_threads_daemon_threads 36.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_classes_unloaded_classes_total The total number of classes unloaded since the Java virtual machine has started execution |
| </span></span><span style="display:flex;"><span># TYPE jvm_classes_unloaded_classes_total counter |
| </span></span><span style="display:flex;"><span>jvm_classes_unloaded_classes_total 0.0 |
| </span></span><span style="display:flex;"><span># HELP jvm_memory_committed_bytes The amount of memory in bytes that is committed for the Java virtual machine to use |
| </span></span><span style="display:flex;"><span># TYPE jvm_memory_committed_bytes gauge |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;profiled nmethods&#39;&#34;,} 1.4680064E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;heap&#34;,id=&#34;G1 Survivor Space&#34;,} 1048576.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;heap&#34;,id=&#34;G1 Old Gen&#34;,} 5.24288E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;nonheap&#34;,id=&#34;Metaspace&#34;,} 4.1623552E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;heap&#34;,id=&#34;G1 Eden Space&#34;,} 9.0177536E7 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;non-nmethods&#39;&#34;,} 2555904.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;nonheap&#34;,id=&#34;Compressed Class Space&#34;,} 5111808.0 |
| </span></span><span style="display:flex;"><span>jvm_memory_committed_bytes{area=&#34;nonheap&#34;,id=&#34;CodeHeap &#39;non-profiled nmethods&#39;&#34;,} 5701632.0 |
| </span></span><span style="display:flex;"><span># HELP requests_succeed Succeed Requests |
| </span></span><span style="display:flex;"><span># TYPE requests_succeed gauge |
| </span></span><span style="display:flex;"><span>requests_succeed{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 27738.0 |
| </span></span><span style="display:flex;"><span># HELP rt_avg Average Response Time |
| </span></span><span style="display:flex;"><span># TYPE rt_avg gauge |
| </span></span><span style="display:flex;"><span>rt_avg{application_name=&#34;metrics-provider&#34;,group=&#34;&#34;,hostname=&#34;iZ8lgm9icspkthZ&#34;,interface=&#34;org.apache.dubbo.samples.metrics.prometheus.api.DemoService&#34;,ip=&#34;172.28.236.104&#34;,method=&#34;sayHello&#34;,version=&#34;&#34;,} 0.0 |
| </span></span></code></pre></div><h2 id="aggregate-collector">aggregate collector</h2> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">AggregateMetricsCollector</span> <span style="color:#268bd2">implements</span> MetricsCollector<span style="color:#719e07">,</span> MetricsListener <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> bucketNum<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> timeWindowSeconds<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> TimeWindowCounter<span style="color:#719e07">&gt;</span> totalRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> TimeWindowCounter<span style="color:#719e07">&gt;</span> succeedRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> TimeWindowCounter<span style="color:#719e07">&gt;</span> failedRequests <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> TimeWindowCounter<span style="color:#719e07">&gt;</span> qps <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> Map<span style="color:#719e07">&lt;</span>MethodMetric<span style="color:#719e07">,</span> TimeWindowQuantile<span style="color:#719e07">&gt;</span> rt <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> ConcurrentHashMap<span style="color:#719e07">&lt;&gt;();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> ApplicationModel applicationModel<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> Integer DEFAULT_COMPRESSION <span style="color:#719e07">=</span> 100<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> Integer DEFAULT_BUCKET_NUM <span style="color:#719e07">=</span> 10<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">static</span> <span style="color:#268bd2">final</span> Integer DEFAULT_TIME_WINDOW_SECONDS <span style="color:#719e07">=</span> 120<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">//在构造函数中解析配置信息 |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">AggregateMetricsCollector</span><span style="color:#719e07">(</span>ApplicationModel applicationModel<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>applicationModel <span style="color:#719e07">=</span> applicationModel<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> ConfigManager configManager <span style="color:#719e07">=</span> applicationModel<span style="color:#719e07">.</span>getApplicationConfigManager<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> MetricsConfig config <span style="color:#719e07">=</span> configManager<span style="color:#719e07">.</span>getMetrics<span style="color:#719e07">().</span>orElse<span style="color:#719e07">(</span><span style="color:#cb4b16">null</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(</span>config <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">&amp;&amp;</span> config<span style="color:#719e07">.</span>getAggregation<span style="color:#719e07">()</span> <span style="color:#719e07">!=</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">&amp;&amp;</span> Boolean<span style="color:#719e07">.</span>TRUE<span style="color:#719e07">.</span>equals<span style="color:#719e07">(</span>config<span style="color:#719e07">.</span>getAggregation<span style="color:#719e07">().</span>getEnabled<span style="color:#719e07">()))</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// only registered when aggregation is enabled. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> registerListener<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> AggregationConfig aggregation <span style="color:#719e07">=</span> config<span style="color:#719e07">.</span>getAggregation<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>bucketNum <span style="color:#719e07">=</span> aggregation<span style="color:#719e07">.</span>getBucketNum<span style="color:#719e07">()</span> <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">?</span> DEFAULT_BUCKET_NUM <span style="color:#719e07">:</span> aggregation<span style="color:#719e07">.</span>getBucketNum<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>timeWindowSeconds <span style="color:#719e07">=</span> aggregation<span style="color:#719e07">.</span>getTimeWindowSeconds<span style="color:#719e07">()</span> <span style="color:#719e07">==</span> <span style="color:#cb4b16">null</span> <span style="color:#719e07">?</span> DEFAULT_TIME_WINDOW_SECONDS <span style="color:#719e07">:</span> aggregation<span style="color:#719e07">.</span>getTimeWindowSeconds<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><p>If local aggregation is enabled, listeners are added through spring’s BeanFactory, and AggregateMetricsCollector is bound to DefaultMetricsCollector to implement a survivor-consumer model. DefaultMetricsCollector uses a list of listeners for easy expansion</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">registerListener</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> applicationModel<span style="color:#719e07">.</span>getBeanFactory<span style="color:#719e07">().</span>getBean<span style="color:#719e07">(</span>DefaultMetricsCollector<span style="color:#719e07">.</span>class<span style="color:#719e07">).</span>addListener<span style="color:#719e07">(</span><span style="color:#719e07">this</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="3-index-aggregation">3. Index Aggregation</h2> |
| <p>sliding window |
| Suppose we initially have 6 buckets, and each window time is set to 2 minutes |
| Every time the index data is written, the data will be written into 6 buckets respectively, and a bucket will be moved every two minutes and the data in the original bucket will be cleared |
| When reading the indicator, read the bucket pointed to by the current current to achieve the effect of sliding window |
| Specifically, as shown in the figure below, the current bucket stores the data within the bucket life cycle set in the configuration, that is, the recent data |
| <img src="https://dubbo.apache.org/imgs/docs3-v2/java-sdk/observability/aggre.png" alt="img_1.png"></p> |
| <p>In each bucket, use the <strong>TDigest algorithm</strong> to calculate the quantile index</p> |
| <blockquote> |
| <p><strong>TDigest algorithm</strong> (extreme quantile accuracy is high, such as p1 p99, middle quantile accuracy is low, such as p50), the relevant information is as follows&gt;</p> |
| <ul> |
| <li><a href="https://op8867555.github.io/posts/2018-04-09-tdigest.html">https://op8867555.github.io/posts/2018-04-09-tdigest.html</a></li> |
| <li><a href="https://blog.csdn.net/csdnnews/article/details/116246540">https://blog.csdn.net/csdnnews/article/details/116246540</a></li> |
| <li>Open Impl：https://github.com/tdunning/t-digest</li> |
| </ul> |
| </blockquote> |
| <p>The code is implemented as follows, in addition to TimeWindowQuantile is used to calculate quantile indicators, and TimeWindowCounter is provided to collect the number of indicators in the time interval</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">public</span> <span style="color:#268bd2">class</span> <span style="color:#268bd2">TimeWindowQuantile</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> <span style="color:#dc322f">double</span> compression<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> TDigest<span style="color:#719e07">[]</span> ringBuffer<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">int</span> currentBucket<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#dc322f">long</span> lastRotateTimestampMillis<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> <span style="color:#268bd2">final</span> <span style="color:#dc322f">long</span> durationBetweenRotatesMillis<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">TimeWindowQuantile</span><span style="color:#719e07">(</span><span style="color:#dc322f">double</span> compression<span style="color:#719e07">,</span> <span style="color:#dc322f">int</span> bucketNum<span style="color:#719e07">,</span> <span style="color:#dc322f">int</span> timeWindowSeconds<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>compression <span style="color:#719e07">=</span> compression<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>ringBuffer <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> TDigest<span style="color:#719e07">[</span>bucketNum<span style="color:#719e07">];</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> <span style="color:#719e07">(</span><span style="color:#dc322f">int</span> i <span style="color:#719e07">=</span> 0<span style="color:#719e07">;</span> i <span style="color:#719e07">&lt;</span> bucketNum<span style="color:#719e07">;</span> i<span style="color:#719e07">++)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>ringBuffer<span style="color:#719e07">[</span>i<span style="color:#719e07">]</span> <span style="color:#719e07">=</span> TDigest<span style="color:#719e07">.</span>createDigest<span style="color:#719e07">(</span>compression<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>currentBucket <span style="color:#719e07">=</span> 0<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>lastRotateTimestampMillis <span style="color:#719e07">=</span> System<span style="color:#719e07">.</span>currentTimeMillis<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">this</span><span style="color:#719e07">.</span>durationBetweenRotatesMillis <span style="color:#719e07">=</span> TimeUnit<span style="color:#719e07">.</span>SECONDS<span style="color:#719e07">.</span>toMillis<span style="color:#719e07">(</span>timeWindowSeconds<span style="color:#719e07">)</span> <span style="color:#719e07">/</span> bucketNum<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">synchronized</span> <span style="color:#dc322f">double</span> <span style="color:#268bd2">quantile</span><span style="color:#719e07">(</span><span style="color:#dc322f">double</span> q<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> TDigest currentBucket <span style="color:#719e07">=</span> rotate<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> currentBucket<span style="color:#719e07">.</span>quantile<span style="color:#719e07">(</span>q<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">public</span> <span style="color:#268bd2">synchronized</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">add</span><span style="color:#719e07">(</span><span style="color:#dc322f">double</span> value<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> rotate<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">for</span> <span style="color:#719e07">(</span>TDigest bucket <span style="color:#719e07">:</span> ringBuffer<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> bucket<span style="color:#719e07">.</span>add<span style="color:#719e07">(</span>value<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">private</span> TDigest <span style="color:#268bd2">rotate</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">long</span> timeSinceLastRotateMillis <span style="color:#719e07">=</span> System<span style="color:#719e07">.</span>currentTimeMillis<span style="color:#719e07">()</span> <span style="color:#719e07">-</span> lastRotateTimestampMillis<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">while</span> <span style="color:#719e07">(</span>timeSinceLastRotateMillis <span style="color:#719e07">&gt;</span> durationBetweenRotatesMillis<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> ringBuffer<span style="color:#719e07">[</span>currentBucket<span style="color:#719e07">]</span> <span style="color:#719e07">=</span> TDigest<span style="color:#719e07">.</span>createDigest<span style="color:#719e07">(</span>compression<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(++</span>currentBucket <span style="color:#719e07">&gt;=</span> ringBuffer<span style="color:#719e07">.</span>length<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> currentBucket <span style="color:#719e07">=</span> 0<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> timeSinceLastRotateMillis <span style="color:#719e07">-=</span> durationBetweenRotatesMillis<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> lastRotateTimestampMillis <span style="color:#719e07">+=</span> durationBetweenRotatesMillis<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">return</span> ringBuffer<span style="color:#719e07">[</span>currentBucket<span style="color:#719e07">];</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h1 id="indicator-push">Indicator push</h1> |
| <p>Metrics push can only be enabled after the user has set &lt;dubbo:metrics /&gt; configuration and configured protocol parameters. If only metrics aggregation is enabled, metrics will not be pushed by default.</p> |
| <h2 id="1-promehteus-pull-service-discovery">1. Promehteus Pull Service Discovery</h2> |
| <p>Use dubbo-admin and other similar middle layers, and push the local IP, Port, and MetricsURL address information to dubbo-admin (or any middle layer) according to the configuration at startup, and expose HTTP ServiceDiscovery for prometheus to read. The configuration method is as follows: dubbo:metrics protocol=&ldquo;prometheus&rdquo; mode=&ldquo;pull&rdquo; address=&quot;${dubbo-admin.address}&quot; port=&ldquo;20888&rdquo; url=&quot;/metrics&quot;/&gt;, where address is an optional parameter in pull mode, If not filled, the user needs to manually configure the address in the Prometheus configuration file</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">exportHttpServer</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> exporterEnabled <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_EXPORTER_ENABLED_KEY<span style="color:#719e07">,</span> <span style="color:#cb4b16">false</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(</span>exporterEnabled<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> port <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_EXPORTER_METRICS_PORT_KEY<span style="color:#719e07">,</span> PROMETHEUS_DEFAULT_METRICS_PORT<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> String path <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_EXPORTER_METRICS_PATH_KEY<span style="color:#719e07">,</span> PROMETHEUS_DEFAULT_METRICS_PATH<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(!</span>path<span style="color:#719e07">.</span>startsWith<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;/&#34;</span><span style="color:#719e07">))</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> path <span style="color:#719e07">=</span> <span style="color:#2aa198">&#34;/&#34;</span> <span style="color:#719e07">+</span> path<span style="color:#719e07">;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> prometheusExporterHttpServer <span style="color:#719e07">=</span> HttpServer<span style="color:#719e07">.</span>create<span style="color:#719e07">(</span><span style="color:#719e07">new</span> InetSocketAddress<span style="color:#719e07">(</span>port<span style="color:#719e07">),</span> 0<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> prometheusExporterHttpServer<span style="color:#719e07">.</span>createContext<span style="color:#719e07">(</span>path<span style="color:#719e07">,</span> httpExchange <span style="color:#719e07">-&gt;</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> String response <span style="color:#719e07">=</span> prometheusRegistry<span style="color:#719e07">.</span>scrape<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> httpExchange<span style="color:#719e07">.</span>sendResponseHeaders<span style="color:#719e07">(</span>200<span style="color:#719e07">,</span> response<span style="color:#719e07">.</span>getBytes<span style="color:#719e07">().</span>length<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">(</span>OutputStream os <span style="color:#719e07">=</span> httpExchange<span style="color:#719e07">.</span>getResponseBody<span style="color:#719e07">())</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> os<span style="color:#719e07">.</span>write<span style="color:#719e07">(</span>response<span style="color:#719e07">.</span>getBytes<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">});</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> httpServerThread <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> Thread<span style="color:#719e07">(</span>prometheusExporterHttpServer<span style="color:#719e07">::</span>start<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> httpServerThread<span style="color:#719e07">.</span>start<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>IOException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">throw</span> <span style="color:#719e07">new</span> RuntimeException<span style="color:#719e07">(</span>e<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div><h2 id="2-prometheus-push-pushgateway">2. Prometheus Push Pushgateway</h2> |
| <p>Users can directly configure the address of Prometheus Pushgateway in the Dubbo configuration file, such as &lt;dubbo:metrics protocol=&ldquo;prometheus&rdquo; mode=&ldquo;push&rdquo; address=&quot;${prometheus.pushgateway-url}&quot; interval=&ldquo;5&rdquo; /&gt;, Where interval represents the push interval</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">private</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">schedulePushJob</span><span style="color:#719e07">()</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">boolean</span> pushEnabled <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_PUSHGATEWAY_ENABLED_KEY<span style="color:#719e07">,</span> <span style="color:#cb4b16">false</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(</span>pushEnabled<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> String baseUrl <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_PUSHGATEWAY_BASE_URL_KEY<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> String job <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_PUSHGATEWAY_JOB_KEY<span style="color:#719e07">,</span> PROMETHEUS_DEFAULT_JOB_NAME<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#dc322f">int</span> pushInterval <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_PUSHGATEWAY_PUSH_INTERVAL_KEY<span style="color:#719e07">,</span> PROMETHEUS_DEFAULT_PUSH_INTERVAL<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> String username <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_PUSHGATEWAY_USERNAME_KEY<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> String password <span style="color:#719e07">=</span> url<span style="color:#719e07">.</span>getParameter<span style="color:#719e07">(</span>PROMETHEUS_PUSHGATEWAY_PASSWORD_KEY<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> NamedThreadFactory threadFactory <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> NamedThreadFactory<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;prometheus-push-job&#34;</span><span style="color:#719e07">,</span> <span style="color:#cb4b16">true</span><span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> pushJobExecutor <span style="color:#719e07">=</span> Executors<span style="color:#719e07">.</span>newScheduledThreadPool<span style="color:#719e07">(</span>1<span style="color:#719e07">,</span> threadFactory<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> PushGateway pushGateway <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> PushGateway<span style="color:#719e07">(</span>baseUrl<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">if</span> <span style="color:#719e07">(!</span>StringUtils<span style="color:#719e07">.</span>isBlank<span style="color:#719e07">(</span>username<span style="color:#719e07">))</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> pushGateway<span style="color:#719e07">.</span>setConnectionFactory<span style="color:#719e07">(</span><span style="color:#719e07">new</span> BasicAuthHttpConnectionFactory<span style="color:#719e07">(</span>username<span style="color:#719e07">,</span> password<span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> pushJobExecutor<span style="color:#719e07">.</span>scheduleWithFixedDelay<span style="color:#719e07">(()</span> <span style="color:#719e07">-&gt;</span> push<span style="color:#719e07">(</span>pushGateway<span style="color:#719e07">,</span> job<span style="color:#719e07">),</span> pushInterval<span style="color:#719e07">,</span> pushInterval<span style="color:#719e07">,</span> TimeUnit<span style="color:#719e07">.</span>SECONDS<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">protected</span> <span style="color:#dc322f">void</span> <span style="color:#268bd2">push</span><span style="color:#719e07">(</span>PushGateway pushGateway<span style="color:#719e07">,</span> String job<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">try</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> pushGateway<span style="color:#719e07">.</span>pushAdd<span style="color:#719e07">(</span>prometheusRegistry<span style="color:#719e07">.</span>getPrometheusRegistry<span style="color:#719e07">(),</span> job<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> <span style="color:#719e07">catch</span> <span style="color:#719e07">(</span>IOException e<span style="color:#719e07">)</span> <span style="color:#719e07">{</span> |
| </span></span><span style="display:flex;"><span> logger<span style="color:#719e07">.</span>error<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;Error occurred when pushing metrics to prometheus: &#34;</span><span style="color:#719e07">,</span> e<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">}</span> |
| </span></span><span style="display:flex;"><span><span style="color:#719e07">}</span> |
| </span></span></code></pre></div></description></item><item><title>Docs3-V2: Tracing</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/tracing/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/tracing/</guid><description> |
| <h1 id="overview">Overview</h1> |
| <p>Apache Dubbo has inbuilt tracing through <a href="https://micrometer.io/">Micrometer Observations</a> and <a href="https://github.com/micrometer-metrics/tracing">Micrometer Tracing</a>.</p> |
| <h2 id="1-adding-micrometer-observation-to-your-project">1. Adding Micrometer Observation To Your Project</h2> |
| <p>In order to add Micrometer to the classpath and add metrics for Dubbo you need to add the <code>dubbo-metrics-api</code> dependency as shown below:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> <span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>org.apache.dubbo<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>dubbo-metrics-api<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>Thanks to the usage of <a href="https://micrometer.io/">Micrometer Observations</a> Dubbo got instrumented once, but depending on the setup will allow emission of metrics, tracer or other signals via custom <code>ObservationHandlers</code>. Please read the <a href="https://micrometer.io">documentation under docs/observation</a> for more information.</p> |
| <h2 id="2-adding-micrometer-tracing-bridge-to-your-project">2. Adding Micrometer Tracing Bridge To Your Project</h2> |
| <p>In order to start creating spans for Dubbo based projects a <code>bridge</code> between Micrometer Tracing and an actual Tracer is required.</p> |
| <blockquote> |
| <p>NOTE: Tracer is a library that handles lifecycle of spans (e.g. it can create, start, stop, sample, report spans).</p> |
| </blockquote> |
| <p>Micrometer Tracing supports <a href="https://github.com/openzipkin/brave">Brave</a> and <a href="https://github.com/open-telemetry/opentelemetry-java">OpenTelemetry</a> as Tracers as shown below:</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- Brave Tracer --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.micrometer<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>micrometer-tracing-bridge-brave<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">&lt;!-- OpenTelemetry Tracer --&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.micrometer<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>micrometer-tracing-bridge-otel<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><h2 id="3-adding-micrometer-tracing-exporter-to-your-project">3. Adding Micrometer Tracing Exporter To Your Project</h2> |
| <p>After having added the Tracer, an exporter (also known as a reporter) is required. It&rsquo;s a component that will export the finished span and send it to a reporting system. Micrometer Tracer natively supports Tanzu Observability by Wavefront and Zipkin as shown below:</p> |
| <p>Tanzu Observability by Wavefront</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.micrometer<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>micrometer-tracing-reporter-wavefront<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>OpenZipkin Zipkin with Brave</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.zipkin.reporter2<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>zipkin-reporter-brave<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>OpenZipkin Zipkin with OpenTelemetry</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.opentelemetry<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>opentelemetry-exporter-zipkin<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>An OpenZipkin URL sender dependency to send out spans to Zipkin via a URLConnectionSender</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-xml" data-lang="xml"><span style="display:flex;"><span><span style="color:#268bd2">&lt;dependency&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;groupId&gt;</span>io.zipkin.reporter2<span style="color:#268bd2">&lt;/groupId&gt;</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#268bd2">&lt;artifactId&gt;</span>zipkin-sender-urlconnection<span style="color:#268bd2">&lt;/artifactId&gt;</span> |
| </span></span><span style="display:flex;"><span><span style="color:#268bd2">&lt;/dependency&gt;</span> |
| </span></span></code></pre></div><p>You can read more about tracing setup <a href="https://micrometer.io/">this documentation, under docs/tracing</a>.</p> |
| <h2 id="4-setting-up-the-observation-registry">4. Setting Up The Observation Registry</h2> |
| <p>To use Micrometer Observation an <code>ObservationRegistry</code> needs setting up. In essence <code>ObservationRegistry</code> requires passing of <code>ObservationHandler</code>s that will react to lifecycle events of observations such as start, stop etc. There are 3 main types of handlers</p> |
| <ul> |
| <li><code>MeterObservationHandler</code> - metrics related handlers (coming from <code>micrometer-core</code>)</li> |
| <li><code>TracingObservationHandler</code> - tracing related handlers (coming from <code>micrometer-tracing</code>)</li> |
| <li><code>ObservationHandler</code> - any other handler</li> |
| </ul> |
| <p><code>ObservationRegistry</code> will iterate over all handlers and will pick all of the matching ones. It&rsquo;s good practice to put all <code>MeterObservationHandler</code>s into one <code>FirstMatchingCompositeObservationHandler</code> and all <code>TracingObservationHandler</code>s into another composite so that only one gets executed respectively. Example of such setup can be found below (an up to date copy is maintained <a href="https://micrometer.io">here under docs/tracing</a>).</p> |
| <div class="highlight"><pre tabindex="0" style="color:#93a1a1;background-color:#002b36;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-java" data-lang="java"><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// ----- MICROMETER TRACING + BRAVE ----- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Brave component] Example of using a SpanHandler. SpanHandler is a component |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// that gets called when a span is finished. Here we have an example of setting it |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// up with sending spans |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// in a Zipkin format to the provided location via the UrlConnectionSender |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// (through the &lt;io.zipkin.reporter2:zipkin-sender-urlconnection&gt; dependency) |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// Another option could be to use a TestSpanHandler for testing purposes. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>SpanHandler spanHandler <span style="color:#719e07">=</span> ZipkinSpanHandler |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>create<span style="color:#719e07">(</span>AsyncReporter<span style="color:#719e07">.</span>create<span style="color:#719e07">(</span>URLConnectionSender<span style="color:#719e07">.</span>create<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;http://localhost:9411/api/v2/spans&#34;</span><span style="color:#719e07">)));</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Brave component] CurrentTraceContext is a Brave component that allows you to |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// retrieve the current TraceContext. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>StrictCurrentTraceContext braveCurrentTraceContext <span style="color:#719e07">=</span> StrictCurrentTraceContext<span style="color:#719e07">.</span>create<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Micrometer Tracing component] A Micrometer Tracing wrapper for Brave&#39;s |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// CurrentTraceContext |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>CurrentTraceContext bridgeContext <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> BraveCurrentTraceContext<span style="color:#719e07">(</span><span style="color:#719e07">this</span><span style="color:#719e07">.</span>braveCurrentTraceContext<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Brave component] Tracing is the root component that allows to configure the |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75">// tracer, handlers, context propagation etc. |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Tracing tracing <span style="color:#719e07">=</span> Tracing<span style="color:#719e07">.</span>newBuilder<span style="color:#719e07">().</span>currentTraceContext<span style="color:#719e07">(</span><span style="color:#719e07">this</span><span style="color:#719e07">.</span>braveCurrentTraceContext<span style="color:#719e07">).</span>supportsJoin<span style="color:#719e07">(</span><span style="color:#cb4b16">false</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>traceId128Bit<span style="color:#719e07">(</span><span style="color:#cb4b16">true</span><span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#586e75">// For Baggage to work you need to provide a list of fields to propagate |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> <span style="color:#719e07">.</span>propagationFactory<span style="color:#719e07">(</span>BaggagePropagation<span style="color:#719e07">.</span>newFactoryBuilder<span style="color:#719e07">(</span>B3Propagation<span style="color:#719e07">.</span>FACTORY<span style="color:#719e07">)</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>add<span style="color:#719e07">(</span>BaggagePropagationConfig<span style="color:#719e07">.</span>SingleBaggageField |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>remote<span style="color:#719e07">(</span>BaggageField<span style="color:#719e07">.</span>create<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;from_span_in_scope 1&#34;</span><span style="color:#719e07">)))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>add<span style="color:#719e07">(</span>BaggagePropagationConfig<span style="color:#719e07">.</span>SingleBaggageField |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>remote<span style="color:#719e07">(</span>BaggageField<span style="color:#719e07">.</span>create<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;from_span_in_scope 2&#34;</span><span style="color:#719e07">)))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>add<span style="color:#719e07">(</span>BaggagePropagationConfig<span style="color:#719e07">.</span>SingleBaggageField<span style="color:#719e07">.</span>remote<span style="color:#719e07">(</span>BaggageField<span style="color:#719e07">.</span>create<span style="color:#719e07">(</span><span style="color:#2aa198">&#34;from_span&#34;</span><span style="color:#719e07">)))</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>build<span style="color:#719e07">())</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>sampler<span style="color:#719e07">(</span>Sampler<span style="color:#719e07">.</span>ALWAYS_SAMPLE<span style="color:#719e07">).</span>addSpanHandler<span style="color:#719e07">(</span><span style="color:#719e07">this</span><span style="color:#719e07">.</span>spanHandler<span style="color:#719e07">).</span>build<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Brave component] Tracer is a component that handles the life-cycle of a span |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>brave<span style="color:#719e07">.</span>Tracer braveTracer <span style="color:#719e07">=</span> tracing<span style="color:#719e07">.</span>tracer<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Micrometer Tracing component] A wrapper for Brave&#39;s Propagator |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Propagator propagator <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> BravePropagator<span style="color:#719e07">(</span>tracing<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// [Micrometer Tracing component] A Micrometer Tracing wrapper for Brave&#39;s Tracer |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>Tracer tracer <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> BraveTracer<span style="color:#719e07">(</span>braveTracer<span style="color:#719e07">,</span> bridgeContext<span style="color:#719e07">,</span> <span style="color:#719e07">new</span> BraveBaggageManager<span style="color:#719e07">());</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// ----- MICROMETER CORE ----- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span>MeterRegistry meterRegistry <span style="color:#719e07">=</span> <span style="color:#719e07">new</span> SimpleMeterRegistry<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// ----- MICROMETER OBSERVATION ----- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span>ObservationRegistry observationRegistry <span style="color:#719e07">=</span> ObservationRegistry<span style="color:#719e07">.</span>create<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Adding metrics handler |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>observationRegistry<span style="color:#719e07">.</span>observationConfig<span style="color:#719e07">().</span>observationHandler<span style="color:#719e07">(</span><span style="color:#719e07">new</span> TracingAwareMeterObservationHandler<span style="color:#719e07">&lt;&gt;(</span><span style="color:#719e07">new</span> DefaultMeterObservationHandler<span style="color:#719e07">(</span>meterRegistry<span style="color:#719e07">),</span> tracer<span style="color:#719e07">));</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// Adding tracing handlers |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span>observationRegistry<span style="color:#719e07">.</span>observationConfig<span style="color:#719e07">()</span> |
| </span></span><span style="display:flex;"><span> <span style="color:#719e07">.</span>observationHandler<span style="color:#719e07">(</span><span style="color:#719e07">new</span> ObservationHandler<span style="color:#719e07">.</span>FirstMatchingCompositeObservationHandler<span style="color:#719e07">(</span><span style="color:#719e07">new</span> PropagatingReceiverTracingObservationHandler<span style="color:#719e07">&lt;&gt;(</span>tracer<span style="color:#719e07">,</span> propagator<span style="color:#719e07">),</span> <span style="color:#719e07">new</span> PropagatingSenderTracingObservationHandler<span style="color:#719e07">&lt;&gt;(</span>tracer<span style="color:#719e07">,</span> propagator<span style="color:#719e07">),</span> <span style="color:#719e07">new</span> DefaultTracingObservationHandler<span style="color:#719e07">(</span>tracer<span style="color:#719e07">)));</span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// ----- DUBBO ----- |
| </span></span></span><span style="display:flex;"><span><span style="color:#586e75"></span> |
| </span></span><span style="display:flex;"><span>ApplicationModel applicationModel <span style="color:#719e07">=</span> ApplicationModel<span style="color:#719e07">.</span>defaultModel<span style="color:#719e07">();</span> |
| </span></span><span style="display:flex;"><span>applicationModel<span style="color:#719e07">.</span>getBeanFactory<span style="color:#719e07">().</span>registerBean<span style="color:#719e07">(</span>observationRegistry<span style="color:#719e07">);</span> |
| </span></span><span style="display:flex;"><span><span style="color:#586e75">// reuse the applicationModel in your system |
| </span></span></span></code></pre></div><p>By using the new consumer and provider Dubbo filters that use Micrometer Observation, after setting up the registry, metrics and traces would be created and spans would be sent to Zipkin upon their closing.</p> |
| <blockquote> |
| <p>IMPORTANT! Staring from Spring Boot 3 the whole Micrometer Tracer, Micrometer Core and Micrometer Observation setup happens out of the box. You don&rsquo;t need to manually set it up.</p> |
| </blockquote> |
| <h2 id="5-customizing-observation-filters">5. Customizing Observation Filters</h2> |
| <p>To customize the tags present in metrics (low cardinality tags) and in spans (low and high cardinality tags) you should create your own versions of <code>DubboServerObservationConvention</code> (server side) and <code>DubboClientObservationConvention</code> (client side) and register them in the <code>ApplicationModel</code>&rsquo;s <code>BeanFactory</code>. To reuse the existing ones check <code>DefaultDubboServerObservationConvention</code> (server side) and <code>DefaultDubboClientObservationConvention</code> (client side).</p> |
| <h2 id="6-sample-setup">6. Sample Setup</h2> |
| <p>Since Micrometer Observation is a new feature in Micrometer 1.10, Spring Boot 2 doesn&rsquo;t have it configured out of the box (SB2 uses Micrometer 1.9). In this <a href="https://github.com/apache/dubbo/tree/3.2/dubbo-demo/dubbo-demo-spring-boot">this demo sample</a> you can see how Micrometer Observation is manually set up together with OpenTelemetry Bridge.</p></description></item><item><title>Docs3-V2: Logging</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/logging/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/logging/</guid><description/></item><item><title>Docs3-V2: Health Information</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/health-information/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/health-information/</guid><description/></item><item><title>Docs3-V2: Kubernetes Probes</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/kubernetes-probes/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/kubernetes-probes/</guid><description/></item><item><title>Docs3-V2: Document case</title><link>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/doc/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://dubbo.apache.org/en/docs3-v2/java-sdk/advanced-features-and-usage/observability/doc/</guid><description/></item></channel></rss> |
