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

Class DefaultRunHandler

java.lang.Object

io.jenkins.plugins.opentelemetry.job.runhandler.DefaultRunHandler

All Implemented Interfaces:

RunHandler, Comparable<RunHandler>

@Extension
public class DefaultRunHandler
extends Object
implements RunHandler

Use same root span name for all pull change request pipelines (pull request, merge request) Use different span names for different branches.

Constructor Summary

Constructors

Constructor	Description
DefaultRunHandler()

Method Summary

Modifier and Type	Method	Description
boolean	canCreateSpanBuilder(Run<?,?> run)
io.opentelemetry.api.trace.SpanBuilder	createSpanBuilder(Run<?,?> run, io.opentelemetry.api.trace.Tracer tracer)
protected String	getChangeRequestRootSpanName(String jobFullName)
String	getSpanName(Run<?,?> run)	Low cardinality pipeline name that fits with CicdIncubatingAttributes.CICD_PIPELINE_NAME.
int	ordinal()

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.job.runhandler.RunHandler

compareTo, configure

Constructor Details

DefaultRunHandler

public DefaultRunHandler()

Method Details

canCreateSpanBuilder

public boolean canCreateSpanBuilder(@NonNull
 Run<?,?> run)

Specified by:

canCreateSpanBuilder in interface RunHandler

createSpanBuilder

@NonNull
public io.opentelemetry.api.trace.SpanBuilder createSpanBuilder(@NonNull
 Run<?,?> run,
 @NonNull
 io.opentelemetry.api.trace.Tracer tracer)

Specified by:

createSpanBuilder in interface RunHandler

getSpanName

@NonNull
public String getSpanName(@NonNull
 Run<?,?> run)

Description copied from interface: RunHandler

Low cardinality pipeline name that fits with CicdIncubatingAttributes.CICD_PIPELINE_NAME. High cardinality elements like the SCM pull request names of a Jenkins multibranch pipeline should be excluded from the pipeline short name.

Specified by:

getSpanName in interface RunHandler

getChangeRequestRootSpanName

@NonNull
protected String getChangeRequestRootSpanName(@NonNull
 String jobFullName)

ordinal

public int ordinal()

Specified by:

ordinal in interface RunHandler

Returns:

the ordinal of this handler to execute run handlers in predictable order. The smallest ordinal is executed first.