Skip to content

Latest commit

 

History

History
345 lines (259 loc) · 28.8 KB

README.md

File metadata and controls

345 lines (259 loc) · 28.8 KB

OpenTelemetry Java

Continuous Build Coverage Status Maven Central

Project Status

See Java status on OpenTelemetry.io.

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 in opentelemetry-java-examples.

If you are looking for generated classes for the OpenTelemetry semantic conventions, see semantic-conventions-java.

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.

To report a bug, or request a new feature, please open an issue.

Overview

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

This project contains the following top level components:

  • OpenTelemetry API:
  • extensions define additional API extensions not part of the core API, including propagators.
  • sdk defines the implementation of the OpenTelemetry API.
  • exporters trace, metric, and log exporters for the SDK.
  • 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.

This project publishes a lot of artifacts, listed in releases. opentelemetry-bom (BOM = Bill of Materials) is provided to assist with synchronizing versions of dependencies. opentelemetry-bom-alpha provides the same function for unstable artifacts. See published releases for instructions on using the BOMs.

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 language version compatibility for complete details.

Android Disclaimer: For compatibility reasons, library desugaring must be enabled.

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

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

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

  implementation('io.opentelemetry:opentelemetry-api')
  implementation('io.opentelemetry:opentelemetry-exporter-prometheus')
  implementation('io.opentelemetry:opentelemetry-sdk-extension-autoconfigure')
}

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.43.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.43.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.

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

The following tables describe the artifacts published by this project. To take a dependency, follow the instructions in Published Released to include the BOM, and specify the dependency as follows, replacing {{artifact-id}} with the value from the "Artifact ID" column:

<dependency>
  <groupId>io.opentelemetry</groupId>
  <artifactId>{{artifact-id}}</artifactId>
</dependency>
  implementation('io.opentelemetry:{{artifact-id}}')

Bill of Material

Component Description Artifact ID Version Javadoc
Bill of Materials (BOM) Bill of materials for stable artifacts opentelemetry-bom 1.42.0 N/A
Alpha Bill of Materials (BOM) Bill of materials for alpha artifacts opentelemetry-bom-alpha 1.42.0-alpha N/A

API

Component Description Artifact ID Version Javadoc
API OpenTelemetry API, including metrics, traces, baggage, context opentelemetry-api 1.42.0 Javadocs
API Incubator API incubator, including pass through propagator, and extended tracer, and Event API opentelemetry-api-incubator 1.42.0 Javadocs
Context API OpenTelemetry context API opentelemetry-context 1.42.0 Javadocs

API Extensions

Component Description Artifact ID Version Javadoc
Kotlin Extension Context extension for coroutines opentelemetry-extension-kotlin 1.42.0 Javadocs
Trace Propagators Extension Trace propagators, including B3, Jaeger, OT Trace opentelemetry-extension-trace-propagators 1.42.0 Javadocs

SDK

Component Description Artifact ID Version Javadoc
SDK OpenTelemetry SDK, including metrics, traces, and logs opentelemetry-sdk 1.42.0 Javadocs
Metrics SDK OpenTelemetry metrics SDK opentelemetry-sdk-metrics 1.42.0 Javadocs
Trace SDK OpenTelemetry trace SDK opentelemetry-sdk-trace 1.42.0 Javadocs
Log SDK OpenTelemetry log SDK opentelemetry-sdk-logs 1.42.0 Javadocs
SDK Common Shared SDK components opentelemetry-sdk-common 1.42.0 Javadocs
SDK Testing Components for testing OpenTelemetry instrumentation opentelemetry-sdk-testing 1.42.0 Javadocs

SDK Exporters

Component Description Artifact ID Version Javadoc
OTLP Exporters OTLP gRPC & HTTP exporters, including traces, metrics, and logs opentelemetry-exporter-otlp 1.42.0 Javadocs
OTLP Logging Exporters Logging exporters in OTLP JSON encoding, including traces, metrics, and logs opentelemetry-exporter-logging-otlp 1.42.0 Javadocs
OTLP Common Shared OTLP components (internal) opentelemetry-exporter-otlp-common 1.42.0 Javadocs
Logging Exporter Logging exporters, including metrics, traces, and logs opentelemetry-exporter-logging 1.42.0 Javadocs
Zipkin Exporter Zipkin trace exporter opentelemetry-exporter-zipkin 1.42.0 Javadocs
Prometheus Exporter Prometheus metric exporter opentelemetry-exporter-prometheus 1.42.0-alpha Javadocs
Exporter Common Shared exporter components (internal) opentelemetry-exporter-common 1.42.0 Javadocs
OkHttp Sender OkHttp implementation of HttpSender (internal) opentelemetry-exporter-sender-okhttp 1.42.0 Javadocs
JDK Sender Java 11+ native HttpClient implementation of HttpSender (internal) opentelemetry-exporter-sender-jdk 1.42.0 Javadocs
gRPC ManagedChannel Sender gRPC ManagedChannel implementation of GrpcSender (internal) opentelemetry-exporter-sender-grpc-managed-channel 1.42.0 Javadocs

SDK Extensions

Component Description Artifact ID Version Javadoc
SDK Autoconfigure Autoconfigure OpenTelemetry SDK from env vars, system properties, and SPI opentelemetry-sdk-extension-autoconfigure 1.42.0 Javadocs
SDK Autoconfigure SPI Service Provider Interface (SPI) definitions for autoconfigure opentelemetry-sdk-extension-autoconfigure-spi 1.42.0 Javadocs
SDK Jaeger Remote Sampler Extension Sampler which obtains sampling configuration from remote Jaeger server opentelemetry-sdk-extension-jaeger-remote-sampler 1.42.0 Javadocs
SDK Incubator SDK incubator, including YAML based view configuration, LeakDetectingSpanProcessor opentelemetry-sdk-extension-incubator 1.42.0-alpha Javadocs

Shims

Component Description Artifact ID Version Javadoc
OpenCensus Shim Bridge opencensus metrics into the OpenTelemetry metrics SDK opentelemetry-opencensus-shim 1.42.0-alpha Javadocs
OpenTracing Shim Bridge opentracing spans into the OpenTelemetry trace API opentelemetry-opentracing-shim 1.42.0 Javadocs

Contributing

See CONTRIBUTING.md

Triagers:

Find more about the triager role in community repository.

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

Find more about the approver role in community repository.

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

Emeritus:

Find more about the maintainer role in community repository.

Thanks to all the people who have contributed

Made with contrib.rocks.