Quarkus instrumentation

Quarkus is an open source framework designed to help software developers build efficient cloud native applications both with JVM and Quarkus native image applications.

Quarkus uses extensions to provide optimized support for a wide range of libraries. The Quarkus OpenTelemetry extension provides:

• Out of the box instrumentation
• OpenTelemetry SDK autoconfiguration, supporting almost all system properties defined for the OpenTelemetry SDK
• Vert.x based OTLP exporter
• The same instrumentations can be used with native image applications, which are not supported by the OpenTelemetry Java agent.

Quarkus can also be instrumented with the OpenTelemetry Java agent if you are not running a native image application.

Getting started

To enable OpenTelemetry in your Quarkus application, add the quarkus-opentelemetry extension dependency to your project.

• Maven (pom.xml)
• Gradle (build.gradle)

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

implementation("io.quarkus:quarkus-opentelemetry")

Only the tracing signal is enabled by default. To enable metrics and logs, add the following configuration to your application.properties file:

quarkus.otel.metrics.enabled=true
quarkus.otel.logs.enabled=true

OpenTelemetry logging is supported by Quarkus 3.16.0+.

For details concerning these and other configuration options, see OpenTelemetry configuration reference.

Learn more

• Using OpenTelemetry, a general reference covering all configuration options
• Signal-specific guides for
  • Tracing
  • Metrics
  • Logs