Package io.opentelemetry.api

Interface OpenTelemetry

All Known Implementing Classes:

DefaultOpenTelemetry, GlobalOpenTelemetry.ObfuscatedOpenTelemetry, OpenTelemetrySdk

public interface OpenTelemetry

The entrypoint to telemetry functionality for tracing, metrics and baggage.

If using the OpenTelemetry SDK, you may want to instantiate the OpenTelemetry to provide configuration, for example of Resource or Sampler. See OpenTelemetrySdk and OpenTelemetrySdk.builder for information on how to construct the SDK OpenTelemetry.

See Also:

TracerProvider, ContextPropagators

Method Summary

Modifier and Type	Method	Description
default LoggerProvider	getLogsBridge()	Returns the LoggerProvider for bridging logs into OpenTelemetry.
default Meter	getMeter(java.lang.String instrumentationScopeName)	Gets or creates a named meter instance from the MeterProvider for this OpenTelemetry.
default MeterProvider	getMeterProvider()	Returns the MeterProvider for this OpenTelemetry.
ContextPropagators	getPropagators()	Returns the ContextPropagators for this OpenTelemetry.
default Tracer	getTracer(java.lang.String instrumentationScopeName)	Gets or creates a named tracer instance from the TracerProvider for this OpenTelemetry.
default Tracer	getTracer(java.lang.String instrumentationScopeName, java.lang.String instrumentationScopeVersion)	Gets or creates a named and versioned tracer instance from the TracerProvider in this OpenTelemetry.
TracerProvider	getTracerProvider()	Returns the TracerProvider for this OpenTelemetry.
default MeterBuilder	meterBuilder(java.lang.String instrumentationScopeName)	Creates a MeterBuilder for a named Meter instance.
static OpenTelemetry	noop()	Returns a completely no-op OpenTelemetry.
static OpenTelemetry	propagating(ContextPropagators propagators)	Returns an OpenTelemetry which will do remote propagation of Context using the provided ContextPropagators and is no-op otherwise.
default TracerBuilder	tracerBuilder(java.lang.String instrumentationScopeName)	Creates a TracerBuilder for a named Tracer instance.

Method Detail

noop

static OpenTelemetry noop()

Returns a completely no-op OpenTelemetry.

propagating

static OpenTelemetry propagating(ContextPropagators propagators)

Returns an OpenTelemetry which will do remote propagation of Context using the provided ContextPropagators and is no-op otherwise.

getTracerProvider

TracerProvider getTracerProvider()

Returns the TracerProvider for this OpenTelemetry.

getTracer

default Tracer getTracer(java.lang.String instrumentationScopeName)

Gets or creates a named tracer instance from the TracerProvider for this OpenTelemetry.

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a tracer instance.

getTracer

default Tracer getTracer(java.lang.String instrumentationScopeName,
                         java.lang.String instrumentationScopeVersion)

Gets or creates a named and versioned tracer instance from the TracerProvider in this OpenTelemetry.

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

instrumentationScopeVersion - The version of the instrumentation scope (e.g., "1.0.0").

Returns:

a tracer instance.

tracerBuilder

default TracerBuilder tracerBuilder(java.lang.String instrumentationScopeName)

Creates a TracerBuilder for a named Tracer instance.

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a TracerBuilder instance.

Since:

1.4.0

getMeterProvider

default MeterProvider getMeterProvider()

Returns the MeterProvider for this OpenTelemetry.

Since:

1.10.0

getMeter

default Meter getMeter(java.lang.String instrumentationScopeName)

Gets or creates a named meter instance from the MeterProvider for this OpenTelemetry.

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a Meter instance.

Since:

1.10.0

meterBuilder

default MeterBuilder meterBuilder(java.lang.String instrumentationScopeName)

Creates a MeterBuilder for a named Meter instance.

Parameters:

instrumentationScopeName - A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.

Returns:

a MeterBuilder instance.

Since:

1.10.0

getLogsBridge

default LoggerProvider getLogsBridge()

Returns the LoggerProvider for bridging logs into OpenTelemetry.

The OpenTelemetry logs bridge API exists to enable bridging logs from other log frameworks (e.g. SLF4J, Log4j, JUL, Logback, etc) into OpenTelemetry and is NOT a replacement log API.

Since:

1.27.0

getPropagators

ContextPropagators getPropagators()

Returns the ContextPropagators for this OpenTelemetry.