64 lines
3.6 KiB
Markdown
64 lines
3.6 KiB
Markdown
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
|
|
<!-- see templates/registry/markdown/entity_namespace.md.j2 -->
|
|
<!-- markdownlint-capture -->
|
|
<!-- markdownlint-disable -->
|
|
|
|
# CICD
|
|
|
|
## CICD Pipeline
|
|
|
|
**Status:** 
|
|
|
|
**type:** `cicd.pipeline`
|
|
|
|
**Description:** A pipeline is a series of automated steps that helps software teams deliver code.
|
|
|
|
**Other Attributes:**
|
|
|
|
> :warning: This entity definition contains attributes without a role.
|
|
> Stable Entities MUST NOT have attributes without a defined role.
|
|
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`cicd.pipeline.name`](/docs/registry/attributes/cicd.md) | string | The human readable name of the pipeline within a CI/CD system. | `Build and Test`; `Lint`; `Deploy Go Project`; `deploy_to_environment` | `Recommended` |  |
|
|
|
|
## CICD Pipeline Run
|
|
|
|
**Status:** 
|
|
|
|
**type:** `cicd.pipeline.run`
|
|
|
|
**Description:** A pipeline run is a singular execution of a given pipeline's tasks.
|
|
|
|
**Other Attributes:**
|
|
|
|
> :warning: This entity definition contains attributes without a role.
|
|
> Stable Entities MUST NOT have attributes without a defined role.
|
|
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`cicd.pipeline.run.id`](/docs/registry/attributes/cicd.md) | string | The unique identifier of a pipeline run within a CI/CD system. | `120912` | `Recommended` |  |
|
|
| [`cicd.pipeline.run.url.full`](/docs/registry/attributes/cicd.md) | string | The [URL](https://wikipedia.org/wiki/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` |  |
|
|
|
|
## CICD Worker
|
|
|
|
**Status:** 
|
|
|
|
**type:** `cicd.worker`
|
|
|
|
**Description:** A CICD worker is a component of the CICD system that performs work (eg. running pipeline tasks or performing sync).
|
|
|
|
**Other Attributes:**
|
|
|
|
> :warning: This entity definition contains attributes without a role.
|
|
> Stable Entities MUST NOT have attributes without a defined role.
|
|
|
|
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
|
|
|---|---|---|---|---|---|
|
|
| [`cicd.worker.id`](/docs/registry/attributes/cicd.md) | string | The unique identifier of a worker within a CICD system. | `abc123`; `10.0.1.2`; `controller` | `Required` |  |
|
|
| [`cicd.worker.name`](/docs/registry/attributes/cicd.md) | string | The name of a worker within a CICD system. | `agent-abc`; `controller`; `Ubuntu LTS` | `Recommended` |  |
|
|
| [`cicd.worker.url.full`](/docs/registry/attributes/cicd.md) | string | The [URL](https://wikipedia.org/wiki/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 |  |
|
|
|
|
|
|
<!-- markdownlint-restore -->
|