Skip to content

README.md

Latest commit

 

History

History
73 lines (55 loc) · 2.84 KB

README.md

File metadata and controls

73 lines (55 loc) · 2.84 KB

sentry-opentelemetry

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

OpenTelemetry

More information on OpenTelemetry can be found on their website as well as their docs and GitHub repos:

Modules

sentry-opentelemetry-agent

Produces the Sentry OpenTelemetry Java Agent JAR that can be used to auto instrument an application. Please see the module README for more details on how to use it.

sentry-opentelemetry-agentcustomization

This contains customizations to the OpenTelemetry Java Agent such as registering the SentrySpanProcessor and SentryPropagator as well as providing default properties that enable the sentry propagator. This can also be used without the agent.

sentry-opentelemetry-bootstrap

Classes that are loaded into the bootstrap classloader (represented as null when invoking X.class.classLoader) These are shared between the agent and the application and include things like storage, utils, factory, tokens etc.

If you want to use Sentry with OpenTelemetry without the agent, you also need this module as a dependency.

sentry-opentelemetry-core

Contains SentrySpanProcessor and SentryPropagator which are used by our Java Agent but can also be used when manually instrumenting using OpenTelemetry. If you want to use OpenTelemetry without the agent but still want some configuration convenience, you should rather use the sentry-opentelemetry-agentcustomization module.

Running without an Agent

If you want to use Sentry with OpenTelemetry without an agent, you can do so by adding the sentry-opentelemetry-agentcustomization and sentryopentelemetry-bootstrap modules as dependencies to your project.

You can then initialize Sentry with OpenTelemetry like this:

// Initialize OpenTelemetry by using the AutoConfiguredOpenTelemetrySdk which automatically
// registers the `SentrySpanProcessor` and `SentryPropagator` and others.
// Additionally, you can disable the OTEL exporters to avoid seeing error messages in the logs.
final OpenTelemetrySdk sdk = AutoConfiguredOpenTelemetrySdk.builder()
  .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().getOpenTelemetrySdk();

// Set the global OpenTelemetry instance
GlobalOpenTelemetry.set(sdk);

// Initialize Sentry
Sentry.init(
    options -> {
    options.setDsn("...");
      ...
  }
)