OpenTelemetry Java SDK

OpenTelemetry

We hold regular meetings. See details at community page.

Overview

OpenTelemetry is a working name of a combined OpenCensus and OpenTracing project.

This project contains the following top level components:

• api: The OpenTelemetry API.
  • trace: The tracing api. Includes Tracer, Span and SpanContext.
  • correlationcontext: Collection of entries in the form of key-value pairs of data that can be propagated to provide contextual information.
  • context: In-process and inter-process propagation layer.
  • metrics: Metrics layer.
• sdk: The reference implementation complying to the OpenTelemetry API.
• OpenTracing shim: A bridge layer from OpenTelemetry to the OpenTracing API.

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

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.

Snapshots

Snapshots based out the master branch are available for opentelemetry-api, opentelemetry-sdk and the rest of the artifacts:

Maven

  <repositories>
    <repository>
      <id>oss.sonatype.org-snapshot</id>
      <url>https://oss.jfrog.org/artifactory/oss-snapshot-local</url>
    </repository>
  </repositories>

  <dependencies>
    <dependency>
      <groupId>io.opentelemetry</groupId>
      <artifactId>opentelemetry-api</artifactId>
      <version>0.4.0-SNAPSHOT</version>
    </dependency>
  </dependencies>

Gradle

repositories {
	maven { url 'https://oss.jfrog.org/artifactory/oss-snapshot-local' }
}

dependencies {
	compile('io.opentelemetry:opentelemetry-api:0.2.0-SNAPSHOT')
}

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.

The latest version of the libraries were released on March 27th, 2020. See the v0.3.0 alpha release.

This is a current feature status list:

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!

Owners

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

• Pavol Loffay, RedHat
• Tyler Benson, DataDog
• Armin Ruech, Dynatrace
• Giovanni Liva, Dynatrace

Find more about the approver role in community repository.

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

• Bogdan Drutu, Splunk
• Carlos Alberto, LightStep
• John Watson, New Relic

Find more about the maintainer role in community repository.