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

Interface RunHandler

All Superinterfaces:
Comparable<RunHandler>
All Known Implementing Classes:
DefaultRunHandler, JobDslRunHandler, MatrixRunHandler
public interface RunHandler extends Comparable<RunHandler>

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canCreateSpanBuilder(Run<?,?> run)
     
    default int
    compareTo(RunHandler other)
     
    default void
    configure(io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties config)
     
    io.opentelemetry.api.trace.SpanBuilder
    createSpanBuilder(Run<?,?> run, io.opentelemetry.api.trace.Tracer tracer)
     
    String
    getSpanName(Run<?,?> run)
    Low cardinality pipeline name that fits with CicdIncubatingAttributes.CICD_PIPELINE_NAME.
    default int
    ordinal()
     

  • Method Details

    • configure

      default void configure(io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties config)

    • canCreateSpanBuilder

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

    • createSpanBuilder

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

    • getSpanName

      @NonNull String getSpanName(@NonNull Run<?,?> run)
      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.

    • ordinal

      default int ordinal()
      Returns:
      the ordinal of this handler to execute run handlers in predictable order. The smallest ordinal is executed first.

    • compareTo

      default int compareTo(RunHandler other)
      Specified by:
      compareTo in interface Comparable<RunHandler>