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 Detail

      • 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 registered MeterProvider.
      • 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 registered MeterProvider.
      • 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 registered MeterProvider.
      • getGlobalPropagators

        @Deprecated
        static io.opentelemetry.context.propagation.ContextPropagators getGlobalPropagators()
        Returns the globally registered ContextPropagators 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 registered ContextPropagators 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 the TracerProvider for this OpenTelemetry.
      • getTracer

        default io.opentelemetry.api.trace.Tracer getTracer​(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 io.opentelemetry.api.trace.Tracer getTracer​(String instrumentationName,
                                                            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

        @Deprecated
        io.opentelemetry.api.metrics.MeterProvider getMeterProvider()
        Deprecated.
        this will be removed soon in preparation for the initial otel release.
        Returns the MeterProvider for this OpenTelemetry.
      • 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 the MeterProvider in this OpenTelemetry.
      • 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 the MeterProvider in this OpenTelemetry.
      • getPropagators

        io.opentelemetry.context.propagation.ContextPropagators getPropagators()
        Returns the ContextPropagators for this OpenTelemetry.