| // Do not edit directly! |
| // This file was generated by camel-quarkus-maven-plugin:update-extension-doc-page |
| = OpenTracing |
| :page-aliases: extensions/opentracing.adoc |
| :linkattrs: |
| :cq-artifact-id: camel-quarkus-opentracing |
| :cq-native-supported: true |
| :cq-status: Stable |
| :cq-status-deprecation: Stable Deprecated |
| :cq-description: Distributed tracing using OpenTracing |
| :cq-deprecated: true |
| :cq-jvm-since: 0.3.0 |
| :cq-native-since: 0.3.0 |
| |
| [.badges] |
| [.badge-key]##JVM since##[.badge-supported]##0.3.0## [.badge-key]##Native since##[.badge-supported]##0.3.0## [.badge-key]##⚠️##[.badge-unsupported]##Deprecated## |
| |
| Distributed tracing using OpenTracing |
| |
| == What's inside |
| |
| * xref:{cq-camel-components}:others:opentracing.adoc[OpenTracing] |
| |
| Please refer to the above link for usage and configuration details. |
| |
| == Maven coordinates |
| |
| https://code.quarkus.io/?extension-search=camel-quarkus-opentracing[Create a new project with this extension on code.quarkus.io, window="_blank"] |
| |
| Or add the coordinates to your existing project: |
| |
| [source,xml] |
| ---- |
| <dependency> |
| <groupId>org.apache.camel.quarkus</groupId> |
| <artifactId>camel-quarkus-opentracing</artifactId> |
| </dependency> |
| ---- |
| |
| Check the xref:user-guide/index.adoc[User guide] for more information about writing Camel Quarkus applications. |
| |
| == Usage |
| |
| The extension automatically creates a Camel `OpenTracingTracer` and binds it to the Camel registry. |
| |
| In order to send the captured traces to a tracing system, you need to configure some properties within `application.properties` like those below. |
| |
| [source,properties] |
| ---- |
| quarkus.jaeger.service-name=my-service |
| quarkus.jaeger.sampler-type=const |
| quarkus.jaeger.sampler-param=1 |
| quarkus.jaeger.endpoint=http://localhost:14268/api/traces |
| ---- |
| |
| Refer to the https://quarkus.io/guides/opentracing-guide#configuration-reference[Quarkus OpenTracing guide] for a full list of configuration options. |
| |
| Route endpoints can be excluded from tracing by configuring a property named `quarkus.camel.opentracing.exclude-patterns` in `application.properties`. For example: |
| |
| [source,properties] |
| ---- |
| # Exclude all direct & netty-http endpoints from tracing |
| quarkus.camel.opentracing.exclude-patterns=direct:*,netty-http:* |
| ---- |
| |
| |
| == Additional Camel Quarkus configuration |
| |
| [width="100%",cols="80,5,15",options="header"] |
| |=== |
| | Configuration property | Type | Default |
| |
| |
| |icon:lock[title=Fixed at build time] [[quarkus.camel.opentracing.encoding]]`link:#quarkus.camel.opentracing.encoding[quarkus.camel.opentracing.encoding]` |
| |
| Sets whether header keys need to be encoded |
| | `boolean` |
| | `false` |
| |
| |icon:lock[title=Fixed at build time] [[quarkus.camel.opentracing.exclude-patterns]]`link:#quarkus.camel.opentracing.exclude-patterns[quarkus.camel.opentracing.exclude-patterns]` |
| |
| Sets whether to disable tracing for endpoint URIs that match the given patterns |
| | `string` |
| | |
| |=== |
| |
| [.configuration-legend] |
| icon:lock[title=Fixed at build time] Configuration property fixed at build time. All other configuration properties are overridable at runtime. |
| |