Chapter 59. OpenTelemetry

59.1. What’s inside
复制链接

OpenTelemetry

Please refer to the above link for usage and configuration details.

59.3. Usage
复制链接

The extension automatically creates a Camel OpenTelemetryTracer 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.

Identifier for the origin of spans created by the application
For OTLP
For Jaeger

# Identifier for the origin of spans created by the application
quarkus.application.name=my-camel-application

# For OTLP
quarkus.opentelemetry.tracer.exporter.otlp.endpoint=http://localhost:4317

# For Jaeger
quarkus.opentelemetry.tracer.exporter.jaeger.endpoint=http://localhost:14250

Copy to Clipboard

Toggle word wrap

Note that you must add a dependency to the OpenTelemetry exporter that you want to work with.

At present, Quarkus has support for Jaeger and the OpenTelemetry Protocol Specification (OTLP).

For Jaeger:

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-opentelemetry-exporter-jaeger</artifactId>
</dependency>

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-opentelemetry-exporter-jaeger</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

For OTLP:

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-opentelemetry-exporter-otlp</artifactId>
</dependency>

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-opentelemetry-exporter-otlp</artifactId>
</dependency>

Copy to Clipboard

Toggle word wrap

Refer to the Quarkus OpenTelemetry guide for a full list of configuration options.

Route endpoints can be excluded from tracing by configuring a property named quarkus.camel.opentelemetry.exclude-patterns in application.properties. For example:

Exclude all direct & netty-http endpoints from tracing

# Exclude all direct & netty-http endpoints from tracing
quarkus.camel.opentelemetry.exclude-patterns=direct:*,netty-http:*

Copy to Clipboard

Toggle word wrap

59.3.1. Tracing CDI bean method execution
复制链接

When instrumenting the execution of CDI bean methods from Camel routes, you should annotate such methods with io.opentelemetry.extension.annotations.WithSpan. Methods annotated with @WithSpan will create a new Span and establish any required relationships with the current Trace context.

For example, to instrument a CDI bean from a Camel route, first ensure the appropriate methods are annotated with @WithTrace.

@ApplicationScoped
@Named("myBean")
public class MyBean {
    @WithSpan
    public String greet() {
        return "Hello World!";
    }
}

@ApplicationScoped
@Named("myBean")
public class MyBean {
    @WithSpan
    public String greet() {
        return "Hello World!";
    }
}

Copy to Clipboard

Toggle word wrap

Next, use the bean in your Camel route.

Important

To ensure that the sequence of recorded spans is correct, you must use the full to("bean:") endpoint URI and not the shortened .bean() EIP DSL method.

public class MyRoutes extends RouteBuilder {
    @Override
    public void configure() throws Exception {
        from("direct:executeBean")
                .to("bean:myBean?method=greet");
    }
}

public class MyRoutes extends RouteBuilder {
    @Override
    public void configure() throws Exception {
        from("direct:executeBean")
                .to("bean:myBean?method=greet");
    }
}

Copy to Clipboard

Toggle word wrap

There is more information about CDI instrumentation in the Quarkus OpenTelemetry guide.

59.4. Additional Camel Quarkus configuration
复制链接

Expand

Configuration property Type Default

Configuration property	Type	Default
`quarkus.camel.opentelemetry.encoding` Sets whether header names need to be encoded. Can be useful in situations where OpenTelemetry propagators potentially set header name values in formats that are not compatible with the target system. E.g for JMS where the specification mandates header names are valid Java identifiers.	`boolean`	`false`
`quarkus.camel.opentelemetry.exclude-patterns` Sets whether to disable tracing for endpoint URIs that match the given patterns. The pattern can take the following forms: 1. An exact match on the endpoint URI. E.g platform-http:/some/path 2. A wildcard match. E.g platform-http:* 3. A regular expression matching the endpoint URI. E.g platform-http:/prefix/.*	`string`

lock quarkus.camel.opentelemetry.encoding

Sets whether header names need to be encoded. Can be useful in situations where OpenTelemetry propagators potentially set header name values in formats that are not compatible with the target system. E.g for JMS where the specification mandates header names are valid Java identifiers.

boolean

false

lock quarkus.camel.opentelemetry.exclude-patterns

Sets whether to disable tracing for endpoint URIs that match the given patterns. The pattern can take the following forms:

1. An exact match on the endpoint URI. E.g platform-http:/some/path

2. A wildcard match. E.g platform-http:*

3. A regular expression matching the endpoint URI. E.g platform-http:/prefix/.*

string

lock Configuration property fixed at build time. All other configuration properties are overridable at runtime.

59.1. What’s inside
复制链接

59.2. Maven coordinates
复制链接

59.3. Usage
复制链接

59.3.1. Tracing CDI bean method execution
复制链接

59.4. Additional Camel Quarkus configuration
复制链接

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

Chapter 59. OpenTelemetry

59.1. What’s inside复制链接链接已复制到粘贴板!

59.2. Maven coordinates复制链接链接已复制到粘贴板!

59.3. Usage复制链接链接已复制到粘贴板!

59.3.1. Tracing CDI bean method execution复制链接链接已复制到粘贴板!

59.4. Additional Camel Quarkus configuration复制链接链接已复制到粘贴板!

学习

尝试、购买和销售

社区

关于红帽文档

让开源更具包容性

關於紅帽

Theme

Red Hat legal and privacy links

Red Hat legal and privacy links

59.1. What’s inside
复制链接

59.2. Maven coordinates
复制链接

59.3. Usage
复制链接

59.3.1. Tracing CDI bean method execution
复制链接

59.4. Additional Camel Quarkus configuration
复制链接