Skip to content

Latest commit

 

History

History
75 lines (53 loc) · 3.25 KB

README.md

File metadata and controls

75 lines (53 loc) · 3.25 KB
Raw

sentry-opentelemetry-agent

NOTE: Our OpenTelemetry modules are still experimental. Any feedback is welcome.

How to use it

Download the latest sentry-opentelemetry-agent.jar and use it when launching your Java application by adding the following parameters to your java command:

$ SENTRY_PROPERTIES_FILE=sentry.properties java -javaagent:sentry-opentelemetry-agent.jar -jar your-application.jar

Your sentry.properties could look like this:

# NOTE: Replace the test DSN below with YOUR OWN DSN to see the events from this app in your Sentry project/dashboard
dsn=https://[email protected]/5428563
traces-sample-rate=1.0

For more details on configuring Sentry via sentry.properties please see the docs page.

As an alternative to the SENTRY_PROPERTIES_FILE environment variable you can provide individual settings as environment variables (e.g. SENTRY_DSN=...) or you may initialize Sentry inside your target application. If you do so, please make sure to set the instrumenter to otel, e.g. like this:

Sentry.init(
        options -> {
          options.setDsn("...");
          ...
          options.setInstrumenter(Instrumenter.OTEL);
        }
)

Using the otel instrumenter will ensure Sentry instrumentation will be done via OpenTelemetry and integrations as well as direct interactions with transactions and spans have no effect.

Controlling auto initialization of Sentry

By default if you pass either SENTRY_DSN or SENTRY_PROPERTIES_FILE as environment variable, Sentry will automatically be initialized by this agent. To disable this behaviour, you can set SENTRY_AUTO_INIT=false as environment variable. You will then have to initialize Sentry inside the target application.

Debugging

To enable debug logging for Sentry, please provide SENTRY_DEBUG=true as environment variable or add debug=true to your sentry.properties.

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

Getting rid of exporter error messages

In case you are using this agent without needing to use any OpenTelemetry exporters you can add the following environment variables to turn off exporters and stop seeing 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 exporting of traces you can set OTEL_TRACES_EXPORTER=none see OpenTelemetry GitHub

Metrics

To turn off exporting of metrics you can set OTEL_METRICS_EXPORTER=none see OpenTelemetry GitHub