Merge branch 'main' into messaging-span-kinds

pyohannes · Jul 8, 2024 · fe87b8b · fe87b8b
2 parents ac1276d + 5971366
commit fe87b8b
Show file tree

Hide file tree

Showing 60 changed files with 1,324 additions and 224 deletions.
diff --git a/.chloggen/1102.yaml b/.chloggen/1102.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: gen-ai
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Add GenAI model server metrics for measuring LLM serving latency
+
+# 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: [1102]
+
+# (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/.chloggen/1155.yaml b/.chloggen/1155.yaml
@@ -0,0 +1,4 @@
+change_type: bug_fix
+component: messaging
+note: Update Kafka Spring example to align with the messaging spec
+issues: [ 1155 ]
diff --git a/.chloggen/1165.yaml b/.chloggen/1165.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: db
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Clarify that `db.query.parameter.<key>` is string representation of the parameter value
+
+# 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: [ 1165 ]
+
+# (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/.chloggen/1169.yaml b/.chloggen/1169.yaml
@@ -0,0 +1,4 @@
+change_type: enhancement
+component: messaging
+note: Define sampling relevant attributes for messaging client spans
+issues: [ 432, 1169 ]
diff --git a/.chloggen/1200.yaml b/.chloggen/1200.yaml
@@ -0,0 +1,6 @@
+change_type: enhancement
+component: gen_ai
+note: >
+  Rename `gen_ai.usage.prompt_tokens` to `gen_ai.usage.input_tokens` and `gen_ai.usage.completion_tokens` to `gen_ai.usage.output_tokens`
+  to align terminology between spans and metrics.
+issues: [ 1200 ]
diff --git a/.chloggen/db_sanitization.yaml b/.chloggen/db_sanitization.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: db
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Specify sanitization for `db.query.text`.
+
+# 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: [717]
+
+# (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/.chloggen/merge_cpu_states.yaml b/.chloggen/merge_cpu_states.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: breaking
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: system
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Rename `process.cpu.state`, `container.cpu.state`, and `system.cpu.state` attributes into a common `cpu.mode` attribute
+
+# 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: [840]
+
+# (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/.chloggen/nodejs-metrics.yaml b/.chloggen/nodejs-metrics.yaml
@@ -0,0 +1,17 @@
+# 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: new_component
+
+# The name of the area of concern in the attributes-registry, (e.g. http, cloud, db)
+component: nodejs
+
+# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`).
+note: Introducing semantic conventions for Node.js runtime metrics.
+
+# 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: [990]
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -28,6 +28,7 @@ body:
         - area:cloudevents
         - area:code
         - area:container
+        - area:cpu
         - area:db
         - area:deployment
         - area:destination

diff --git a/.github/ISSUE_TEMPLATE/change_proposal.yaml b/.github/ISSUE_TEMPLATE/change_proposal.yaml
@@ -21,6 +21,7 @@ body:
         - area:cloudevents
         - area:code
         - area:container
+        - area:cpu
         - area:db
         - area:deployment
         - area:destination

diff --git a/.github/ISSUE_TEMPLATE/new-conventions.yaml b/.github/ISSUE_TEMPLATE/new-conventions.yaml
@@ -30,6 +30,7 @@ body:
         - area:cloudevents
         - area:code
         - area:container
+        - area:cpu
         - area:db
         - area:deployment
         - area:destination

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -26,7 +26,7 @@
 - `device.app.lifecycle`: Reformat and update the `device.app.lifecycle` event description adds constraints for the possible values of the `android.state` and `ios.state`.
  (#794)
   Removes the `ios.lifecycle.events` and `android.lifecycle.events` attributes from the global registry and adds constraints for the possible values of the `android.state` and `ios.state` attributes.
-  
+
 - `messaging`: Rename `messaging.client_id` to `messaging.client.id` (#935)
 - `rpc`: Rename`message.*` attributes under `rpc` to `rpc.message.*`. Deprecate old `message.*` attributes. (#854)
 
@@ -51,7 +51,7 @@
   The entirety of the registry now is generated using weaver with templates
   under the `templates/` directory.  Snippets still require a hardcoded
   command.
-  
+
 - `http`: List all HTTP client and server attributes in the corresponding table, remove common attributes from yaml and markdown. (#928)
 - `other`: Document patterns and suggestions for semconv code generation. (#551, #953)
 - `db`: Show applicable common attributes in individual database semantic conventions. (#973)
@@ -72,14 +72,6 @@
 - `net`: Add previously deprecated net attributes to registry (#1029)
   These attributes were deprecated in 1.13
 
-## Unreleased
-
-### Breaking
-
-### Features
-
-### Fixes
-
 ## v1.25.0
 
 ### 🛑 Breaking changes 🛑

diff --git a/Makefile b/Makefile
@@ -14,7 +14,7 @@ CHLOGGEN_CONFIG  := .chloggen/config.yaml
 # see https://github.com/open-telemetry/build-tools/releases for semconvgen updates
 # Keep links in model/README.md and .vscode/settings.json in sync!
 SEMCONVGEN_VERSION=0.24.0
-WEAVER_VERSION=0.2.0
+WEAVER_VERSION=0.5.0
 
 # From where to resolve the containers (e.g. "otel/weaver").
 CONTAINER_REPOSITORY=docker.io

diff --git a/docs/attributes-registry/README.md b/docs/attributes-registry/README.md
@@ -40,6 +40,7 @@ Currently, the following namespaces exist:
 - [CloudEvents](cloudevents.md)
 - [Code](code.md)
 - [Container](container.md)
+- [CPU](cpu.md)
 - [Db](db.md)
 - [Deployment](deployment.md)
 - [Destination](destination.md)

diff --git a/docs/attributes-registry/container.md b/docs/attributes-registry/container.md
@@ -18,7 +18,6 @@ A container instance.
 | `container.command`            | string   | The command used to run the container (i.e. the command name). [1]                                                                                                                                                                                                      | `otelcontribcol`                                                                                                                                                                                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `container.command_args`       | string[] | All the command arguments (including the command/executable itself) run by the container. [2]                                                                                                                                                                           | `["otelcontribcol, --config, config.yaml"]`                                                                                                                                                                 | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `container.command_line`       | string   | The full command run by the container as a single string representing the full command. [2]                                                                                                                                                                             | `otelcontribcol --config config.yaml`                                                                                                                                                                       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `container.cpu.state`          | string   | The CPU state for this data point.                                                                                                                                                                                                                                      | `user`; `kernel`                                                                                                                                                                                            | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `container.id`                 | string   | Container ID. Usually a UUID, as for example used to [identify Docker containers](https://docs.docker.com/engine/reference/run/#container-identification). The UUID might be abbreviated.                                                                               | `a3bf90e006b2`                                                                                                                                                                                              | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `container.image.id`           | string   | Runtime specific image identifier. Usually a hash algorithm followed by a UUID. [2]                                                                                                                                                                                     | `sha256:19c92d0a00d1b66d897bceaa7319bee0dd38a10a851c60bcec9474aa3f01e50f`                                                                                                                                   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 | `container.image.name`         | string   | Name of the image the container was built on.                                                                                                                                                                                                                           | `gcr.io/opentelemetry/operator`                                                                                                                                                                             | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
@@ -36,18 +35,19 @@ The ID is assigned by the container runtime and can vary in different environmen
 
 **[3]:** [Docker](https://docs.docker.com/engine/api/v1.43/#tag/Image/operation/ImageInspect) and [CRI](https://github.com/kubernetes/cri-api/blob/c75ef5b473bbe2d0a4fc92f82235efd665ea8e9f/pkg/apis/runtime/v1/api.proto#L1237-L1238) report those under the `RepoDigests` field.
 
-`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
-
-| Value    | Description                                                                                                     | Stability                                                        |
-| -------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
-| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `system` | When CPU is used by the system (host OS)                                                                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-| `user`   | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows).     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
-
 ## Container Deprecated Attributes
 
 Describes deprecated container attributes.
 
 | Attribute                | Type   | Description                                | Examples                    | Stability                                                                                     |
 | ------------------------ | ------ | ------------------------------------------ | --------------------------- | --------------------------------------------------------------------------------------------- |
+| `container.cpu.state`    | string | Deprecated, use `cpu.mode` instead.        | `user`; `kernel`            | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `cpu.mode`         |
 | `container.labels.<key>` | string | Deprecated, use `container.label` instead. | `container.label.app=nginx` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `container.label`. |
+
+`container.cpu.state` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
+
+| Value    | Description                                                                                                     | Stability                                                        |
+| -------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- |
+| `kernel` | When tasks of the cgroup are in kernel mode (Linux). When all container processes are in kernel mode (Windows). | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `system` | When CPU is used by the system (host OS)                                                                        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `user`   | When tasks of the cgroup are in user mode (Linux). When all container processes are in user mode (Windows).     | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
diff --git a/docs/attributes-registry/cpu.md b/docs/attributes-registry/cpu.md
@@ -0,0 +1,28 @@
+<!--- Hugo front matter used to generate the website version of this page:
+--->
+
+<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
+<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
+
+# CPU
+
+## CPU Attributes
+
+Attributes specific to a cpu instance.
+
+| Attribute  | Type   | Description         | Examples         | Stability                                                        |
+| ---------- | ------ | ------------------- | ---------------- | ---------------------------------------------------------------- |
+| `cpu.mode` | string | The mode of the CPU | `user`; `system` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+
+`cpu.mode` has the following list of well-known values. If one of them applies, then the respective value MUST be used; otherwise, a custom value MAY be used.
+
+| Value       | Description | Stability                                                        |
+| ----------- | ----------- | ---------------------------------------------------------------- |
+| `idle`      | idle        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `interrupt` | interrupt   | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `iowait`    | iowait      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `kernel`    | kernel      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `nice`      | nice        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `steal`     | steal       | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `system`    | system      | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `user`      | user        | ![Experimental](https://img.shields.io/badge/-experimental-blue) |