From 5261f966ab4e4102eb454d19d21edc9c46a565a5 Mon Sep 17 00:00:00 2001 From: Florian Lehner Date: Tue, 29 Oct 2024 21:56:21 +0100 Subject: [PATCH] process.executable.build_id: rename attribute (#1520) Signed-off-by: Florian Lehner Co-authored-by: Liudmila Molkova --- .chloggen/profiling-htlhash.yaml | 22 +++++++++++++++++++ docs/attributes-registry/process.md | 3 ++- .../deprecated/registry-deprecated.yaml | 6 +++++ model/process/registry.yaml | 2 +- schema-next.yaml | 6 +++++ 5 files changed, 37 insertions(+), 2 deletions(-) create mode 100755 .chloggen/profiling-htlhash.yaml diff --git a/.chloggen/profiling-htlhash.yaml b/.chloggen/profiling-htlhash.yaml new file mode 100755 index 000000000..56655b695 --- /dev/null +++ b/.chloggen/profiling-htlhash.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: process.executable.build_id + +# A brief description of the change. Surround your text with quotes ("") if it needs to start with a backtick (`). +note: Rename process.executable.build_id.profiling to process.executable.build_id.htlhash. + +# 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: [1520] + +# (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: With https://github.com/open-telemetry/opentelemetry-specification/pull/4197 it was decided to rename the attribute profiling in process.executable.build_id to htlhash. diff --git a/docs/attributes-registry/process.md b/docs/attributes-registry/process.md index 202ec1b3e..40a795bd4 100644 --- a/docs/attributes-registry/process.md +++ b/docs/attributes-registry/process.md @@ -23,7 +23,7 @@ An operating system process. | `process.creation.time` | string | The date and time the process was created, in ISO 8601 format. | `2023-11-21T09:25:34.853Z` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `process.executable.build_id.gnu` | string | The GNU build ID as found in the `.note.gnu.build-id` ELF section (hex string). | `c89b11207f6479603b0d49bf291c092c2b719293` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `process.executable.build_id.go` | string | The Go build ID as retrieved by `go tool buildid `. | `foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | -| `process.executable.build_id.profiling` | string | Profiling specific build ID for executables. See the OTel specification for Profiles for more information. | `600DCAFE4A110000F2BF38C493F5FB92` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | +| `process.executable.build_id.htlhash` | string | Profiling specific build ID for executables. See the OTel specification for Profiles for more information. | `600DCAFE4A110000F2BF38C493F5FB92` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `process.executable.name` | string | The name of the process executable. On Linux based systems, can be set to the `Name` in `proc/[pid]/status`. On Windows, can be set to the base name of `GetProcessImageFileNameW`. | `otelcol` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `process.executable.path` | string | The full path to the process executable. On Linux based systems, can be set to the target of `proc/[pid]/exe`. On Windows, can be set to the result of `GetProcessImageFileNameW`. | `/usr/bin/cmd/otelcol` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | | `process.exit.code` | int | The exit code of the process. | `127` | ![Experimental](https://img.shields.io/badge/-experimental-blue) | @@ -75,6 +75,7 @@ Deprecated process attributes. | Attribute | Type | Description | Examples | Stability | |---|---|---|---|---| | `process.cpu.state` | string | Deprecated, use `cpu.mode` instead. | `system`; `user`; `wait` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `cpu.mode` | +| `process.executable.build_id.profiling` | string | "Deprecated, use `process.executable.build_id.htlhash` instead." | | ![Deprecated](https://img.shields.io/badge/-deprecated-red)
Replaced by `process.executable.build_id.htlhash` | `process.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. diff --git a/model/process/deprecated/registry-deprecated.yaml b/model/process/deprecated/registry-deprecated.yaml index 794167452..ffeb9f841 100644 --- a/model/process/deprecated/registry-deprecated.yaml +++ b/model/process/deprecated/registry-deprecated.yaml @@ -19,3 +19,9 @@ groups: value: 'wait' stability: experimental stability: experimental + - id: process.executable.build_id.profiling + stability: experimental + type: string + deprecated: 'Replaced by `process.executable.build_id.htlhash`' + brief: > + "Deprecated, use `process.executable.build_id.htlhash` instead." diff --git a/model/process/registry.yaml b/model/process/registry.yaml index 7b549d7bf..d2df832b2 100644 --- a/model/process/registry.yaml +++ b/model/process/registry.yaml @@ -53,7 +53,7 @@ groups: brief: > The Go build ID as retrieved by `go tool buildid `. examples: ['foh3mEXu7BLZjsN9pOwG/kATcXlYVCDEFouRMQed_/WwRFB1hPo9LBkekthSPG/x8hMC8emW2cCjXD0_1aY'] - - id: process.executable.build_id.profiling + - id: process.executable.build_id.htlhash stability: experimental type: string brief: > diff --git a/schema-next.yaml b/schema-next.yaml index 400ff09ac..7a0a8f578 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -2,6 +2,12 @@ file_format: 1.1.0 schema_url: https://opentelemetry.io/schemas/next versions: next: + all: + changes: + # https://github.com/open-telemetry/semantic-conventions/pull/1520 + - rename_attributes: + attribute_map: + process.executable.build_id.profiling: process.executable.build_id.htlhash 1.28.0: metrics: changes: