Package io.jenkins.plugins.opentelemetry.job.opentelemetry

Class OtelContextAwareAbstractRunListener

java.lang.Object

hudson.model.listeners.RunListener<Run>

io.jenkins.plugins.opentelemetry.job.opentelemetry.OtelContextAwareAbstractRunListener

All Implemented Interfaces:

ExtensionPoint, OtelComponent, Comparable<OtelComponent>

Direct Known Subclasses:

MonitoringRunListener

public abstract class OtelContextAwareAbstractRunListener
extends RunListener<Run>
implements OtelComponent

RunListener that setups the OpenTelemetry Context with the current Span.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields inherited from class hudson.model.listeners.RunListener

LISTENERS, targetType

Constructor Summary

Constructors

Constructor	Description
OtelContextAwareAbstractRunListener()

Method Summary

Modifier and Type	Method	Description
void	_onCompleted(Run run, TaskListener listener)
void	_onDeleted(Run run)
void	_onFinalized(Run run)
void	_onInitialize(Run run)
void	_onStarted(Run run, TaskListener listener)
Environment	_setUpEnvironment(AbstractBuild build, Launcher launcher, BuildListener listener)
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.
io.opentelemetry.api.trace.Tracer	getTracer()
OtelTraceService	getTraceService()
void	onCompleted(Run run, TaskListener listener)
void	onDeleted(Run run)
void	onFinalized(Run run)
void	onInitialize(Run run)
void	onStarted(Run run, TaskListener listener)
void	setOpenTelemetryTracerService(OtelTraceService otelTraceService)
Environment	setUpEnvironment(AbstractBuild build, Launcher launcher, BuildListener listener)

Methods inherited from class hudson.model.listeners.RunListener

all, fireCompleted, fireDeleted, fireFinalized, fireInitialize, fireStarted, register, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jenkins.plugins.opentelemetry.OtelComponent

afterSdkInitialized, beforeSdkShutdown, compareTo, ordinal

Constructor Detail

OtelContextAwareAbstractRunListener

public OtelContextAwareAbstractRunListener()

Method Detail

setOpenTelemetryTracerService

@Inject
public final void setOpenTelemetryTracerService(@NonNull
                                                OtelTraceService otelTraceService)

afterSdkInitialized

public 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)

Description copied from interface: OtelComponent

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...)

Specified by:

afterSdkInitialized in interface OtelComponent

Parameters:

meter - Meter of the newly initialized Otel SDK

loggerProvider - Logger of the newly initialized Otel SDK

tracer - Tracer of the newly initialized Otel SDK

configProperties - ConfigProperties of the newly initialized Otel SDK

onCompleted

public final void onCompleted(@NonNull
                              Run run,
                              @NonNull
                              TaskListener listener)

Overrides:

onCompleted in class RunListener<Run>

_onCompleted

public void _onCompleted(@NonNull
                         Run run,
                         @NonNull
                         TaskListener listener)

onFinalized

public final void onFinalized(@NonNull
                              Run run)

Overrides:

onFinalized in class RunListener<Run>

_onFinalized

public void _onFinalized(Run run)

onInitialize

public final void onInitialize(@NonNull
                               Run run)

Overrides:

onInitialize in class RunListener<Run>

_onInitialize

public void _onInitialize(@NonNull
                          Run run)

onStarted

public final void onStarted(@NonNull
                            Run run,
                            @NonNull
                            TaskListener listener)

Overrides:

onStarted in class RunListener<Run>

_onStarted

public void _onStarted(@NonNull
                       Run run,
                       @NonNull
                       TaskListener listener)

setUpEnvironment

public final Environment setUpEnvironment(@NonNull
                                          AbstractBuild build,
                                          @NonNull
                                          Launcher launcher,
                                          @NonNull
                                          BuildListener listener)
                                   throws IOException,
                                          InterruptedException,
                                          Run.RunnerAbortedException

Overrides:

setUpEnvironment in class RunListener<Run>

Throws:

IOException

InterruptedException

Run.RunnerAbortedException

_setUpEnvironment

@NonNull
public Environment _setUpEnvironment(@NonNull
                                     AbstractBuild build,
                                     @NonNull
                                     Launcher launcher,
                                     @NonNull
                                     BuildListener listener)
                              throws IOException,
                                     InterruptedException,
                                     Run.RunnerAbortedException

Throws:

IOException

InterruptedException

Run.RunnerAbortedException

onDeleted

public final void onDeleted(@NonNull
                            Run run)

Overrides:

onDeleted in class RunListener<Run>

_onDeleted

public void _onDeleted(@NonNull
                       Run run)

getTraceService

@NonNull
public OtelTraceService getTraceService()

getTracer

@NonNull
public io.opentelemetry.api.trace.Tracer getTracer()