Adopt OTel cicd.* semantic conventions incl cicd.* metrics and spans by kamphaus · Pull Request #1251 · jenkinsci/opentelemetry-plugin

kamphaus · 2026-03-16T06:20:42Z

Related to #56

Building on #1096, we

Added plugin property semConvStability for switching between legacy Jenkins semantic conventions, Otel semantic conventions or both. Switching setting displays a warning to restart Jenkins.

with help:

Switched which metrics and attributes are used depending on semConvStability
Implemented cardinality protection
Fixed a bug in shortname logic for JobDSL
Implemented additional conventions (from a newer Otel SemConv v1.37.0):
- span attributes

Testing done

Fixed integration test of metrics
Manual tests running pipelines with each SemConvStability value
Manual test clean installation (semConvStability value = JENKINS)
Manual test upgrade (semConvStability value = JENKINS)

Submitter checklist

Make sure you are opening from a topic/feature/bugfix branch (right side) and not your main branch!
Ensure that the pull request title represents the desired changelog entry
Please describe what you did
Link to relevant issues in GitHub or Jira
Link to relevant pull requests, esp. upstream and downstream changes
Ensure you have provided tests that demonstrate the feature works or the issue is fixed

# Conflicts: # src/main/java/io/jenkins/plugins/opentelemetry/init/JenkinsExecutorMonitoringInitializer.java

# Conflicts: # src/main/java/io/jenkins/plugins/opentelemetry/init/JenkinsExecutorMonitoringInitializer.java # src/main/java/io/jenkins/plugins/opentelemetry/job/MonitoringRunListener.java # src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/DefaultRunHandler.java # src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/JobDslRunHandler.java # src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/MatrixRunHandler.java # src/main/java/io/jenkins/plugins/opentelemetry/semconv/ExtendedJenkinsAttributes.java

…ibutes replace them

kamphaus

I demoed this PR to some OpenTelemetry maintainers.
Here are 2 feedback items I will look into.

kamphaus · 2026-03-29T11:04:31Z

+    public static LongUpDownCounter newCiCdPipelineRunActiveCounter(Meter meter) {
+        LongUpDownCounterBuilder cicdPipelineRunActiveCounterBuilder = meter.upDownCounterBuilder(
+                        "cicd.pipeline.run.active")
+                .setUnit("{run}")
+                .setDescription("Number of active pipeline runs grouped by pipeline and state.");


Bug: Looks like active pipeline runs can be negative.

Looking into this issue I couldn't reproduce it.
However I did find a type mismatch in CicdMetric: 6835e54

Copilot

Pull request overview

This PR advances the plugin’s adoption of OpenTelemetry cicd.* semantic conventions by introducing a global semConvStability switch (Jenkins-only vs OTel-only vs both), updating span/metric attributes accordingly, and adding cardinality protection for pipeline-name metric attributes. It also updates integration/unit tests and JCasC fixtures to cover the new configuration behavior and metrics export strategy.

Changes:

Added SemConvStability configuration (UI + JCasC fixtures) to control emitting legacy Jenkins vs OTel CI/CD semantic conventions (or both).
Implemented/rewired CI/CD metrics and span attribute emission to follow the selected semantic convention stability, with pipeline-name cardinality protection for metrics.
Updated integration/unit tests and test harness metric export behavior to reduce flakiness and validate emitted metrics/spans.

Reviewed changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/zipkin.yml	Adds `semConvStability` to JCasC test input.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/zipkin-expected.yml	Updates expected exported config to include `semConvStability`.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/jaeger.yml	Adds `semConvStability` to JCasC test input.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/jaeger-expected.yml	Updates expected exported config to include `semConvStability`.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/elastic.yml	Adds `semConvStability` to JCasC test input.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/elastic-expected.yml	Updates expected exported config to include `semConvStability`.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/elastic-logs.yml	Adds `semConvStability` to JCasC test input (and fixes formatting).
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/elastic-logs-expected.yml	Updates expected exported config to include `semConvStability`.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/elastic-logs-exclusive.yml	Adds `semConvStability` to JCasC test input (exclusive logs backend).
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/elastic-logs-exclusive-expected.yml	Updates expected exported config to include `semConvStability`.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/configuration-as-code.yml	Adds `semConvStability` to JCasC test input.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/configuration-as-code-expected.yml	Updates expected exported config to include `semConvStability`.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/configuration-as-code-default.yml	Adds `semConvStability` to default JCasC config test input.
src/test/resources/io/jenkins/plugins/opentelemetry/jcasc/configuration-as-code-default-expected.yml	Updates expected exported default config to include `semConvStability`.
src/test/java/io/jenkins/plugins/opentelemetry/job/step/GitStepHandlerTest.java	Sets `SemConvStability` explicitly to keep assertions stable under the new toggle.
src/test/java/io/jenkins/plugins/opentelemetry/JenkinsOtelPluginIntegrationTest.java	Restores metrics assertions using explicit force-export and updates integration test setup.
src/test/java/io/jenkins/plugins/opentelemetry/JenkinsOpenTelemetryPluginConfigurationIntegrationTest.java	Adds a helper to force metric export after reconfiguration and validates reconfig behavior via metrics.
src/test/java/io/jenkins/plugins/opentelemetry/BaseIntegrationTest.java	Adds a shared `forceMetricsExport()` helper for integration tests.
src/main/resources/io/jenkins/plugins/opentelemetry/JenkinsOpenTelemetryPluginConfiguration/help-serviceName.html	Fixes malformed help HTML structure.
src/main/resources/io/jenkins/plugins/opentelemetry/JenkinsOpenTelemetryPluginConfiguration/help-semConvStability.html	Adds help text describing semantic convention stability and the restart implication.
src/main/resources/io/jenkins/plugins/opentelemetry/JenkinsOpenTelemetryPluginConfiguration/config.jelly	Adds the `semConvStability` select control to global configuration.
src/main/java/io/jenkins/plugins/opentelemetry/semconv/SemConvStability.java	Introduces the enum controlling legacy/OTel emission behavior.
src/main/java/io/jenkins/plugins/opentelemetry/semconv/ExtendedJenkinsAttributes.java	Deprecates legacy CI/CD attributes in favor of OTel incubating attributes and clarifies intent.
src/main/java/io/jenkins/plugins/opentelemetry/semconv/CicdMetrics.java	Adds OTel `cicd.*` metric builders and Jenkins→OTel value mapping helpers.
src/main/java/io/jenkins/plugins/opentelemetry/OpenTelemetryConfiguration.java	Adjusts test-mode metric export interval to reduce background scraping conflicts.
src/main/java/io/jenkins/plugins/opentelemetry/job/step/BuildTriggerStepHandler.java	Emits Jenkins vs OTel CI/CD pipeline-name attributes depending on `semConvStability`.
src/main/java/io/jenkins/plugins/opentelemetry/job/step/AbstractGitStepHandler.java	Emits Jenkins vs OTel VCS attributes depending on `semConvStability`.
src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/RunHandler.java	Adds `getSpanName()` to support low-cardinality pipeline naming.
src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/MatrixRunHandler.java	Refactors to use `getSpanName()` for consistent span naming.
src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/JobDslRunHandler.java	Uses `getSpanName()` and adjusts JobDSL naming logic.
src/main/java/io/jenkins/plugins/opentelemetry/job/runhandler/DefaultRunHandler.java	Implements `getSpanName()` and simplifies root span builder creation.
src/main/java/io/jenkins/plugins/opentelemetry/job/opentelemetry/OtelContextAwareAbstractRunListener.java	Injects and exposes `SemConvStability` for listeners.
src/main/java/io/jenkins/plugins/opentelemetry/job/MonitoringRunListener.java	Adds `cicd.*` metrics, cardinality protection, and convention-controlled span/metric attribute emission.
src/main/java/io/jenkins/plugins/opentelemetry/job/MonitoringPipelineListener.java	Adds convention-controlled step/task span attributes and worker attributes.
src/main/java/io/jenkins/plugins/opentelemetry/job/MonitoringBuildStepListener.java	Adds convention-controlled span attributes for freestyle build steps.
src/main/java/io/jenkins/plugins/opentelemetry/JenkinsOpenTelemetryPluginConfiguration.java	Persists `semConvStability`, adds UI fill/check endpoints, and restart warning validation.
src/main/java/io/jenkins/plugins/opentelemetry/JenkinsControllerOpenTelemetry.java	Exposes a testing-only metric reader accessor used by tests to force flush.
src/main/java/io/jenkins/plugins/opentelemetry/jenkins/OpenTelemetryConfigurerComputerListener.java	Adds convention-controlled worker resource attributes for agents.
src/main/java/io/jenkins/plugins/opentelemetry/init/JenkinsExecutorMonitoringInitializer.java	Adds `cicd.worker.count` emission and reorganizes executor/node metrics callbacks.
src/main/java/io/jenkins/plugins/opentelemetry/computer/MonitoringComputerListener.java	Adds convention-controlled worker attributes on controller/agent computers.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

The test works on Windows, hence no need to follow Copilot's suggestion to uncomment.

kamphaus · 2026-06-20T09:58:52Z

I'm not that familiar with @RequirePOST.
Are those 2 Copilot suggestions valid?
Those annotations were previously added in 20dfebf to fix findings by github-advanced-security: #1251 (review)
Manually testing the config UI, these seem to be working.

krisstern · 2026-06-23T12:02:41Z

It looks like these warnings are not really valid to me

cyrille-leclerc and others added 30 commits April 21, 2025 23:00

Add OTel cicd.* metrics

12e8557

Add OTel cicd.* metrics and attributes

f98eef0

Add OTel cicd.* metrics and attributes

16363ae

Add OTel cicd.* metrics and attributes

c7f24bb

Add OTel cicd.* metrics and attributes

5d037ff

Merge branch 'main' into add-otel-cicd-metrics

68f447e

Add OTel cicd.* metrics and attributes

5499fbf

Merge branch 'main' into add-otel-cicd-metrics

a70563c

# Conflicts: # src/main/java/io/jenkins/plugins/opentelemetry/init/JenkinsExecutorMonitoringInitializer.java

Add config flag otel.semconv-stability.opt-in=cicd

7142920

Add config flag otel.semconv-stability.opt-in=cicd

e1a7693

Add config flag otel.semconv-stability.opt-in=cicd

327a59e

Add config flag otel.semconv-stability.opt-in=[cicd,cicd/dup,cicd/old]

01a9221

Merge branch 'main' into add-otel-cicd-metrics

7268c37

WIP

3262dcf

Merge branch 'main' into add-otel-cicd-metrics

ad6e91e

Add configuration parameter for semConvStability

d7e735d

Upgrade otel semconv library version

157aa45

Mark additional semconv attributes as deprecated, since new otel attr…

2829384

…ibutes replace them

Remove duplicate closing </div>

77a501c

Fix displayed name for SemConvStability enum values

c282612

Display restart required warning

bcbbff5

Replace SemconvStability with use of SemConvStability enum

2b61fc0

Switch span attributes

64e37fa

Support otel semconv for build trigger step

d27e40b

Support otel semconv for workers

f1084bc

Support VCS conventions for git steps

613bf0b

Fix legacy convention flag

3cf3329

Use sanitizeUrl to add git URL in attribute

3c177b0

Set cicd.pipeline.action.name to BUILD

151797b

kamphaus added 3 commits March 29, 2026 10:57

Set 5 minute interval for metric scrapes in test

e471dbb

Return error on insufficient permission

9a01e2a

Change how default value for semConvStability is defined

9f937b7

kamphaus commented Mar 29, 2026

View reviewed changes

kamphaus added 11 commits March 29, 2026 14:53

Merge branch 'main' into add-otel-cicd-metrics

70d577d

Revert changes in RunHandler

f71428a

Adapt MonitoringRunListener and restore getSpanName in RunHandler

6712e1c

Spotless apply

8475d80

Revert initialization method for JenkinsExecutorMonitoringInitializer

594bf2d

Keep meters in same instrumentation scope as default meter

927d21d

Fix JavaDoc

866f6b5

Fix missing case

0de3ea2

Add use of cicd.task.run.id

6b9f80e

Merge branch 'main' into add-otel-cicd-metrics

6573bf6

fix type mismatch

6835e54

kamphaus requested a review from kuisathaverat April 26, 2026 19:42

Spotless apply

ce32e59

horovits mentioned this pull request May 12, 2026

chore: add krisstern as opentelemetry and opentelemetry api plugins maintainer jenkins-infra/repository-permissions-updater#5061

Merged

7 tasks

krisstern requested review from Copilot and krisstern and removed request for kuisathaverat June 19, 2026 14:44

Copilot started reviewing on behalf of krisstern June 19, 2026 14:44 View session

Copilot AI reviewed Jun 19, 2026

View reviewed changes

kamphaus added 3 commits June 20, 2026 09:57

Remove commented code

1f9e6ea

The test works on Windows, hence no need to follow Copilot's suggestion to uncomment.

Deduplicate code based on copilot suggestion

48038d1

Fix typo (copilot suggestion)

89850d8

krisstern approved these changes Aug 3, 2026

View reviewed changes

krisstern merged commit e62d394 into jenkinsci:main Aug 3, 2026
17 checks passed

Navigation Menu

Uh oh!

Adopt OTel cicd.* semantic conventions incl cicd.* metrics and spans - #1251

Adopt OTel cicd.* semantic conventions incl cicd.* metrics and spans#1251
krisstern merged 67 commits into
jenkinsci:mainfrom
kamphaus:add-otel-cicd-metrics

kamphaus commented Mar 16, 2026 •

edited by krisstern

Loading

Uh oh!

kamphaus left a comment

Uh oh!

Uh oh!

kamphaus Mar 29, 2026

Uh oh!

kamphaus Apr 26, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kamphaus commented Jun 20, 2026 •

edited

Loading

Uh oh!

krisstern commented Jun 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

Uh oh!

Conversation

kamphaus commented Mar 16, 2026 • edited by krisstern Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing done

Submitter checklist

Uh oh!

kamphaus left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

kamphaus Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

kamphaus Apr 26, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kamphaus commented Jun 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

krisstern commented Jun 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

7 participants

kamphaus commented Mar 16, 2026 •

edited by krisstern

Loading

kamphaus commented Jun 20, 2026 •

edited

Loading