opentelemetry-java

OpenTelemetry Java

[![Coverage Status][codecov-image]][codecov-url] opentelemetry-java is the home of the Java implementation of the OpenTelemetry API for recording telemetry, and SDK for managing telemetry recorded by the API.

See opentelemetry.io Java Documentation for:

• An overview of the OpenTelemetry Java ecosystem and key repositories
• Detailed documentation on the components published from this repository
• Review of instrumentation ecosystem, including OpenTelemetry Java agent
• End-to-end working code examples
• And more

[!IMPORTANT] We are currently seeking additional contributors! See help wanted for details.

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 for details on building this project locally.

Releases

Releases are published to maven central. We publish minor releases monthly and patch releases as needed.

See releases for a listing of released versions and notes (see also changelog).

Artifacts

The artifacts published by this repository are summarized below in tables, organized in collapsible sections by topic.

As discussed in compatibility, artifact versions must be kept in sync, for which we strongly recommend [using one of our BOMs][dependencies-and-boms].

Bill of Materials (BOMs)

A bill of materials (or BOM) helps sync dependency versions of related artifacts.

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

API

The OpenTelemetry API for recording telemetry.

Component	Description	Artifact ID	Version	Javadoc
API	OpenTelemetry API, including metrics, traces, baggage, context	opentelemetry-api	1.66.0
API Incubator	API incubator, including pass through propagator, and extended tracer, and Event API	opentelemetry-api-incubator	1.66.0-alpha
Context API	OpenTelemetry context API	opentelemetry-context	1.66.0
Common	Common utility methods used across API components	opentelemetry-common	1.66.0

API Extensions

Extensions to the OpenTelemetry API.

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

SDK

The OpenTelemetry SDK for managing telemetry producing by the API.

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

SDK Exporters

SDK exporters for shipping traces, metrics, and logs out of process.

Component	Description	Artifact ID	Version	Javadoc
OTLP Exporters	OTLP gRPC & HTTP exporters, including traces, metrics, and logs	opentelemetry-exporter-otlp	1.66.0
OTLP Profiles Exporter	OTLP profiles exporter	opentelemetry-exporter-otlp-profiles	1.66.0-alpha
OTLP Logging Exporters	Logging exporters in OTLP JSON encoding, including traces, metrics, and logs	opentelemetry-exporter-logging-otlp	1.66.0
OTLP Common	Shared OTLP components (internal)	opentelemetry-exporter-otlp-common	1.66.0
Logging Exporter	Logging exporters, including metrics, traces, and logs	opentelemetry-exporter-logging	1.66.0
Prometheus Exporter	Prometheus metric exporter	opentelemetry-exporter-prometheus	1.66.0-alpha	[](https://www.javadoc.io/doc/io.opentelemetry/opentelemetry-exporter-p