A global singleton for 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's OpenTelemetry implementation.

Warning

Due to the inherent complications around initialization order involving this class and its single global instance, we strongly recommend *not* using GlobalOpenTelemetry unless you have a use-case that absolutely requires it. Please favor using instances of OpenTelemetry wherever possible.

If you are using the OpenTelemetry javaagent, it is generally best to only call GlobalOpenTelemetry.get() once, and then pass the resulting reference where you need to use it.

Modifier and Type	Class and Description
pack-priv static class	GlobalOpenTelemetry.ObfuscatedOpenTelemetry Static global instances are obfuscated when they are returned from the API to prevent users from casting them to their SDK-specific implementation.

Field Summary

Modifier and Type	Field and Description
private static final String	GLOBAL_AUTOCONFIGURE_ENABLED_PROPERTY
private static volatile GlobalOpenTelemetry.ObfuscatedOpenTelemetry	globalOpenTelemetry
private static final Logger	logger
private static final Object	mutex
private static Throwable	setGlobalCaller

Constructor Summary

Access	Constructor and Description
private	GlobalOpenTelemetry()

Method Summary

Modifier and Type	Method and Description
public static OpenTelemetry	get() Returns the registered global `OpenTelemetry`.
public static Meter	Returns: a Meter instance. getMeter(String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeName) Gets or creates a named meter instance from the globally registered `MeterProvider`.
public static MeterProvider	getMeterProvider() Returns the globally registered `MeterProvider`.
public static ContextPropagators	getPropagators() Returns the globally registered `ContextPropagators` for remote propagation of a context.
public static Tracer	Returns: a tracer instance. getTracer(String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeName) Gets or creates a named tracer instance from the globally registered `TracerProvider`.
public static Tracer	Returns: a tracer instance. getTracer(String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeName, String The version of the instrumentation scope (e.g., "1.0.0"). instrumentationScopeVersion) Gets or creates a named and versioned tracer instance from the globally registered `TracerProvider`.
public static TracerProvider	getTracerProvider() Returns the globally registered `TracerProvider`.
private static OpenTelemetry	maybeAutoConfigureAndSetGlobal()
public static MeterBuilder	Returns: a MeterBuilder instance. meterBuilder(String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeName) Creates a MeterBuilder for a named `Meter` instance.
public static void	resetForTest() Unsets the global `OpenTelemetry`.
public static void	set(OpenTelemetry openTelemetry) Sets the `OpenTelemetry` that should be the global instance.
public static TracerBuilder	Returns: a TracerBuilder instance. tracerBuilder(String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeName) Creates a TracerBuilder for a named `Tracer` instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

GLOBAL_AUTOCONFIGURE_ENABLED_PROPERTY	back to summary
private static final String GLOBAL_AUTOCONFIGURE_ENABLED_PROPERTY

globalOpenTelemetry	back to summary
private static volatile GlobalOpenTelemetry.ObfuscatedOpenTelemetry globalOpenTelemetry Annotations @SuppressWarnings:NonFinalStaticField @Nullable

logger	back to summary
private static final Logger logger

mutex	back to summary
private static final Object mutex

setGlobalCaller	back to summary
private static Throwable setGlobalCaller Annotations @SuppressWarnings:NonFinalStaticField @GuardedBy:mutex @Nullable

Constructor Detail

GlobalOpenTelemetry	back to summary
private GlobalOpenTelemetry()

Method Detail

get back to summary

get	back to summary
public static OpenTelemetry get() Returns the registered global `OpenTelemetry`. Exceptions IllegalStateException: if a provider has been specified by system property using the interface FQCN but the specified provider cannot be found.

public static OpenTelemetry get()

Returns the registered global OpenTelemetry.

Exceptions

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

getMeter back to summary

getMeter	back to summary
public static Meter getMeter(String instrumentationScopeName) Gets or creates a named meter instance from the globally registered `MeterProvider`. This is a shortcut method for `getMeterProvider().get(instrumentationScopeName)` Parameters instrumentationScopeName:String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. Returns:Meter a Meter instance. Since 1.10.0

public static Meter getMeter(String instrumentationScopeName)

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

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

Parameters

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

Returns:Meter

a Meter instance.

Since

1.10.0

getMeterProvider back to summary

getMeterProvider	back to summary
public static MeterProvider getMeterProvider() Returns the globally registered `MeterProvider`. Since 1.10.0

public static MeterProvider getMeterProvider()

Returns the globally registered MeterProvider.

Since: 1.10.0

getPropagators	back to summary
public static ContextPropagators getPropagators() Returns the globally registered `ContextPropagators` for remote propagation of a context.

getTracer back to summary

getTracer	back to summary
public static Tracer getTracer(String instrumentationScopeName) Gets or creates a named tracer instance from the globally registered `TracerProvider`. This is a shortcut method for `getTracerProvider().get(instrumentationScopeName)` Parameters instrumentationScopeName:String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. Returns:Tracer a tracer instance.

public static Tracer getTracer(String instrumentationScopeName)

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

This is a shortcut method for getTracerProvider().get(instrumentationScopeName)

Parameters

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

Returns:Tracer

a tracer instance.

getTracer back to summary

getTracer	back to summary
public static Tracer getTracer(String instrumentationScopeName, String instrumentationScopeVersion) Gets or creates a named and versioned tracer instance from the globally registered `TracerProvider`. This is a shortcut method for `getTracerProvider().get(instrumentationScopeName, instrumentationScopeVersion)` Parameters instrumentationScopeName:String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeVersion:String The version of the instrumentation scope (e.g., "1.0.0"). Returns:Tracer a tracer instance.

public static Tracer getTracer(String instrumentationScopeName, String instrumentationScopeVersion)

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

This is a shortcut method for getTracerProvider().get(instrumentationScopeName, instrumentationScopeVersion)

Parameters

instrumentationScopeName:String: A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null.
instrumentationScopeVersion:String: The version of the instrumentation scope (e.g., "1.0.0").

Returns:Tracer

a tracer instance.

getTracerProvider	back to summary
public static TracerProvider getTracerProvider() Returns the globally registered `TracerProvider`.

maybeAutoConfigureAndSetGlobal	back to summary
private static OpenTelemetry maybeAutoConfigureAndSetGlobal() Annotations @Nullable

meterBuilder back to summary

meterBuilder	back to summary
public static MeterBuilder meterBuilder(String instrumentationScopeName) Creates a MeterBuilder for a named `Meter` instance. This is a shortcut method for `get().meterBuilder(instrumentationScopeName)` Parameters instrumentationScopeName:String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. Returns:MeterBuilder a MeterBuilder instance. Since 1.10.0

public static MeterBuilder meterBuilder(String instrumentationScopeName)

Creates a MeterBuilder for a named Meter instance.

This is a shortcut method for get().meterBuilder(instrumentationScopeName)

Parameters

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

Returns:MeterBuilder

a MeterBuilder instance.

Since

1.10.0

resetForTest	back to summary
public static void resetForTest() Unsets the global `OpenTelemetry`. This is only meant to be used from tests which need to reconfigure `OpenTelemetry`.

set back to summary

set	back to summary
public 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. It should only be called once - an attempt to call it a second time will result in an error. If trying to set the global `OpenTelemetry` multiple times in tests, use `GlobalOpenTelemetry#resetForTest()` between them. If you are using the OpenTelemetry SDK, you should generally use `OpenTelemetrySdk.builder().buildAndRegisterGlobal()` instead of calling this method directly.

public 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. It should only be called once - an attempt to call it a second time will result in an error. If trying to set the global OpenTelemetry multiple times in tests, use GlobalOpenTelemetry#resetForTest() between them.

If you are using the OpenTelemetry SDK, you should generally use OpenTelemetrySdk.builder().buildAndRegisterGlobal() instead of calling this method directly.

tracerBuilder back to summary

tracerBuilder	back to summary
public static TracerBuilder tracerBuilder(String instrumentationScopeName) Creates a TracerBuilder for a named `Tracer` instance. This is a shortcut method for `get().tracerBuilder(instrumentationScopeName)` Parameters instrumentationScopeName:String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. Returns:TracerBuilder a TracerBuilder instance. Since 1.4.0

public static TracerBuilder tracerBuilder(String instrumentationScopeName)

Creates a TracerBuilder for a named Tracer instance.

This is a shortcut method for get().tracerBuilder(instrumentationScopeName)

Parameters

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

Returns:TracerBuilder

a TracerBuilder instance.

Since

1.4.0

io.opentelemetry.api back to summary

pack-priv Class GlobalOpenTelemetry.ObfuscatedOpenTelemetry

Class Inheritance

extends Object
implements OpenTelemetry

java.lang.Object
io.opentelemetry.api.GlobalOpenTelemetry.ObfuscatedOpenTelemetry

All Implemented Interfaces

io.opentelemetry.api.OpenTelemetry

Annotations

@ThreadSafe

Static global instances are obfuscated when they are returned from the API to prevent users from casting them to their SDK-specific implementation. For example, we do not want users to use patterns like (OpenTelemetrySdk) GlobalOpenTelemetry.get().

Field Summary

Modifier and Type	Field and Description
private final OpenTelemetry	delegate

Constructor Summary

Access	Constructor and Description
pack-priv	ObfuscatedOpenTelemetry(OpenTelemetry delegate)

Method Summary

Modifier and Type	Method and Description
public LoggerProvider	getLogsBridge() Overrides default io.opentelemetry.api.OpenTelemetry.getLogsBridge. Returns the `LoggerProvider` for bridging logs into OpenTelemetry.
public MeterProvider	getMeterProvider() Overrides default io.opentelemetry.api.OpenTelemetry.getMeterProvider. Returns the `MeterProvider` for this `OpenTelemetry`.
public ContextPropagators	getPropagators() Implements io.opentelemetry.api.OpenTelemetry.getPropagators. Returns the `ContextPropagators` for this `OpenTelemetry`.
public TracerProvider	getTracerProvider() Implements io.opentelemetry.api.OpenTelemetry.getTracerProvider. Returns the `TracerProvider` for this `OpenTelemetry`.
public TracerBuilder	tracerBuilder(String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. instrumentationScopeName) Overrides default io.opentelemetry.api.OpenTelemetry.tracerBuilder. Creates a `TracerBuilder` for a named `Tracer` instance.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

delegate	back to summary
private final OpenTelemetry delegate

Constructor Detail

ObfuscatedOpenTelemetry	back to summary
pack-priv ObfuscatedOpenTelemetry(OpenTelemetry delegate)

Method Detail

getLogsBridge back to summary

getLogsBridge	back to summary
public LoggerProvider getLogsBridge() Overrides default io.opentelemetry.api.OpenTelemetry.getLogsBridge. Doc from io.opentelemetry.api.OpenTelemetry.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. Annotations @Override

public LoggerProvider getLogsBridge()

Overrides default io.opentelemetry.api.OpenTelemetry.getLogsBridge.

Doc from io.opentelemetry.api.OpenTelemetry.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.

Annotations

@Override

getMeterProvider back to summary

getMeterProvider	back to summary
public MeterProvider getMeterProvider() Overrides default io.opentelemetry.api.OpenTelemetry.getMeterProvider. Doc from io.opentelemetry.api.OpenTelemetry.getMeterProvider. Returns the `MeterProvider` for this `OpenTelemetry`. Annotations @Override

public MeterProvider getMeterProvider()

Overrides default io.opentelemetry.api.OpenTelemetry.getMeterProvider.

Doc from io.opentelemetry.api.OpenTelemetry.getMeterProvider.

Returns the MeterProvider for this OpenTelemetry.

Annotations

@Override

getPropagators back to summary

getPropagators	back to summary
public ContextPropagators getPropagators() Implements io.opentelemetry.api.OpenTelemetry.getPropagators. Doc from io.opentelemetry.api.OpenTelemetry.getPropagators. Returns the `ContextPropagators` for this `OpenTelemetry`. Annotations @Override

public ContextPropagators getPropagators()

Implements io.opentelemetry.api.OpenTelemetry.getPropagators.

Doc from io.opentelemetry.api.OpenTelemetry.getPropagators.

Returns the ContextPropagators for this OpenTelemetry.

Annotations

@Override

getTracerProvider back to summary

getTracerProvider	back to summary
public TracerProvider getTracerProvider() Implements io.opentelemetry.api.OpenTelemetry.getTracerProvider. Doc from io.opentelemetry.api.OpenTelemetry.getTracerProvider. Returns the `TracerProvider` for this `OpenTelemetry`. Annotations @Override

public TracerProvider getTracerProvider()

Implements io.opentelemetry.api.OpenTelemetry.getTracerProvider.

Doc from io.opentelemetry.api.OpenTelemetry.getTracerProvider.

Returns the TracerProvider for this OpenTelemetry.

Annotations

@Override

tracerBuilder back to summary

tracerBuilder	back to summary
public TracerBuilder tracerBuilder(String instrumentationScopeName) Overrides default io.opentelemetry.api.OpenTelemetry.tracerBuilder. Doc from io.opentelemetry.api.OpenTelemetry.tracerBuilder. Creates a `TracerBuilder` for a named `Tracer` instance. Parameters instrumentationScopeName:String A name uniquely identifying the instrumentation scope, such as the instrumentation library, package, or fully qualified class name. Must not be null. Returns:TracerBuilder a TracerBuilder instance. Annotations @Override

public TracerBuilder tracerBuilder(String instrumentationScopeName)

Overrides default io.opentelemetry.api.OpenTelemetry.tracerBuilder.

Doc from io.opentelemetry.api.OpenTelemetry.tracerBuilder.

Creates a TracerBuilder for a named Tracer instance.

Parameters

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

Returns:TracerBuilder

a TracerBuilder instance.

Annotations

@Override

public final Class GlobalOpenTelemetry

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class GlobalOpenTelemetry.ObfuscatedOpenTelemetry

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail