Improve cicd worker description (#2590)

Author: kamphaus

.chloggen/1191.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: Improve the description of `cicd.worker` entities.
+
+# 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: [1191]
+
+# (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:

docs/registry/entities/cicd.md

@@ -47,6 +47,8 @@
 **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:**
 

docs/resource/cicd.md

@@ -94,6 +94,8 @@ Using the CICD pipeline run resource with metrics inherently causes high cardina
 **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.
 
 | Attribute  | Type | Description  | Examples  | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
 |---|---|---|---|---|---|

model/cicd/entities.yaml

@@ -24,6 +24,13 @@ groups:
     name: cicd.worker
     brief: >
       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.
     attributes:
       - ref: cicd.worker.id
         requirement_level: required