OpenTelemetry Support
Using OpenTelemetry with Sentry Performance.
There are multiple ways to configure your OpenTelemetry SDK and send traces and spans to Sentry. They're described below.
If you use sentry-opentelemetry-agent, it will look for SENTRY_DSN and SENTRY_PROPERTIES_FILE environment variables to be defined, and then initialize Sentry automatically. You'll just need to configure your DSN and tracesSampleRate.
You can download the latest version of the sentry-opentelemetry-agent-7.19.0.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-7.19.0.jar -jar your-application.jar
Here's the sentry.properties file that goes with it:
sentry.propertiesdsn=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 not using any OpenTelemetry exporters besides Sentry, 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
ERROR io.opentelemetry.exporter.internal.http.HttpExporter - Failed to export logs. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4318
To turn off traces exporting, set OTEL_TRACES_EXPORTER=none as an environment variable per OpenTelemetry GitHub.
To turn off metrics exporting, set OTEL_METRICS_EXPORTER=none as an environment variable per OpenTelemetry GitHub.
To turn off log exporting, set OTEL_LOGS_EXPORTER=none as an environment variable per OpenTelemetry GitHub.
You may also disable automatic initialization of Sentry in sentry-opentelemetry-agent by setting SENTRY_AUTO_INIT=false as an environment variable. Doing this will mean you'll either have to use another Sentry integration that performs initialization, (for example Spring Boot), or initialize Sentry manually.
You can download the latest version of the sentry-opentelemetry-agent-7.19.0.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_AUTO_INIT=false java -javaagent:sentry-opentelemetry-agent-7.19.0.jar -jar your-application.jar
You can combine this with a Sentry integration, that performs the initialization for you or call Sentry.init manually:
import io.sentry.Sentry;
Sentry.init(options -> {
options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
options.setTracesSampleRate(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 not using any OpenTelemetry exporters besides Sentry, 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
ERROR io.opentelemetry.exporter.internal.http.HttpExporter - Failed to export logs. The request could not be executed. Full error message: Failed to connect to localhost/[0:0:0:0:0:0:0:1]:4318
To turn off traces exporting, set OTEL_TRACES_EXPORTER=none as an environment variable per OpenTelemetry GitHub.
To turn off metrics exporting, set OTEL_METRICS_EXPORTER=none as an environment variable per OpenTelemetry GitHub.
To turn off log exporting, set OTEL_LOGS_EXPORTER=none as an environment variable per OpenTelemetry GitHub.
If the Java Agent approach isn't for you, you can manually initialize OpenTelemetry. We have a separate dependency for this use case.
In addition to your typical Sentry dependencies, you will need to add sentry-opentelemetry-agentless as a dependency:
implementation 'io.sentry:sentry-opentelemetry-agentless:8.0.0'
Please note, if you're using Spring Boot, there's a separate sentry-opentelemetry-agentless-spring dependency. You can find out more here.
You'll have to configure both OpenTelemetry and Sentry to see transactions in Sentry and have errors linked to transactions created by OpenTelemetry.
Our sentry-opentelemetry-agentless dependency also adds opentelemetry-sdk-extension-autoconfigure which takes care of configuring OpenTelemetry to work with Sentry. There's two ways to trigger it.
- Using a property on startup
Add -Dotel.java.global-autoconfigure.enabled=true to the java command when starting your application.
- Using
AutoConfiguredOpenTelemetrySdk
import io.opentelemetry.sdk.autoconfigure.AutoConfiguredOpenTelemetrySdk;
AutoConfiguredOpenTelemetrySdk.builder()
.setResultAsGlobal()
.addPropertiesSupplier(() -> {
final Map<String, String> properties = new HashMap<>();
properties.put("otel.logs.exporter", "none");
properties.put("otel.metrics.exporter", "none");
properties.put("otel.traces.exporter", "none");
return properties;
})
.build();
You can initialize Sentry as usual, e.g. by calling Sentry.init:
import io.sentry.Sentry;
Sentry.init(options -> {
options.setDsn("https://examplePublicKey@o0.ingest.sentry.io/0");
options.setTracesSampleRate(1.0);
});
With Sentry’s OpenTelemetry SDK, an OpenTelemetry Span becomes a Sentry Transaction or Span. The first Span sent through the Sentry SpanProcessor is a Transaction, and any child Span gets attached to the first Transaction upon checking the parent Span context. This is true for the OpenTelemetry root Span and any top level Span in the system. For example, a request sent from frontend to backend will create an OpenTelemetry root Span with a corresponding Sentry Transaction. The backend request will create a new Sentry Transaction for the OpenTelemetry Span. The Sentry Transaction and Span are linked as a trace for navigation and error tracking purposes.
If you need more fine grained control over Sentry, take a look at the Configuration page. In case you'd like to filter out transactions before sending them to Sentry (to get rid of health checks, for example), you may find the Filtering page helpful.
Our documentation is open source and available on GitHub. Your contributions are welcome, whether fixing a typo (drat!) or suggesting an update ("yeah, this would be better").