diff --git a/.chloggen/update-pipeline-url-attributes.yaml b/.chloggen/update-pipeline-url-attributes.yaml new file mode 100644 index 000000000..8241ccfb5 --- /dev/null +++ b/.chloggen/update-pipeline-url-attributes.yaml @@ -0,0 +1,22 @@ +# Use this changelog template to create an entry for release notes. +# +# If your change doesn't affect end users you should instead start +# your pull request title with [chore] or use the "Skip Changelog" label. + +# One of 'breaking', 'deprecation', 'new_component', 'enhancement', 'bug_fix' +change_type: enhancement + +# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db) +component: cicd + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Adds a new attribute `cicd.pipeline.run.url.full` and corrects the attribute description of `cicd.pipeline.task.run.url.full` + +# Mandatory: One or more tracking issues related to the change. You can use the PR number here if no issue exists. +# The values here must be integers. +issues: [1796] + +# (Optional) One or more lines of additional information to render under the primary note. +# These lines will be padded with 2 spaces and then inserted directly into the document. +# Use pipe (|) for multiline entries. +subtext: diff --git a/docs/attributes-registry/cicd.md b/docs/attributes-registry/cicd.md index ce1e10976..e196286ca 100644 --- a/docs/attributes-registry/cicd.md +++ b/docs/attributes-registry/cicd.md @@ -13,9 +13,10 @@ This group describes attributes specific to pipelines within a Continuous Integr | `cicd.pipeline.result` | string | The result of a pipeline run. | `success`; `failure`; `timeout`; `skipped` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.pipeline.run.id` | string | The unique identifier of a pipeline run within a CI/CD system. | `120912` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.pipeline.run.state` | string | The pipeline run goes through these states during its lifecycle. | `pending`; `executing`; `finalizing` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `cicd.pipeline.run.url.full` | 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` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.pipeline.task.name` | string | The human readable name of a task within a pipeline. Task here most closely aligns with a [computing process](https://wikipedia.org/wiki/Pipeline_(computing)) in a pipeline. Other terms for tasks include commands, steps, and procedures. | `Run GoLang Linter`; `Go Build`; `go-test`; `deploy_binary` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.pipeline.task.run.id` | string | The unique identifier of a task run within a pipeline. | `12097` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `cicd.pipeline.task.run.url.full` | 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/job/26920038674?pr=1075` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `cicd.pipeline.task.run.url.full` | string | The [URL](https://wikipedia.org/wiki/URL) of the pipeline task run, providing the complete address in order to locate and identify the pipeline task run. | `https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.pipeline.task.type` | string | The type of the task within a pipeline. | `build`; `test`; `deploy` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.system.component` | string | The name of a component of the CICD system. | `controller`; `scheduler`; `agent` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `cicd.worker.state` | string | The state of a CICD worker / agent. | `idle`; `busy`; `down` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | diff --git a/model/cicd/registry.yaml b/model/cicd/registry.yaml index 4188bd1c5..4e109bb31 100644 --- a/model/cicd/registry.yaml +++ b/model/cicd/registry.yaml @@ -31,6 +31,16 @@ groups: brief: > The unique identifier of a pipeline run within a CI/CD system. examples: ["120912"] + - id: cicd.pipeline.run.url.full + type: string + stability: experimental + brief: > + The [URL](https://wikipedia.org/wiki/URL) of the pipeline run, + providing the complete address in order to locate and identify the pipeline run. + examples: + [ + "https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763?pr=1075", + ] - id: cicd.pipeline.run.state type: members: @@ -70,8 +80,8 @@ groups: type: string stability: experimental brief: > - The [URL](https://wikipedia.org/wiki/URL) of the pipeline run - providing the complete address in order to locate and identify the pipeline run. + The [URL](https://wikipedia.org/wiki/URL) of the pipeline task run, + providing the complete address in order to locate and identify the pipeline task run. examples: [ "https://github.com/open-telemetry/semantic-conventions/actions/runs/9753949763/job/26920038674?pr=1075",