semantic-conventions/docs/registry/entities/cicd.md

4.1 KiB

CICD

CICD Pipeline

Status: Development

type: cicd.pipeline

Description: A pipeline is a series of automated steps that helps software teams deliver code.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
cicd.pipeline.name string The human readable name of the pipeline within a CI/CD system. Build and Test; Lint; Deploy Go Project; deploy_to_environment Recommended Development

CICD Pipeline Run

Status: Development

type: cicd.pipeline.run

Description: A pipeline run is a singular execution of a given pipeline's tasks.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
cicd.pipeline.run.id string The unique identifier of a pipeline run within a CI/CD system. 120912 Recommended Development
cicd.pipeline.run.url.full string The URL of the pipeline run, providing the complete address in order to locate and identify the pipeline run. https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075 Recommended Development

CICD Worker

Status: Development

type: cicd.worker

Description: A CICD worker is a component of the CICD system that performs work (eg. running pipeline tasks or performing sync). A single pipeline run may be distributed across multiple workers. Any OpenTelemetry signal associated with a worker should be associated to the worker that performed the corresponding work. For example, when a pipeline run involves several workers, its task run spans may reference the different cicd.worker resources corresponding to the workers that executed each task run. The pipeline run's parent span may instead reference the CICD controller as the cicd.worker resource.

Other Attributes:

⚠️ This entity definition contains attributes without a role. Stable Entities MUST NOT have attributes without a defined role.

Attribute Type Description Examples Requirement Level Stability
cicd.worker.id string The unique identifier of a worker within a CICD system. abc123; 10.0.1.2; controller Required Development
cicd.worker.name string The name of a worker within a CICD system. agent-abc; controller; Ubuntu LTS Recommended Development
cicd.worker.url.full string The URL of the worker, providing the complete address in order to locate and identify the worker. https://cicd.example.org/worker/abc123 Recommended If available Development