CI/CD and source control

as of v1.44.0

Pipelines, repositories, test runs and the artefacts and deployments they produce.

vcs 21 cicd 16 artifact 7 deployment 5 test 4

attributes: 53
metrics: 15
signals: 8
stable: 1
deprecated: 6

Signals

What this domain emits, and the attributes each one carries, most strongly required first. An attribute marked * is required on that signal; * is conditionally required.

Spans 2

cicd.pipeline.run.serverserverRelease candidateThis span describes a CI/CD pipeline run.
cicd.pipeline.result*error.type*cicd.pipeline.action.name
cicd.pipeline.task.internalinternalRelease candidateThis span describes task execution in a pipeline run.
cicd.pipeline.task.name*cicd.pipeline.task.run.id*cicd.pipeline.task.run.result*cicd.pipeline.task.run.url.full*error.type*

Entities 6

cicd.pipelineRelease candidateA pipeline is a series of automated steps that helps software teams deliver code.
cicd.pipeline.name*
cicd.pipeline.runRelease candidateA pipeline run is a singular execution of a given pipeline's tasks.
cicd.pipeline.run.id*cicd.pipeline.run.url.full
cicd.workerRelease candidateA CI/CD worker is a component of the CI/CD system that performs work (eg. running pipeline tasks or performing sync). A
cicd.worker.id*cicd.worker.namecicd.worker.url.full
deploymentDevelopmentThe software deployment.
deployment.environment.name
vcs.refDevelopmentA reference to a specific version in the Version Control System.
vcs.ref.head.revision*vcs.ref.head.namevcs.ref.type
vcs.repositoryRelease candidateA repository in the Version Control System.
vcs.repository.url.full*vcs.repository.name

Metrics 15

cicd.pipeline.run.active
Release candidateupdowncounter · {run}The number of pipeline runs currently active in the system by state.
cicd.pipeline.run.duration
Release candidatehistogram · sDuration of a pipeline run grouped by pipeline, state and result.
cicd.pipeline.run.errors
Release candidatecounter · {error}The number of errors encountered in pipeline runs (eg. compile, test failures).
cicd.system.errors
Release candidatecounter · {error}The number of errors in a component of the CI/CD system (eg. controller, scheduler, agent).
cicd.worker.count
Release candidateupdowncounter · {worker}The number of workers on the CI/CD system by state.
vcs.change.count
Release candidateupdowncounter · {change}The number of changes (pull requests/merge requests/changelists) in a repository, categorized by their state (e.g. open or merged).
vcs.change.duration
Release candidategauge · sThe time duration a change (pull request/merge request/changelist) has been in a given state.
vcs.change.time_to_approval
Developmentgauge · sThe amount of time since its creation it took a change (pull request/merge request/changelist) to get the first approval.
vcs.change.time_to_merge
Developmentgauge · sThe amount of time since its creation it took a change (pull request/merge request/changelist) to get merged into the target(base) ref.
vcs.contributor.count
Release candidategauge · {contributor}The number of unique contributors to a repository.
vcs.ref.count
Release candidateupdowncounter · {ref}The number of refs of type branch or tag in a repository.
vcs.ref.lines_delta
Release candidategauge · {line}The number of lines added/removed in a ref (branch) relative to the ref from the vcs.ref.base.name attribute.
vcs.ref.revisions_delta
Release candidategauge · {revision}The number of revisions (commits) a ref (branch) is ahead/behind the branch from the vcs.ref.base.name attribute.
vcs.ref.time
Release candidategauge · sTime a ref (branch) created from the default branch (trunk) has existed. The ref.type attribute will always be branch.
vcs.repository.count
Release candidateupdowncounter · {repository}The number of repositories in an organization.

Specification

Spansare bound by the trace specification — 289 requirements across 7 documents, 166 of them MUST or SHALL.
Metricsare bound by the metrics specification — 548 requirements across 8 documents, 279 of them MUST or SHALL.
Entitiesare bound by the entities specification — 53 requirements across 3 documents, 23 of them MUST or SHALL.

The specification prose never names this domain. That is not an omission: the specification defines signals, not subject matter — what binds vcs telemetry is the general rules above, and the conventions themselves carry the rest.

On the wire, this lands in trace/v1/trace, metrics/v1/metrics, resource/v1/resource. Field-by-field definitions are under OTLP.

Attributes 53

vcs21 attributes

vcs.change.id
Release candidateThe ID of the change (pull request/merge request/changelist) if applicable. This is usually a unique (within repository) identifier generated by the VCS system.
vcs.change.state
Release candidateThe state of the change (pull request/merge request/changelist).
vcs.change.title
Release candidateThe human readable title of the change (pull request/merge request/changelist). This title is often a brief summary of the change and may get merged in to a ref
vcs.line_change.type
Release candidateThe type of line change being measured on a branch or change.
vcs.owner.name
Release candidateThe group owner within the version control system.
vcs.provider.name
Release candidateThe name of the version control system provider.
vcs.ref.base.name
Release candidateThe name of the reference such as **branch** or **tag** in the repository.
vcs.ref.base.revision
Release candidateThe revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN.
vcs.ref.base.type
Release candidateThe type of the reference in the repository.
vcs.ref.head.name
Release candidateThe name of the reference such as **branch** or **tag** in the repository.
vcs.ref.head.revision
Release candidateThe revision, literally revised version, The revision most often refers to a commit object in Git, or a revision number in SVN.
vcs.ref.head.type
Release candidateThe type of the reference in the repository.
vcs.ref.type
Release candidateThe type of the reference in the repository.
vcs.repository.change.id
Deprecated→ vcs.change.idDeprecated, use vcs.change.id instead.
vcs.repository.change.title
Deprecated→ vcs.change.titleDeprecated, use vcs.change.title instead.
vcs.repository.name
Release candidateThe human readable name of the repository. It SHOULD NOT include any additional identifier like Group/SubGroup in GitLab or organization in GitHub.
vcs.repository.ref.name
Deprecated→ vcs.ref.head.nameDeprecated, use vcs.ref.head.name instead.
vcs.repository.ref.revision
Deprecated→ vcs.ref.head.revisionDeprecated, use vcs.ref.head.revision instead.
vcs.repository.ref.type
Deprecated→ vcs.ref.head.typeDeprecated, use vcs.ref.head.type instead.
vcs.repository.url.full
Release candidateThe canonical URL of the repository providing the complete HTTP(S) address in order to locate and identify the repository through a browser.
vcs.revision_delta.direction
Release candidateThe type of revision comparison.

cicd16 attributes

cicd.pipeline.action.name
Release candidateThe kind of action a pipeline run is performing.
cicd.pipeline.name
Release candidateThe human readable name of the pipeline within a CI/CD system.
cicd.pipeline.result
Release candidateThe result of a pipeline run.
cicd.pipeline.run.id
Release candidateThe unique identifier of a pipeline run within a CI/CD system.
cicd.pipeline.run.state
Release candidateThe pipeline run goes through these states during its lifecycle.
cicd.pipeline.run.url.full
Release candidateThe URL of the pipeline run, providing the complete address in order to locate and identify the pipeline run.
cicd.pipeline.task.name
Release candidateThe human readable name of a task within a pipeline. Task here most closely aligns with a computing process) in a pipeline. Other terms for tasks include comman
cicd.pipeline.task.run.id
Release candidateThe unique identifier of a task run within a pipeline.
cicd.pipeline.task.run.result
Release candidateThe result of a task run.
cicd.pipeline.task.run.url.full
Release candidateThe URL of the pipeline task run, providing the complete address in order to locate and identify the pipeline task run.
cicd.pipeline.task.type
Release candidateThe type of the task within a pipeline.
cicd.system.component
Release candidateThe name of a component of the CI/CD system.
cicd.worker.id
Release candidateThe unique identifier of a worker within a CI/CD system.
cicd.worker.name
Release candidateThe name of a worker within a CI/CD system.
cicd.worker.state
Release candidateThe state of a CI/CD worker / agent.
cicd.worker.url.full
Release candidateThe URL of the worker, providing the complete address in order to locate and identify the worker.

artifact7 attributes

artifact.attestation.filename
DevelopmentThe provenance filename of the built attestation which directly relates to the build artifact filename. This filename SHOULD accompany the artifact at publish t
artifact.attestation.hash
DevelopmentThe full hash value (see glossary), of the built attestation. Some envelopes in the software attestation space also refer to this as the **digest**.
artifact.attestation.id
DevelopmentThe ID of the build software attestation.
artifact.filename
DevelopmentThe human readable filename of the artifact, typically generated during build and release processes. Often includes the package name and version in the filename
artifact.hash
DevelopmentThe full hash value (see glossary), often found in checksum.txt on a release of the artifact and used to verify package integrity.
artifact.purl
DevelopmentThe Package URL of the package artifact provides a standard way to identify and locate the packaged artifact.
artifact.version
DevelopmentThe version of the artifact.

deployment5 attributes

deployment.environment
Deprecated→ deployment.environment.nameDeprecated, use deployment.environment.name instead.
deployment.environment.name
StableName of the deployment environment (aka deployment tier).
deployment.id
DevelopmentThe ID of the deployment.
deployment.name
DevelopmentThe name of the deployment.
deployment.status
DevelopmentThe status of the deployment.

test4 attributes

test.case.name
DevelopmentThe fully qualified human readable name of the test case.
test.case.result.status
DevelopmentThe status of the actual test case result from test execution.
test.suite.name
DevelopmentThe human readable name of a test suite.
test.suite.run.status
DevelopmentThe status of the test suite run.

Recent changes

Breaking and notable changes to this domain across the last 6 semantic-conventions releases.

unitmetriccicd.worker.countUnit changed from {count} to {worker}.
stabilityattributecicd.pipeline.action.namePromoted to release_candidate.
stabilityattributecicd.pipeline.namePromoted to release_candidate.
stabilityattributecicd.pipeline.resultPromoted to release_candidate.
stabilitymetriccicd.pipeline.run.activePromoted to release_candidate.
stabilitymetriccicd.pipeline.run.durationPromoted to release_candidate.
stabilitymetriccicd.pipeline.run.errorsPromoted to release_candidate.
stabilityattributecicd.pipeline.run.idPromoted to release_candidate.
stabilityattributecicd.pipeline.run.statePromoted to release_candidate.
stabilityattributecicd.pipeline.run.url.fullPromoted to release_candidate.

39 more in the full release history

Topics are this site's grouping of upstream namespaces, not a structure the OpenTelemetry project publishes. JSON · All domains