Package io.opentelemetry.api

Interface OpenTelemetry

All Known Implementing Classes:

DefaultOpenTelemetry

public interface OpenTelemetry

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

A global singleton can be retrieved by get(). The default for the returned OpenTelemetry, if none has been set via set(OpenTelemetry), will be created with any OpenTelemetryFactory, TracerProviderFactory or MeterProviderFactory found on the classpath, or otherwise will be default, with no-op behavior.

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, MeterProvider, ContextPropagators

Method Summary

Modifier and Type	Method	Description
static OpenTelemetryBuilder<?>	builder()	Returns a new OpenTelemetryBuilder.
static OpenTelemetry	get()	Returns the registered global OpenTelemetry.
static Meter	getGlobalMeter(java.lang.String instrumentationName)	Gets or creates a named meter instance from the globally registered MeterProvider.
static Meter	getGlobalMeter(java.lang.String instrumentationName, java.lang.String instrumentationVersion)	Gets or creates a named and versioned meter instance from the globally registered MeterProvider.
static MeterProvider	getGlobalMeterProvider()	Returns the globally registered MeterProvider.
static io.opentelemetry.context.propagation.ContextPropagators	getGlobalPropagators()	Returns the globally registered ContextPropagators for remote propagation of a context.
static Tracer	getGlobalTracer(java.lang.String instrumentationName)	Gets or creates a named tracer instance from the globally registered TracerProvider.
static Tracer	getGlobalTracer(java.lang.String instrumentationName, java.lang.String instrumentationVersion)	Gets or creates a named and versioned tracer instance from the globally registered TracerProvider.
static TracerProvider	getGlobalTracerProvider()	Returns the globally registered TracerProvider.
default Meter	getMeter(java.lang.String instrumentationName)	Gets or creates a named meter instance from the MeterProvider in this OpenTelemetry.
default Meter	getMeter(java.lang.String instrumentationName, java.lang.String instrumentationVersion)	Gets or creates a named and versioned meter instance from the MeterProvider in this OpenTelemetry.
MeterProvider	getMeterProvider()	Returns the MeterProvider for this OpenTelemetry.
io.opentelemetry.context.propagation.ContextPropagators	getPropagators()	Returns the ContextPropagators for this OpenTelemetry.
default Tracer	getTracer(java.lang.String instrumentationName)	Gets or creates a named tracer instance from the TracerProvider for this OpenTelemetry.
default Tracer	getTracer(java.lang.String instrumentationName, java.lang.String instrumentationVersion)	Gets or creates a named and versioned tracer instance from the TracerProvider in this OpenTelemetry.
TracerProvider	getTracerProvider()	Returns the TracerProvider for this OpenTelemetry.
static void	set(OpenTelemetry openTelemetry)	Sets the OpenTelemetry that should be the global instance.
static void	setGlobalPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)	Sets the globally registered ContextPropagators for remote propagation of a context.
void	setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)	Sets the propagators that this instance should contain.
OpenTelemetryBuilder<?>	toBuilder()	Deprecated. This method should not be used, as it allows unexpected sharing of state across instances.

Method Detail

get

static OpenTelemetry get()

Returns the registered global OpenTelemetry. If no call to set(OpenTelemetry) has been made so far, a default OpenTelemetry composed of functionality any OpenTelemetryFactory, TracerProviderFactory orMeterProviderFactory, found on the classpath, or otherwise will be default, with no-op behavior.

Throws:

java.lang.IllegalStateException - if a provider has been specified by system property using the interface FQCN but the specified provider cannot be found.

set

static void set(OpenTelemetry openTelemetry)

Sets the OpenTelemetry that should be the global instance. Future calls to get() will return the provided OpenTelemetry instance. This should be called once as early as possible in your application initialization logic, often in a static block in your main class.

getGlobalTracerProvider

static TracerProvider getGlobalTracerProvider()

Returns the globally registered TracerProvider.

getGlobalTracer

static Tracer getGlobalTracer(java.lang.String instrumentationName)

Gets or creates a named tracer instance from the globally registered TracerProvider.

This is a shortcut method for getGlobalTracerProvider().get(instrumentationName)

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null.

Returns:

a tracer instance.

getGlobalTracer

static Tracer getGlobalTracer(java.lang.String instrumentationName,
                              java.lang.String instrumentationVersion)

Gets or creates a named and versioned tracer instance from the globally registered TracerProvider.

This is a shortcut method for getGlobalTracerProvider().get(instrumentationName, instrumentationVersion)

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null.

instrumentationVersion - The version of the instrumentation library (e.g., "1.0.0").

Returns:

a tracer instance.

getGlobalMeterProvider

static MeterProvider getGlobalMeterProvider()

Returns the globally registered MeterProvider.

getGlobalMeter

static Meter getGlobalMeter(java.lang.String instrumentationName)

Gets or creates a named meter instance from the globally registered MeterProvider.

This is a shortcut method for getGlobalMeterProvider().get(instrumentationName)

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library.

Returns:

a tracer instance.

getGlobalMeter

static Meter getGlobalMeter(java.lang.String instrumentationName,
                            java.lang.String instrumentationVersion)

Gets or creates a named and versioned meter instance from the globally registered MeterProvider.

This is a shortcut method for getGlobalMeterProvider().get(instrumentationName, instrumentationVersion)

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library.

instrumentationVersion - The version of the instrumentation library.

Returns:

a tracer instance.

getGlobalPropagators

static io.opentelemetry.context.propagation.ContextPropagators getGlobalPropagators()

Returns the globally registered ContextPropagators for remote propagation of a context.

setGlobalPropagators

static void setGlobalPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)

Sets the globally registered ContextPropagators for remote propagation of a context.

setPropagators

void setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)

Sets the propagators that this instance should contain.

getTracerProvider

TracerProvider getTracerProvider()

Returns the TracerProvider for this OpenTelemetry.

getTracer

default Tracer getTracer(java.lang.String instrumentationName)

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

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null.

Returns:

a tracer instance.

getTracer

default Tracer getTracer(java.lang.String instrumentationName,
                         java.lang.String instrumentationVersion)

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

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library (e.g., "io.opentelemetry.contrib.mongodb"). Must not be null.

instrumentationVersion - The version of the instrumentation library (e.g., "1.0.0").

Returns:

a tracer instance.

getMeterProvider

MeterProvider getMeterProvider()

Returns the MeterProvider for this OpenTelemetry.

getMeter

default Meter getMeter(java.lang.String instrumentationName)

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

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library.

Returns:

a tracer instance.

getMeter

default Meter getMeter(java.lang.String instrumentationName,
                       java.lang.String instrumentationVersion)

Gets or creates a named and versioned meter instance from the MeterProvider in this OpenTelemetry.

Parameters:

instrumentationName - The name of the instrumentation library, not the name of the instrument*ed* library.

instrumentationVersion - The version of the instrumentation library.

Returns:

a tracer instance.

getPropagators

io.opentelemetry.context.propagation.ContextPropagators getPropagators()

Returns the ContextPropagators for this OpenTelemetry.

toBuilder

@Deprecated
OpenTelemetryBuilder<?> toBuilder()

Deprecated.

This method should not be used, as it allows unexpected sharing of state across instances. It will be removed in the next release.

Returns a new OpenTelemetryBuilder with the configuration of this OpenTelemetry.

builder

static OpenTelemetryBuilder<?> builder()

Returns a new OpenTelemetryBuilder.