Package io.jenkins.plugins.opentelemetry.api

Interface ExtendedOpenTelemetry

All Superinterfaces:
ExtensionPoint, io.opentelemetry.api.OpenTelemetry
All Known Implementing Classes:
ReconfigurableOpenTelemetry
public interface ExtendedOpenTelemetry extends ExtensionPoint, io.opentelemetry.api.OpenTelemetry
Extension of OpenTelemetry that provides additional functionality:
  • Accessor to the EventLoggerProvider without requiring using a separate GlobalEventLoggerProvider
  • Read access top the ConfigProperties and Resource
  • Ability to be reconfigured through configure(Map, Resource, boolean)
  • Ability to be used as a Jenkins Extension

  • Nested Class Summary

    Nested classes/interfaces inherited from interface hudson.ExtensionPoint

    ExtensionPoint.LegacyInstancesAreScopedToHudson

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    configure(Map<String,String> openTelemetryProperties, io.opentelemetry.sdk.resources.Resource openTelemetryResource)
    Deprecated.
    use configure(Map, Resource, boolean)
    default void
    configure(Map<String,String> openTelemetryProperties, io.opentelemetry.sdk.resources.Resource openTelemetryResource, boolean disableShutdownHook)
    Reconfigures the OpenTelemetry instance.
    io.opentelemetry.api.incubator.events.EventLoggerBuilder
    eventLoggerBuilder(String instrumentationScopeName)
     
    io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties
    getConfig()
    ConfigProperties used to instantiate this OpenTelemetry instance using the AutoConfiguredOpenTelemetrySdk.
    io.opentelemetry.api.incubator.events.EventLoggerProvider
    getEventLoggerProvider()
     
    io.opentelemetry.api.OpenTelemetry
    getImplementation()
    Deprecated.
    io.opentelemetry.sdk.resources.Resource
    getResource()
    Resource used by this OpenTelemetry instance for the resource attributes of the produced telemetry

    Methods inherited from interface io.opentelemetry.api.OpenTelemetry

    getLogsBridge, getMeter, getMeterProvider, getPropagators, getTracer, getTracer, getTracerProvider, meterBuilder, tracerBuilder

  • Method Details

    • getEventLoggerProvider

      io.opentelemetry.api.incubator.events.EventLoggerProvider getEventLoggerProvider()

    • eventLoggerBuilder

      io.opentelemetry.api.incubator.events.EventLoggerBuilder eventLoggerBuilder(String instrumentationScopeName)

    • getConfig

      io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties getConfig()
      ConfigProperties used to instantiate this OpenTelemetry instance using the AutoConfiguredOpenTelemetrySdk.

    • getResource

      io.opentelemetry.sdk.resources.Resource getResource()
      Resource used by this OpenTelemetry instance for the resource attributes of the produced telemetry

    • configure

      @Deprecated void configure(@NonNull Map<String,String> openTelemetryProperties, io.opentelemetry.sdk.resources.Resource openTelemetryResource)
      Deprecated.
      use configure(Map, Resource, boolean)

    • configure

      default void configure(@NonNull Map<String,String> openTelemetryProperties, io.opentelemetry.sdk.resources.Resource openTelemetryResource, boolean disableShutdownHook)
      Reconfigures the OpenTelemetry instance. If no exporter is explicitly defined, this OpenTelemetry instance is NoOp.
      Parameters:
      openTelemetryProperties - properties used as ConfigProperties through AutoConfiguredOpenTelemetrySdkBuilder.addPropertiesSupplier(Supplier)
      openTelemetryResource - resource attributes passed through AutoConfiguredOpenTelemetrySdkBuilder.addResourceCustomizer(BiFunction)
      disableShutdownHook - enable / disable a shutdown hook

    • getImplementation

      @Deprecated io.opentelemetry.api.OpenTelemetry getImplementation()
      Deprecated.