OpenTelemetry Support

You can download the latest version of the sentry-opentelemetry-agent-{{ packages.version('sentry.java.opentelemetry-agent') }}.jar from MavenCentral. It's also available as a ZIP containing the JAR used on this page on GitHub.

This java command shows how to run your application using sentry-opentelemetry-agent:

SENTRY_PROPERTIES_FILE=sentry.properties java -javaagent:sentry-opentelemetry-agent-{{ packages.version('sentry.java.opentelemetry-agent') }}.jar -jar your-application.jar

Here's the sentry.properties file that goes with it:

dsn=https://examplePublicKey@o0.ingest.sentry.io/0
traces-sample-rate=1.0

To enable debug logging in Sentry, set SENTRY_DEBUG=true as an environment variable or add debug=true to your sentry.properties.

To show debug output for OpenTelemetry, add -Dotel.javaagent.debug=true to the java command.

If you're using sentry-opentelemetry-agent but don't need to use OpenTelemetry exporters, add the following environment variables to turn off exporters and stop receiving error messages about servers not being reachable in the logs.

Example log message:

ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export spans. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317
ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export metrics. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317

Traces

To turn off traces exporting, set OTEL_TRACES_EXPORTER=none as an environment variable per OpenTelemetry GitHub.

Metrics

To turn off metrics exporting, set OTEL_METRICS_EXPORTER=none as an environment variable per OpenTelemetry GitHub.

You can download the latest version of the sentry-opentelemetry-agent-{{ packages.version('sentry.java.opentelemetry-agent') }}.jar from MavenCentral. It's also available as a ZIP containing the JAR used on this page on GitHub.

To ensure errors are properly linked to transactions that were created by the OpenTelemetry integration, you need an additional dependency:

implementation 'io.sentry:sentry-opentelemetry-core:{{ packages.version('sentry.java.opentelemetry-core', '6.9.2') }}'

If you're not using the auto initialization provided by sentry-opentelemetry-agent (SENTRY_AUTO_INIT=false), you have to set the instrumenter option to otel. This disables all Sentry instrumentation and uses the chosen OpenTelemetry tracers for creating spans instead. To ensure errors are properly linked to transactions that were created by the OpenTelemetry integration, add the OpenTelemetryLinkErrorEventProcessor:

import io.sentry.Instrumenter;
import io.sentry.Sentry;
import io.sentry.opentelemetry.OpenTelemetryLinkErrorEventProcessor;

Sentry.init(options -> {
  options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
  options.setTracesSampleRate(1.0);
  options.setInstrumenter(Instrumenter.OTEL);
  options.addEventProcessor(new OpenTelemetryLinkErrorEventProcessor());
});

To enable debug logging in Sentry, set SENTRY_DEBUG=true as an environment variable or add debug=true to your sentry.properties.

To show debug output for OpenTelemetry, add -Dotel.javaagent.debug=true to the java command.

If you're using sentry-opentelemetry-agent but don't need to use OpenTelemetry exporters, add the following environment variables to turn off exporters and stop receiving error messages about servers not being reachable in the logs.

Example log message:

ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export spans. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317
ERROR io.opentelemetry.exporter.internal.grpc.OkHttpGrpcExporter - Failed to export metrics. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4317

Traces

To turn off traces exporting, set OTEL_TRACES_EXPORTER=none as an environment variable per OpenTelemetry GitHub.

Metrics

To turn off metrics exporting, set OTEL_METRICS_EXPORTER=none as an environment variable per OpenTelemetry GitHub.

In addition to OpenTelemetry dependencies and your typical Sentry dependencies, you will need to add sentry-opentelemetry-core as a dependency:

implementation 'io.sentry:sentry-opentelemetry-core:{{ packages.version('sentry.java.opentelemetry-core', '6.9.2') }}'

Initializing OpenTelemetry

When manually initializing OpenTelemetry you have to add SentrySpanProcessor and SentryPropagator to your configuration.

import io.opentelemetry.api.OpenTelemetry;
import io.opentelemetry.context.propagation.ContextPropagators;
import io.opentelemetry.sdk.OpenTelemetrySdk;
import io.opentelemetry.sdk.trace.SdkTracerProvider;

import io.sentry.opentelemetry.SentryPropagator;
import io.sentry.opentelemetry.SentrySpanProcessor;


SdkTracerProvider sdkTracerProvider = SdkTracerProvider.builder()
    .addSpanProcessor(new SentrySpanProcessor())
    .build();

OpenTelemetry openTelemetry = OpenTelemetrySdk.builder()
    .setTracerProvider(sdkTracerProvider)
    .setPropagators(ContextPropagators.create(new SentryPropagator()))
    .buildAndRegisterGlobal();

Initializing Sentry

You have to set the instrumenter option to otel. This disables all Sentry instrumentation and uses the chosen OpenTelemetry tracers for creating spans.

To ensure errors are properly linked to transactions that were created by the OpenTelemetry integration, add the OpenTelemetryLinkErrorEventProcessor:

import io.sentry.Instrumenter;
import io.sentry.Sentry;
import io.sentry.opentelemetry.OpenTelemetryLinkErrorEventProcessor;

Sentry.init(options -> {
  options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
  options.setTracesSampleRate(1.0);
  options.setInstrumenter(Instrumenter.OTEL);
  options.addEventProcessor(new OpenTelemetryLinkErrorEventProcessor());
});