OpenTelemetry for Java

Getting Started

If you are looking for an all-in-one, easy-to-install auto-instrumentation javaagent, see opentelemetry-java-instrumentation.

If you are looking for examples on how to use the OpenTelemetry API to write your own manual instrumentation, or how to set up the OpenTelemetry Java SDK, see Manual instrumentation. Fully-functional examples are available from the examples directory.

For a general overview of OpenTelemetry, visit opentelemetry.io.

Would you like to get involved with the project? Read our contributing guide. We welcome contributions!

Contacting us

We hold regular meetings. See details at community page.

We use GitHub Discussions for support or general questions. Feel free to drop us a line.

We are also present in the #otel-java channel in the CNCF slack. Please join us for more informal discussions.

Overview

OpenTelemetry is the merging of OpenCensus and OpenTracing into a single project.

This project contains the following top level components:

• OpenTelemetry API:
  • stable apis including Tracer, Span, SpanContext, and Baggage
  • semantic conventions Generated code for the OpenTelemetry semantic conventions.
  • metrics api alpha code for the metrics API.
  • context api The OpenTelemetry Context implementation.
• extensions define additional API extensions, which are not part of the core API.
• sdk defines the implementation of the OpenTelemetry API.
• sdk-extensions defines additional SDK extensions, which are not part of the core SDK.
• OpenTracing shim defines a bridge layer from OpenTracing to the OpenTelemetry API.
• OpenCensus shim defines a bridge layer from OpenCensus to the OpenTelemetry API.
• examples on how to use the APIs, SDK, and standard exporters.

This project publishes a lot of artifacts. The easiest way to see the most recent stable artifacts is to use the opentelemetry-bom. Unstable artifacts are referenced by the opentelemetry-alpha-bom.

We would love to hear from the larger community: please provide feedback proactively.

Requirements

Unless otherwise noted, all published artifacts support Java 8 or higher. See CONTRIBUTING.md for additional instructions for building this project for development.

Note about extensions

Both API and SDK extensions consist of various additional components which are excluded from the core artifacts to keep them from growing too large.

We still aim to provide the same level of quality and guarantee for them as for the core components. Please don't hesitate to use them if you find them useful.

Project setup and contributing

Please refer to the contribution guide on how to set up for development and contribute!

Published Releases

Published releases are available on maven central. We strongly recommend using our published BOM to keep all dependency versions in sync.

Maven

<project>
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-bom</artifactId>
        <version>1.7.0</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>io.opentelemetry</groupId>
      <artifactId>opentelemetry-api</artifactId>
    </dependency>
  </dependencies>
</project>

Gradle

dependencies {
  implementation platform("io.opentelemetry:opentelemetry-bom:1.7.0")
  implementation('io.opentelemetry:opentelemetry-api')
}

Note that if you want to use any artifacts that have not fully stabilized yet (such as metrics), then you will need to add an entry for the Alpha BOM as well, e.g.

dependencies {
  implementation platform("io.opentelemetry:opentelemetry-bom:1.7.0")
  implementation platform('io.opentelemetry:opentelemetry-bom-alpha:1.7.0-alpha')

  implementation('io.opentelemetry:opentelemetry-api')
  implementation('io.opentelemetry:opentelemetry-api-metrics')
}

Snapshots

Snapshots based out the main branch are available for opentelemetry-api, opentelemetry-sdk and the rest of the artifacts. We strongly recommend using our published BOM to keep all dependency versions in sync.

Maven

<project>
  <repositories>
    <repository>
      <id>oss.sonatype.org-snapshot</id>
      <url>https://oss.sonatype.org/content/repositories/snapshots</url>
    </repository>
  </repositories>
  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>io.opentelemetry</groupId>
        <artifactId>opentelemetry-bom</artifactId>
        <version>1.8.0-SNAPSHOT</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>io.opentelemetry</groupId>
      <artifactId>opentelemetry-api</artifactId>
    </dependency>
  </dependencies>
</project>

Gradle

repositories {
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots' }
}

dependencies {
  implementation platform("io.opentelemetry:opentelemetry-bom:1.8.0-SNAPSHOT")
  implementation('io.opentelemetry:opentelemetry-api')
}

Libraries will usually only need opentelemetry-api, while applications will want to use the opentelemetry-sdk module which contains our standard implementation of the APIs.

Gradle composite builds

For opentelemetry-java developers that need to test the latest source code with another project, composite builds can be used as an alternative to publishToMavenLocal. This requires some setup which is explained here.

Releases

See the VERSIONING.md document for our policies for releases and compatibility guarantees.

Check out information about the latest release.

This is a current feature status list:

Component	Version
Trace API	v1.7.0
Trace SDK	v1.7.0
Context	v1.7.0
Baggage	v1.7.0
Jaeger Trace Exporter	v1.7.0
Zipkin Trace Exporter	v1.7.0
OTLP Exporter (Spans)	v1.7.0
OTLP Exporter (Metrics)	v1.7.0-alpha
Metrics API	v1.7.0-alpha
Metrics SDK	v1.7.0-alpha
Logs SDK	v1.7.0-alpha
Prometheus Metrics Exporter	v1.7.0-alpha
OpenTracing Bridge	v1.7.0-alpha
OpenCensus Bridge	v1.7.0-alpha

See the project milestones for details on upcoming releases. The dates and features described in issues and milestones are estimates, and subject to change.

Contributing

See CONTRIBUTING.md

Approvers (@open-telemetry/java-approvers):

• Armin Ruech, Dynatrace
• Pavol Loffay, Traceable.ai
• Tyler Benson, DataDog
• Giovanni Liva, Dynatrace
• Christian Neumüller, Dynatrace
• Carlos Alberto, LightStep
• Jakub Wach, Splunk
• Jack Berg, New Relic
• Josh Suereth, Google

Find more about the approver role in community repository.

Maintainers (@open-telemetry/java-maintainers):

• Bogdan Drutu, Splunk
• John Watson, Splunk
• Anuraag Agrawal, AWS

Find more about the maintainer role in community repository.

Thanks to all the people who have contributed