[camel] branch master updated: opentelemetry docs (#4069)

[da...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

davsclaus pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git


The following commit(s) were added to refs/heads/master by this push:
     new 853959d  opentelemetry docs (#4069)
853959d is described below

commit 853959de79c065a79d2544110ef618a485d92876
Author: Ruben Vargas Palma <ru...@gmail.com>
AuthorDate: Wed Aug 5 04:12:18 2020 -0500

    opentelemetry docs (#4069)
    
    Signed-off-by: Ruben <ru...@gmail.com>
---
 .../src/main/docs/opentelemetry.adoc               | 35 ++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/components/camel-opentelemetry/src/main/docs/opentelemetry.adoc b/components/camel-opentelemetry/src/main/docs/opentelemetry.adoc
index 71983d8..30126cf 100644
--- a/components/camel-opentelemetry/src/main/docs/opentelemetry.adoc
+++ b/components/camel-opentelemetry/src/main/docs/opentelemetry.adoc
@@ -14,4 +14,39 @@ outgoing Camel messages using https://opentelemetry.io/[OpenTelemetry].
 Events (spans) are captured for incoming and outgoing messages being sent
 to/from Camel.
 
+== Configuration
+
+The configuration properties for the OpenTelemetry tracer are:
+
+[width="100%",cols="10%,10%,80%",options="header",]
+|=======================================================================
+|Option |Default |Description
+
+|excludePatterns |  | Sets exclude pattern(s) that will disable tracing for Camel
+messages that matches the pattern. The content is a Set<String> where the key is a pattern. The pattern
+uses the rules from Intercept.
+|encoding |false| Sets whether the header keys need to be encoded (connector specific) or not. The value is a boolean.
+Dashes need for instances to be encoded for JMS property keys.
+
+|=======================================================================
+
+
+=== Configuration
+
+Include the `camel-opentelemetry` component in your POM, along with any specific dependencies associated with the
+chosen OpenTelemetry compliant Tracer.
+
+To explicitly configure OpenTelemetry support, instantiate the `OpenTelemetryTracer` and initialize the camel
+context. You can optionally specify a `Tracer`, or alternatively it can be implicitly discovered using the
+`Registry`
+
+[source,java]
+--------------------------------------------------------------------------------------------------
+OpenTelemetryTracer otelTracer = new OpenTelemetryTracer();
+// By default it uses the DefaultTracer, but you can override it with a specific OpenTelemetry Tracer implementation.
+otelTracer.setTracer(...);
+// And then initialize the context
+otelTracer.init(camelContext);
+--------------------------------------------------------------------------------------------------
+
 include::camel-spring-boot::page$opentelemetry-starter.adoc[]