io.opentelemetry

Class OpenTelemetry

java.lang.Object

io.opentelemetry.OpenTelemetry

@ThreadSafe
public final class OpenTelemetry
extends Object

This class provides a static global accessor for telemetry objects Tracer, Meter and CorrelationContextManager.

The telemetry objects are lazy-loaded singletons resolved via ServiceLoader mechanism.

See Also:

TracerProvider, MeterProviderFactory, CorrelationContextManagerFactory

Method Summary

Modifier and Type	Method and Description
static CorrelationContextManager	getCorrelationContextManager() Returns a singleton CorrelationContextManager.
static Meter	getMeter(String instrumentationName) Gets or creates a named meter instance.
static Meter	getMeter(String instrumentationName, String instrumentationVersion) Gets or creates a named and versioned meter instance.
static MeterProvider	getMeterProvider() Returns a singleton MeterProvider.
static io.opentelemetry.context.propagation.ContextPropagators	getPropagators() Returns a ContextPropagators object, which can be used to access the set of registered propagators for each supported format.
static Tracer	getTracer(String instrumentationName) Gets or creates a named tracer instance.
static Tracer	getTracer(String instrumentationName, String instrumentationVersion) Gets or creates a named and versioned tracer instance.
static TracerProvider	getTracerProvider() Returns a singleton TracerProvider.
static void	setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators) Sets the ContextPropagators object, which can be used to access the set of registered propagators for each supported format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getTracerProvider

public static TracerProvider getTracerProvider()

Returns a singleton TracerProvider.

Returns:

registered TracerProvider or default via DefaultTracerProvider.getInstance().

Throws:

IllegalStateException - if a specified TracerProvider (via system properties) could not be found.

Since:

0.1.0

getTracer

public static Tracer getTracer(String instrumentationName)

Gets or creates a named tracer instance.

This is a shortcut method for getTracerProvider().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.

Since:

0.5.0

getTracer

public static Tracer getTracer(String instrumentationName,
                               String instrumentationVersion)

Gets or creates a named and versioned tracer instance.

This is a shortcut method for getTracerProvider().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., "semver:1.0.0").

Returns:

a tracer instance.

Since:

0.5.0

getMeterProvider

public static MeterProvider getMeterProvider()

Returns a singleton MeterProvider.

Returns:

registered MeterProvider or default via DefaultMeterProvider.getInstance().

Throws:

IllegalStateException - if a specified MeterProvider (via system properties) could not be found.

Since:

0.1.0

getMeter

public static Meter getMeter(String instrumentationName)

Gets or creates a named meter instance.

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

Parameters:

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

Returns:

a tracer instance.

Since:

0.5.0

getMeter

public static Meter getMeter(String instrumentationName,
                             String instrumentationVersion)

Gets or creates a named and versioned meter instance.

This is a shortcut method for getMeterProvider().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.

Since:

0.5.0

getCorrelationContextManager

public static CorrelationContextManager getCorrelationContextManager()

Returns a singleton CorrelationContextManager.

Returns:

registered manager or default via DefaultCorrelationContextManager.getInstance().

Throws:

IllegalStateException - if a specified manager (via system properties) could not be found.

Since:

0.1.0

getPropagators

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

Returns a ContextPropagators object, which can be used to access the set of registered propagators for each supported format.

Returns:

registered propagators container, defaulting to a ContextPropagators object with HttpTraceContext registered.

Throws:

IllegalStateException - if a specified manager (via system properties) could not be found.

Since:

0.3.0

setPropagators

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

Sets the ContextPropagators object, which can be used to access the set of registered propagators for each supported format.

Parameters:

propagators - the ContextPropagators object to be registered.

Throws:

IllegalStateException - if a specified manager (via system properties) could not be found.

NullPointerException - if propagators is null.

Since:

0.3.0