Package io.jenkins.plugins.opentelemetry.job

Class OtelTraceService

java.lang.Object

io.jenkins.plugins.opentelemetry.job.OtelTraceService

@Extension
public class OtelTraceService
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	STRICT_MODE

Constructor Summary

Constructors

Constructor	Description
OtelTraceService()

Method Summary

Modifier and Type	Method	Description
static OtelTraceService	get()
io.opentelemetry.api.trace.Span	getPipelineRootSpan(Run run)	Returns top level span of the Run
io.opentelemetry.api.trace.Span	getSpan(AbstractBuild build, BuildStep buildStep)
io.opentelemetry.api.trace.Span	getSpan(Run run)	Returns the span of the current run phase.
io.opentelemetry.api.trace.Span	getSpan(Run run, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)
void	purgeRun(Run run)
void	putAgentSpan(Run run, io.opentelemetry.api.trace.Span span, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)
void	putRunPhaseSpan(Run run, io.opentelemetry.api.trace.Span span)
void	putSpan(AbstractBuild build, BuildStep buildStep, io.opentelemetry.api.trace.Span span)
void	putSpan(AbstractBuild build, io.opentelemetry.api.trace.Span span)
void	putSpan(Run run, io.opentelemetry.api.trace.Span span)
void	putSpan(Run run, io.opentelemetry.api.trace.Span span, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)
void	putSpanAndScopes(Run run, io.opentelemetry.api.trace.Span span, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode, List<io.opentelemetry.context.Scope> scopes)
void	removeBuildStepSpan(AbstractBuild build, BuildStep buildStep, io.opentelemetry.api.trace.Span span)
void	removeJobPhaseSpan(Run run, io.opentelemetry.api.trace.Span span)
void	removePipelineStepSpanAndCloseAssociatedScopes(org.jenkinsci.plugins.workflow.job.WorkflowRun run, org.jenkinsci.plugins.workflow.graph.FlowNode flowNode, io.opentelemetry.api.trace.Span span)

Methods inherited from class java.lang.Object

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

Field Details

STRICT_MODE

public static boolean STRICT_MODE

Constructor Details

OtelTraceService

public OtelTraceService()

Method Details

getSpan

public io.opentelemetry.api.trace.Span getSpan(@NonNull
 Run run)

Returns the span of the current run phase.

Returns:

the span of the current pipeline run phase: JenkinsOtelSemanticAttributes.JENKINS_JOB_SPAN_PHASE_START_NAME, JenkinsOtelSemanticAttributes.JENKINS_JOB_SPAN_PHASE_RUN_NAME, JenkinsOtelSemanticAttributes.JENKINS_JOB_SPAN_PHASE_FINALIZE_NAME,

getPipelineRootSpan

@NonNull
public io.opentelemetry.api.trace.Span getPipelineRootSpan(@NonNull
 Run run)

Returns top level span of the Run

getSpan

@NonNull
public io.opentelemetry.api.trace.Span getSpan(@NonNull
 Run run,
 org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)

getSpan

@NonNull
public io.opentelemetry.api.trace.Span getSpan(@NonNull
 AbstractBuild build,
 @NonNull
 BuildStep buildStep)

removePipelineStepSpanAndCloseAssociatedScopes

public void removePipelineStepSpanAndCloseAssociatedScopes(@NonNull
 org.jenkinsci.plugins.workflow.job.WorkflowRun run,
 @NonNull
 org.jenkinsci.plugins.workflow.graph.FlowNode flowNode,
 @NonNull
 io.opentelemetry.api.trace.Span span)

removeJobPhaseSpan

public void removeJobPhaseSpan(@NonNull
 Run run,
 @NonNull
 io.opentelemetry.api.trace.Span span)

removeBuildStepSpan

public void removeBuildStepSpan(@NonNull
 AbstractBuild build,
 @NonNull
 BuildStep buildStep,
 @NonNull
 io.opentelemetry.api.trace.Span span)

purgeRun

public void purgeRun(@NonNull
 Run run)

putSpan

public void putSpan(@NonNull
 AbstractBuild build,
 @NonNull
 io.opentelemetry.api.trace.Span span)

putSpan

public void putSpan(AbstractBuild build,
 BuildStep buildStep,
 io.opentelemetry.api.trace.Span span)

putSpan

public void putSpan(@NonNull
 Run run,
 @NonNull
 io.opentelemetry.api.trace.Span span)

putRunPhaseSpan

public void putRunPhaseSpan(@NonNull
 Run run,
 @NonNull
 io.opentelemetry.api.trace.Span span)

putAgentSpan

public void putAgentSpan(@NonNull
 Run run,
 @NonNull
 io.opentelemetry.api.trace.Span span,
 @NonNull
 org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)

putSpan

public void putSpan(@NonNull
 Run run,
 @NonNull
 io.opentelemetry.api.trace.Span span,
 @NonNull
 org.jenkinsci.plugins.workflow.graph.FlowNode flowNode)

putSpanAndScopes

public void putSpanAndScopes(@NonNull
 Run run,
 @NonNull
 io.opentelemetry.api.trace.Span span,
 @NonNull
 org.jenkinsci.plugins.workflow.graph.FlowNode flowNode,
 List<io.opentelemetry.context.Scope> scopes)

get

public static OtelTraceService get()