Add experimental stability tag to new fields

open-telemetry · Apr 5, 2024 · 25c54a3 · 25c54a3
1 parent 388bffb
commit 25c54a3
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 26 deletions.
diff --git a/docs/attributes-registry/process.md b/docs/attributes-registry/process.md
@@ -6,32 +6,32 @@
 ## Process Attributes
 
 <!-- semconv registry.process(omit_requirement_level) -->
-| Attribute  | Type | Description  | Examples  |
-|---|---|---|---|
-| `process.command` | string | The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in `proc/[pid]/cmdline`. On Windows, can be set to the first parameter extracted from `GetCommandLineW`. | `cmd/otelcol` |
-| `process.command_args` | string[] | All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be the full argv vector passed to `main`. | `[cmd/otecol, --config=config.yaml]` |
-| `process.command_line` | string | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead. | `C:\cmd\otecol --config="my directory\config.yaml"` |
-| `process.end` | string | The date and time the process ended, in ISO 8601 format. | `2023-11-21T09:26:12.315Z` |
-| `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` |
-| `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` |
-| `process.exit_code` | int | The exit code of the process. | `127` |
-| `process.group_leader.pid` | int | The PID of the process's group leader. This is also the process group ID (PGID) of the process. | `23` |
-| `process.interactive` | boolean | Whether the process is connected to an interactive shell. |  |
-| `process.owner` | string | The username of the user that owns the process. | `root` |
-| `process.parent_pid` | int | Parent Process identifier (PPID). | `111` |
-| `process.pid` | int | Process identifier (PID). | `1234` |
-| `process.real_user.id` | int | The real user ID (RUID) of the process. | `1000` |
-| `process.real_user.name` | string | The username of the real user of the process. | `operator` |
-| `process.runtime.description` | string | An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. | `Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0` |
-| `process.runtime.name` | string | The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler. | `OpenJDK Runtime Environment` |
-| `process.runtime.version` | string | The version of the runtime of this process, as returned by the runtime without modification. | `14.0.2` |
-| `process.saved_user.id` | int | The saved user ID (SUID) of the process. | `1002` |
-| `process.saved_user.name` | string | The username of the saved user. | `operator` |
-| `process.session_leader.pid` | int | The PID of the process's session leader. This is also the session ID (SID) of the process. | `14` |
-| `process.start` | string | The date and time the process started, in ISO 8601 format. | `2023-11-21T09:25:34.853Z` |
-| `process.user.id` | int | The effective user ID (EUID) of the process. | `1001` |
-| `process.user.name` | string | The username of the effective user of the process. | `root` |
-| `process.vpid` | int | Virtual process identifier. [1] | `12` |
+| Attribute  | Type | Description  | Examples  | Stability |
+|---|---|---|---|---|
+| `process.command` | string | The command used to launch the process (i.e. the command name). On Linux based systems, can be set to the zeroth string in `proc/[pid]/cmdline`. On Windows, can be set to the first parameter extracted from `GetCommandLineW`. | `cmd/otelcol` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.command_args` | string[] | All the command arguments (including the command/executable itself) as received by the process. On Linux-based systems (and some other Unixoid systems supporting procfs), can be set according to the list of null-delimited strings extracted from `proc/[pid]/cmdline`. For libc-based executables, this would be the full argv vector passed to `main`. | `[cmd/otecol, --config=config.yaml]` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.command_line` | string | The full command used to launch the process as a single string representing the full command. On Windows, can be set to the result of `GetCommandLineW`. Do not set this if you have to assemble it just for monitoring; use `process.command_args` instead. | `C:\cmd\otecol --config="my directory\config.yaml"` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.end` | string | The date and time the process ended, in ISO 8601 format. | `2023-11-21T09:26:12.315Z` | ![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) |
+| `process.group_leader.pid` | int | The PID of the process's group leader. This is also the process group ID (PGID) of the process. | `23` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.interactive` | boolean | Whether the process is connected to an interactive shell. |  | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.owner` | string | The username of the user that owns the process. | `root` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.parent_pid` | int | Parent Process identifier (PPID). | `111` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.pid` | int | Process identifier (PID). | `1234` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.real_user.id` | int | The real user ID (RUID) of the process. | `1000` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.real_user.name` | string | The username of the real user of the process. | `operator` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.runtime.description` | string | An additional description about the runtime of the process, for example a specific vendor customization of the runtime environment. | `Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.runtime.name` | string | The name of the runtime of this process. For compiled native binaries, this SHOULD be the name of the compiler. | `OpenJDK Runtime Environment` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.runtime.version` | string | The version of the runtime of this process, as returned by the runtime without modification. | `14.0.2` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.saved_user.id` | int | The saved user ID (SUID) of the process. | `1002` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.saved_user.name` | string | The username of the saved user. | `operator` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.session_leader.pid` | int | The PID of the process's session leader. This is also the session ID (SID) of the process. | `14` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.start` | string | The date and time the process started, in ISO 8601 format. | `2023-11-21T09:25:34.853Z` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.user.id` | int | The effective user ID (EUID) of the process. | `1001` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.user.name` | string | The username of the effective user of the process. | `root` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
+| `process.vpid` | int | Virtual process identifier. [1] | `12` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
 
 **[1]:** The process ID within a PID namespace. This is not necessarily unique across all processes on the host but it is unique within the process namespace that the process exists within.
 <!-- endsemconv -->
diff --git a/model/registry/process.yaml b/model/registry/process.yaml
@@ -19,6 +19,7 @@ groups:
         examples: [111]
       - id: vpid
         type: int
+        stability: experimental
         brief: >
           Virtual process identifier.
         note: >
@@ -28,12 +29,14 @@ groups:
         examples: [12]
       - id: session_leader.pid
         type: int
+        stability: experimental
         brief: >
           The PID of the process's session leader. This is also the session ID
           (SID) of the process.
         examples: [14]
       - id: group_leader.pid
         type: int
+        stability: experimental
         brief: >
           The PID of the process's group leader. This is also the process group
           ID (PGID) of the process.
@@ -89,31 +92,37 @@ groups:
         examples: ['root']
       - id: user.id
         type: int
+        stability: experimental
         brief: >
           The effective user ID (EUID) of the process.
         examples: [1001]
       - id: user.name
         type: string
+        stability: experimental
         brief: >
           The username of the effective user of the process.
         examples: ['root']
       - id: real_user.id
         type: int
+        stability: experimental
         brief: >
           The real user ID (RUID) of the process.
         examples: [1000]
       - id: real_user.name
         type: string
+        stability: experimental
         brief: >
           The username of the real user of the process.
         examples: ['operator']
       - id: saved_user.id
         type: int
+        stability: experimental
         brief: >
           The saved user ID (SUID) of the process.
         examples: [1002]
       - id: saved_user.name
         type: string
+        stability: experimental
         brief: >
           The username of the saved user.
         examples: ['operator']
@@ -140,20 +149,24 @@ groups:
         examples: 'Eclipse OpenJ9 Eclipse OpenJ9 VM openj9-0.21.0'
       - id: start
         type: string
+        stability: experimental
         brief: >
           The date and time the process started, in ISO 8601 format.
         examples: ['2023-11-21T09:25:34.853Z']
       - id: end
         type: string
+        stability: experimental
         brief: >
           The date and time the process ended, in ISO 8601 format.
         examples: ['2023-11-21T09:26:12.315Z']
       - id: exit_code
         type: int
+        stability: experimental
         brief: >
           The exit code of the process.
         examples: [127]
       - id: interactive
         type: boolean
+        stability: experimental
         brief: >
           Whether the process is connected to an interactive shell.