Package io.opentelemetry.api
Interface OpenTelemetry
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 TypeMethodDescriptionio.opentelemetry.context.propagation.ContextPropagators
Returns theContextPropagators
for thisOpenTelemetry
.default Tracer
Gets or creates a named tracer instance from theTracerProvider
for thisOpenTelemetry
.default Tracer
Gets or creates a named and versioned tracer instance from theTracerProvider
in thisOpenTelemetry
.Returns theTracerProvider
for thisOpenTelemetry
.static OpenTelemetry
noop()
Returns a completely no-opOpenTelemetry
.static OpenTelemetry
propagating
(io.opentelemetry.context.propagation.ContextPropagators propagators) Returns anOpenTelemetry
which will do remote propagation ofContext
using the providedContextPropagators
and is no-op otherwise.default TracerBuilder
tracerBuilder
(String instrumentationName) Creates aTracerBuilder
for a namedTracer
instance.
-
Method Details
-
noop
Returns a completely no-opOpenTelemetry
. -
propagating
static OpenTelemetry propagating(io.opentelemetry.context.propagation.ContextPropagators propagators) Returns anOpenTelemetry
which will do remote propagation ofContext
using the providedContextPropagators
and is no-op otherwise. -
getTracerProvider
TracerProvider getTracerProvider()Returns theTracerProvider
for thisOpenTelemetry
. -
getTracer
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
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.
-
tracerBuilder
Creates aTracerBuilder
for a namedTracer
instance.- Parameters:
instrumentationName
- The name of the instrumentation library, not the name of the instrument*ed* library.- Returns:
- a TracerBuilder instance.
- Since:
- 1.4.0
-
getPropagators
io.opentelemetry.context.propagation.ContextPropagators getPropagators()Returns theContextPropagators
for thisOpenTelemetry
.
-