You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by bu...@apache.org on 2016/04/11 10:19:45 UTC
svn commit: r985360 - in /websites/production/camel/content:
cache/main.pageCache camel-zipkin.html
Author: buildbot
Date: Mon Apr 11 08:19:45 2016
New Revision: 985360
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/camel-zipkin.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/camel-zipkin.html
==============================================================================
--- websites/production/camel/content/camel-zipkin.html (original)
+++ websites/production/camel/content/camel-zipkin.html Mon Apr 11 08:19:45 2016
@@ -85,7 +85,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><p><strong>Available as of Camel 2.18</strong></p><p>The camel-zipkin component is used for tracing and timing incoming and outgoing Camel messages using <a shape="rect" class="external-link" href="http://zipkin.io/" rel="nofollow">zipkin</a>.</p><p>Events (span) are captured for incoming and outgoing messages being sent to/from Camel.</p><p>This means you need to configure which which Camel endpoints that maps to zipkin service names.</p><p>The mapping can be configured using:</p><ul><li>route id - A Camel route id</li><li><span style="line-height: 1.42857;">endpoint url - A Camel endpoint url</span></li></ul><p>For both kinds you can use wildcards and regular expressions to match, which is using the rules from <a shape="rect" href="intercept.html">Intercept</a>.</p><p>To match all Camel messages you can use * in the pattern and configure that to the same service name.</p><p>If no mapping has been configured then Camel will fallback and us
e endpoint uri's as service names. <br clear="none">However its recommended to configure service mappings so you can use human logic names instead of Camel endpoint uris in the names.</p><p>Camel will auto-configure a ScribeSpanCollector if no SpanCollector explicit has been configured, and if the hostname and port to the span collector has been configured as environment variables</p><ul><li>ZIPKIN_COLLECTOR_SERVICE_HOST - The hostname</li><li>ZIPKIN_COLLECTOR_SERVICE_PORT - The port number</li></ul><p>This makes it easy to use camel-zipkin in container platforms where the platform can run your application in a linux container where service configurations are provided as environment variables.</p><h3 id="camel-zipkin-Options">Options</h3><p>You can configure the following options on ZipkinEventNotifier</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Option</th><th colspan="1" rowspan="1" class=
"confluenceTh">Default</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rate</td><td colspan="1" rowspan="1" class="confluenceTd">1.0f</td><td colspan="1" rowspan="1" class="confluenceTd">Configures a rate that decides how many events should be traced by zipkin.<br clear="none">The rate is expressed as a percentage (1.0f = 100%, 0.5f is 50%, 0.1f is 10%).</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">spanCollector</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Mandatory:</strong> The collector to use for sending zipkin span events to the zipkin server.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">serviceName</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">To use a global service name that matches all Camel events</td></tr><tr><td colspan
="1" rowspan="1" class="confluenceTd">clientServiceMappings</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the <strong>client</strong> service mappings that matches Camel events to the given zipkin service name.<br clear="none">The content is a Map<String, String> where the key is a pattern and the value is the service name.<br clear="none">The pattern uses the rules from <a shape="rect" href="intercept.html">Intercept</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">serverServiceMappings</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><span>Sets the <strong>server</strong> service mappings that matches Camel events to the given zipkin service name.</span><br clear="none"><span>The content is a Map<String, String> where the key is a pattern and the value is the service name.</span><br clear="none"><span>The patte
rn uses the rules from </span><a shape="rect" href="intercept.html">Intercept</a><span>.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">excludePatterns</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets exclude pattern(s) that will disable tracing with zipkin for Camel messages that matches the pattern.<br clear="none">The content is a Set<String> where the key is a pattern. The pattern uses the rules from <a shape="rect" href="intercept.html">Intercept</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">includeMessageBody</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd">Whether to include the Camel message body in the zipkin traces.<br clear="none">This is not recommended for production usage, or when having big payloads. You can limit the size by configuring the <a shape="rect" href="how-do-i-set-the-max
-chars-when-debug-logging-messages-in-camel.html">max debug log size</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">includeMessageBodyStreams</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether to include message bodies that are stream based in the zipkin traces.<br clear="none">This requires enabling <a shape="rect" rel="nofollow"></a><a shape="rect" rel="nofollow">stream</a><a shape="rect" href="stream-caching.html"> caching</a> on the routes or globally on the CamelContext.<br clear="none"><span>This is not recommended for production usage, or when having big payloads. You can limit the size by configuring the </span><a shape="rect" href="how-do-i-set-the-max-chars-when-debug-logging-messages-in-camel.html">max debug log size</a><span>. </span> </p></td></tr></tbody></table></div><h3 id="camel-zipkin-Example">Example</h3><p>To enable camel-zipkin you need to configure first<
/p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
+<div class="wiki-content maincontent"><p><strong>Available as of Camel 2.18</strong></p><p>The camel-zipkin component is used for tracing and timing incoming and outgoing Camel messages using <a shape="rect" class="external-link" href="http://zipkin.io/" rel="nofollow">zipkin</a>.</p><p>Events (span) are captured for incoming and outgoing messages being sent to/from Camel.</p><p>This means you need to configure which which Camel endpoints that maps to zipkin service names.</p><p>The mapping can be configured using:</p><ul><li>route id - A Camel route id</li><li><span style="line-height: 1.42857;">endpoint url - A Camel endpoint url</span></li></ul><p>For both kinds you can use wildcards and regular expressions to match, which is using the rules from <a shape="rect" href="intercept.html">Intercept</a>.</p><p>To match all Camel messages you can use * in the pattern and configure that to the same service name.</p><p>If no mapping has been configured then Camel will fallback and us
e endpoint uri's as service names. <br clear="none">However its recommended to configure service mappings so you can use human logic names instead of Camel endpoint uris in the names.</p><p>Camel will auto-configure a ScribeSpanCollector if no SpanCollector explicit has been configured, and if the hostname and port to the span collector has been configured as environment variables:</p><ul><li>ZIPKIN_COLLECTOR_THRIFT_SERVICE_HOST - The hostname</li><li>ZIPKIN_COLLECTOR_THRIFT_SERVICE_PORT - The port number</li></ul><p>This makes it easy to use camel-zipkin in container platforms where the platform can run your application in a linux container where service configurations are provided as environment variables.</p><h3 id="camel-zipkin-Options">Options</h3><p>You can configure the following options on ZipkinEventNotifier</p><div class="table-wrap"><table class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1" class="confluenceTh">Option</th><th colspan="1" row
span="1" class="confluenceTh">Default</th><th colspan="1" rowspan="1" class="confluenceTh">Description</th></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">rate</td><td colspan="1" rowspan="1" class="confluenceTd">1.0f</td><td colspan="1" rowspan="1" class="confluenceTd">Configures a rate that decides how many events should be traced by zipkin.<br clear="none">The rate is expressed as a percentage (1.0f = 100%, 0.5f is 50%, 0.1f is 10%).</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">spanCollector</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><strong>Mandatory:</strong> The collector to use for sending zipkin span events to the zipkin server.</td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">serviceName</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd">To use a global service name that matches all Camel events</td></tr>
<tr><td colspan="1" rowspan="1" class="confluenceTd">clientServiceMappings</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets the <strong>client</strong> service mappings that matches Camel events to the given zipkin service name.<br clear="none">The content is a Map<String, String> where the key is a pattern and the value is the service name.<br clear="none">The pattern uses the rules from <a shape="rect" href="intercept.html">Intercept</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">serverServiceMappings</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><span>Sets the <strong>server</strong> service mappings that matches Camel events to the given zipkin service name.</span><br clear="none"><span>The content is a Map<String, String> where the key is a pattern and the value is the service name.</span><br clear="none">
<span>The pattern uses the rules from </span><a shape="rect" href="intercept.html">Intercept</a><span>.</span></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">excludePatterns</td><td colspan="1" rowspan="1" class="confluenceTd"> </td><td colspan="1" rowspan="1" class="confluenceTd"><p>Sets exclude pattern(s) that will disable tracing with zipkin for Camel messages that matches the pattern.<br clear="none">The content is a Set<String> where the key is a pattern. The pattern uses the rules from <a shape="rect" href="intercept.html">Intercept</a>.</p></td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">includeMessageBody</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd">Whether to include the Camel message body in the zipkin traces.<br clear="none">This is not recommended for production usage, or when having big payloads. You can limit the size by configuring the <a shape="rect" href="how-d
o-i-set-the-max-chars-when-debug-logging-messages-in-camel.html">max debug log size</a>. </td></tr><tr><td colspan="1" rowspan="1" class="confluenceTd">includeMessageBodyStreams</td><td colspan="1" rowspan="1" class="confluenceTd">false</td><td colspan="1" rowspan="1" class="confluenceTd"><p>Whether to include message bodies that are stream based in the zipkin traces.<br clear="none">This requires enabling <a shape="rect" rel="nofollow"></a><a shape="rect" rel="nofollow">stream</a><a shape="rect" href="stream-caching.html"> caching</a> on the routes or globally on the CamelContext.<br clear="none"><span>This is not recommended for production usage, or when having big payloads. You can limit the size by configuring the </span><a shape="rect" href="how-do-i-set-the-max-chars-when-debug-logging-messages-in-camel.html">max debug log size</a><span>. </span> </p></td></tr></tbody></table></div><h3 id="camel-zipkin-Example">Example</h3><p>To enable camel-zipkin you need to c
onfigure first</p><div class="code panel pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="brush: java; gutter: false; theme: Default" type="syntaxhighlighter"><![CDATA[ZipkinTracer zipkin = new ZipkinTracer();
// configure the scribe span collector with the hostname and port for the Zipkin Collector Server
zipkin.setSpanCollector(new ScribeSpanCollector("192.168.90.100", 9410);