OpenTelemetry

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.

Overview

OpenTelemetry is the merging of OpenCensus and OpenTracing into one 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.
- context api The OpenTelmetry Context implementation.
- metrics api alpha code for the metrics API.
extensions define additional API extensions, which are not part of the core API.
sdk defines the implementation of the OpenTelemetry API.
sdk-extensions define additional SDK extensions, which are not part of the core SDK.
OpenTracing shim defines a bridge layer from OpenTracing to the OpenTelemetry API.
examples on how to use the APIs, SDK, and standard exporters.

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 contribute

Please refer to the contribution guide on how to setup and contribute!

Quick Start

Please refer to the quick start guide on how use the OpenTelemetry API.

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.0.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.0.0")
  implementation('io.opentelemetry:opentelemetry-api')
}

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.1.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.1.0-SNAPSHOT")
  implementation('io.opentelemetry:opentelemetry-api')
}

Libraries will usually only need opentelemetry-api, while applications may want to use opentelemetry-sdk.

Releases

OpenTelemetry Java is under active development. Releases aren't guaranteed to conform to a specific version of the specification. Future releases will not attempt to maintain backwards compatibility with previous releases.

Check out information about the latest release.

This is a current feature status list:

Component	Version
Trace API	v1.0.0
Trace SDK	v1.0.0
Context	v1.0.0
Baggage	v1.0.0
Jaeger Trace Exporter	v1.0.0
Zipkin Trace Exporter	v1.0.0
OTLP Exporter (Spans)	v1.0.0
OTLP Exporter (Metrics)	v1.0.0-alpha
Metrics API	v1.0.0-alpha
Metrics SDK	v1.0.0-alpha
Prometheus Metrics Exporter	v1.0.0-alpha
OpenTracing Bridge	v1.0.0-alpha
OpenCensus Bridge	v1.0.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.

Summary

We plan to merge projects and pave the path for future improvements as a unified community of tracing vendors, users and library authors who wants apps be managed better. We are open to feedback and suggestions from all of you!