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 returnedOpenTelemetry
, if none has been set viaset(OpenTelemetry)
, will be created with anyOpenTelemetryFactory
,TracerProviderFactory
orMeterProviderFactory
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 ofResource
orSampler
. SeeOpenTelemetrySdk
andOpenTelemetrySdk.builder
for information on how to construct the SDKOpenTelemetry
.- See Also:
TracerProvider
,MeterProvider
,ContextPropagators
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description static OpenTelemetryBuilder<?>
builder()
Deprecated.static OpenTelemetry
get()
Deprecated.static io.opentelemetry.api.metrics.Meter
getGlobalMeter(String instrumentationName)
Deprecated.this will be removed soon in preparation for the initial otel release.static io.opentelemetry.api.metrics.Meter
getGlobalMeter(String instrumentationName, String instrumentationVersion)
Deprecated.this will be removed soon in preparation for the initial otel release.static io.opentelemetry.api.metrics.MeterProvider
getGlobalMeterProvider()
Deprecated.this will be removed soon in preparation for the initial otel release.static io.opentelemetry.context.propagation.ContextPropagators
getGlobalPropagators()
Deprecated.static io.opentelemetry.api.trace.Tracer
getGlobalTracer(String instrumentationName)
Deprecated.static io.opentelemetry.api.trace.Tracer
getGlobalTracer(String instrumentationName, String instrumentationVersion)
Deprecated.static io.opentelemetry.api.trace.TracerProvider
getGlobalTracerProvider()
Deprecated.default io.opentelemetry.api.metrics.Meter
getMeter(String instrumentationName)
Deprecated.this will be removed soon in preparation for the initial otel release.default io.opentelemetry.api.metrics.Meter
getMeter(String instrumentationName, String instrumentationVersion)
Deprecated.this will be removed soon in preparation for the initial otel release.io.opentelemetry.api.metrics.MeterProvider
getMeterProvider()
Deprecated.this will be removed soon in preparation for the initial otel release.io.opentelemetry.context.propagation.ContextPropagators
getPropagators()
Returns theContextPropagators
for thisOpenTelemetry
.default io.opentelemetry.api.trace.Tracer
getTracer(String instrumentationName)
Gets or creates a named tracer instance from theTracerProvider
for thisOpenTelemetry
.default io.opentelemetry.api.trace.Tracer
getTracer(String instrumentationName, String instrumentationVersion)
Gets or creates a named and versioned tracer instance from theTracerProvider
in thisOpenTelemetry
.io.opentelemetry.api.trace.TracerProvider
getTracerProvider()
Returns theTracerProvider
for thisOpenTelemetry
.static void
set(OpenTelemetry openTelemetry)
Deprecated.static void
setGlobalPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)
Deprecated.this will be removed soon, create a new instance if necessary.void
setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)
Deprecated.this will be removed soon, create a new instance if necessary.
-
-
-
Method Detail
-
get
@Deprecated static OpenTelemetry get()
Deprecated.Returns the registered globalOpenTelemetry
.
-
set
@Deprecated static void set(OpenTelemetry openTelemetry)
Deprecated.Sets theOpenTelemetry
that should be the global instance.
-
getGlobalTracerProvider
@Deprecated static io.opentelemetry.api.trace.TracerProvider getGlobalTracerProvider()
Deprecated.Returns the globally registeredTracerProvider
.
-
getGlobalTracer
@Deprecated static io.opentelemetry.api.trace.Tracer getGlobalTracer(String instrumentationName)
Deprecated.Gets or creates a named tracer instance from the globally registeredTracerProvider
.
-
getGlobalTracer
@Deprecated static io.opentelemetry.api.trace.Tracer getGlobalTracer(String instrumentationName, String instrumentationVersion)
Deprecated.Gets or creates a named and versioned tracer instance from the globally registeredTracerProvider
.
-
getGlobalMeterProvider
@Deprecated static io.opentelemetry.api.metrics.MeterProvider getGlobalMeterProvider()
Deprecated.this will be removed soon in preparation for the initial otel release.Returns the globally registeredMeterProvider
.
-
getGlobalMeter
@Deprecated static io.opentelemetry.api.metrics.Meter getGlobalMeter(String instrumentationName)
Deprecated.this will be removed soon in preparation for the initial otel release.Gets or creates a named meter instance from the globally registeredMeterProvider
.
-
getGlobalMeter
@Deprecated static io.opentelemetry.api.metrics.Meter getGlobalMeter(String instrumentationName, String instrumentationVersion)
Deprecated.this will be removed soon in preparation for the initial otel release.Gets or creates a named and versioned meter instance from the globally registeredMeterProvider
.
-
getGlobalPropagators
@Deprecated static io.opentelemetry.context.propagation.ContextPropagators getGlobalPropagators()
Deprecated.Returns the globally registeredContextPropagators
for remote propagation of a context.
-
setGlobalPropagators
@Deprecated static void setGlobalPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)
Deprecated.this will be removed soon, create a new instance if necessary.Sets the globally registeredContextPropagators
for remote propagation of a context.
-
setPropagators
@Deprecated void setPropagators(io.opentelemetry.context.propagation.ContextPropagators propagators)
Deprecated.this will be removed soon, create a new instance if necessary.Sets the propagators that this instance should contain.
-
getTracerProvider
io.opentelemetry.api.trace.TracerProvider getTracerProvider()
Returns theTracerProvider
for thisOpenTelemetry
.
-
getTracer
default io.opentelemetry.api.trace.Tracer getTracer(String instrumentationName)
Gets or creates a named tracer instance from theTracerProvider
for thisOpenTelemetry
.- 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 io.opentelemetry.api.trace.Tracer getTracer(String instrumentationName, String instrumentationVersion)
Gets or creates a named and versioned tracer instance from theTracerProvider
in thisOpenTelemetry
.- 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
@Deprecated io.opentelemetry.api.metrics.MeterProvider getMeterProvider()
Deprecated.this will be removed soon in preparation for the initial otel release.Returns theMeterProvider
for thisOpenTelemetry
.
-
getMeter
@Deprecated default io.opentelemetry.api.metrics.Meter getMeter(String instrumentationName)
Deprecated.this will be removed soon in preparation for the initial otel release.Gets or creates a named meter instance from theMeterProvider
in thisOpenTelemetry
.
-
getMeter
@Deprecated default io.opentelemetry.api.metrics.Meter getMeter(String instrumentationName, String instrumentationVersion)
Deprecated.this will be removed soon in preparation for the initial otel release.Gets or creates a named and versioned meter instance from theMeterProvider
in thisOpenTelemetry
.
-
getPropagators
io.opentelemetry.context.propagation.ContextPropagators getPropagators()
Returns theContextPropagators
for thisOpenTelemetry
.
-
builder
@Deprecated static OpenTelemetryBuilder<?> builder()
Deprecated.Returns a newOpenTelemetryBuilder
.
-
-