Package io.jenkins.plugins.opentelemetry

Interface OtelComponent

All Superinterfaces:

Comparable<OtelComponent>

All Known Implementing Classes:

AuditingSecurityListener, DiskUsageMonitoringInitializer, GitHubClientMonitoring, JenkinsExecutorMonitoringInitializer, JvmMonitoringInitializer, MonitoringBuildStepListener, MonitoringCloudListener, MonitoringComputerListener, MonitoringPipelineListener, MonitoringQueueListener, MonitoringRunListener, OtelContextAwareAbstractRunListener, OtelJulHandler, OtelLogStorageFactory, SCMEventMonitoringInitializer, ServletFilterInitializer

public interface OtelComponent
extends Comparable<OtelComponent>

Interface for components that want to be notified when the Otel SDK has been initialized or will be shutdown.

The life cycle of consumers of the OpenTelemetry SDK (consumers of TracerProvider, MeterProvider, and SdkLoggerProvider) can NOT use the Jenkins life cycle because those consumers of the Otel SDK need to perform initialization tasks after the Otel SDK has been initialized and have to shut down things before the Otel SDK is shutdown due to a reconfiguration.

Used by components that create counters...

Method Summary

Modifier and Type	Method	Description
default void	afterSdkInitialized(io.opentelemetry.api.metrics.Meter meter, io.opentelemetry.api.logs.LoggerProvider loggerProvider, io.opentelemetry.api.events.EventEmitter eventEmitter, io.opentelemetry.api.trace.Tracer tracer, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties configProperties)	Invoked soon after the Otel SDK has been initialized.
default void	afterSdkInitialized(io.opentelemetry.api.OpenTelemetry openTelemetry, io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties configProperties)	Invoked soon after the Otel SDK has been initialized.
default void	beforeSdkShutdown()	Invoked just before the Otel SDK is shutdown.
default int	compareTo(OtelComponent other)
default int	ordinal()

Method Detail

afterSdkInitialized

default void afterSdkInitialized(io.opentelemetry.api.metrics.Meter meter,
                                 io.opentelemetry.api.logs.LoggerProvider loggerProvider,
                                 io.opentelemetry.api.events.EventEmitter eventEmitter,
                                 io.opentelemetry.api.trace.Tracer tracer,
                                 io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties configProperties)

Invoked soon after the Otel SDK has been initialized. Created AutoCloseable metering instruments don't have to be closed by Otel components, the OpenTelemetry plugin takes care of this (eg ObservableLongUpDownCounter, ObservableLongCounter...)

Parameters:

meter - Meter of the newly initialized Otel SDK

loggerProvider - Logger of the newly initialized Otel SDK

eventEmitter -

tracer - Tracer of the newly initialized Otel SDK

configProperties - ConfigProperties of the newly initialized Otel SDK

afterSdkInitialized

default void afterSdkInitialized(io.opentelemetry.api.OpenTelemetry openTelemetry,
                                 io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties configProperties)

Invoked soon after the Otel SDK has been initialized. Created AutoCloseable metering instruments don't have to be closed by Otel components, the OpenTelemetry plugin takes care of this (eg ObservableLongUpDownCounter, ObservableLongCounter...)

Parameters:

openTelemetry -

configProperties - ConfigProperties of the newly initialized Otel SDK

beforeSdkShutdown

default void beforeSdkShutdown()

Invoked just before the Otel SDK is shutdown. Created AutoCloseable metering instruments don't have to be closed by Otel components, the OpenTelemetry plugin takes care of this (eg ObservableLongUpDownCounter, ObservableLongCounter...)

ordinal

default int ordinal()

Returns:

the ordinal of this otel component to execute step handlers in predictable order. The smallest ordinal is handled first.

compareTo

default int compareTo(OtelComponent other)

Specified by:

compareTo in interface Comparable<OtelComponent>