From 5fcccef458adfe5245c97612789e92f8f0e66f3d Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Thu, 2 Nov 2023 09:15:07 +0000 Subject: [PATCH 1/7] Rename system.processes.* namespace to system.process.* Signed-off-by: ChrsMark --- docs/system/system-metrics.md | 24 ++++++++++++------------ model/metrics/system-metrics.yaml | 16 ++++++++-------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 14254bf534..aa741f16b8 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -50,8 +50,8 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam * [Metric: `system.network.io`](#metric-systemnetworkio) * [Metric: `system.network.connections`](#metric-systemnetworkconnections) - [Aggregate System Process Metrics](#aggregate-system-process-metrics) - * [Metric: `system.processes.count`](#metric-systemprocessescount) - * [Metric: `system.processes.created`](#metric-systemprocessescreated) + * [Metric: `system.process.count`](#metric-systemprocessescount) + * [Metric: `system.process.created_total`](#metric-systemprocessescreated) - [`system.{os}.` - OS Specific System Metrics](#systemos---os-specific-system-metrics) * [Metric: `system.linux.memory.available`](#metric-systemlinuxmemoryavailable) @@ -684,22 +684,22 @@ different processes could be listening on TCP port 12345 and UDP port 12345. **Description:** System level aggregate process metrics captured under the namespace `system.process`. For metrics at the individual process level, see [process metrics](process-metrics.md). -### Metric: `system.processes.count` +### Metric: `system.process.count` This metric is [recommended][MetricRecommended]. - + | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `system.processes.count` | UpDownCounter | `{process}` | Total number of processes in each state | +| `system.process.count` | UpDownCounter | `{process}` | Total number of processes in each state | - + | Attribute | Type | Description | Examples | Requirement Level | |---|---|---|---|---| -| `system.processes.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | Recommended | +| `system.process.status` | string | The process state, e.g., [Linux Process State Codes](https://man7.org/linux/man-pages/man1/ps.1.html#PROCESS_STATE_CODES) | `running` | Recommended | -`system.processes.status` 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. +`system.process.status` 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 | |---|---| @@ -709,17 +709,17 @@ This metric is [recommended][MetricRecommended]. | `defunct` | defunct | -### Metric: `system.processes.created` +### Metric: `system.process.created_total` This metric is [recommended][MetricRecommended]. - + | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `system.processes.created` | Counter | `{process}` | Total number of processes created over uptime of the host | +| `system.process.created_total` | Counter | `{process}` | Total number of processes created over uptime of the host | - + ## `system.{os}.` - OS Specific System Metrics diff --git a/model/metrics/system-metrics.yaml b/model/metrics/system-metrics.yaml index eb69d3f992..44e288c7bc 100644 --- a/model/metrics/system-metrics.yaml +++ b/model/metrics/system-metrics.yaml @@ -452,9 +452,9 @@ groups: - ref: system.network.state - ref: network.transport - # system.processes.* metrics and attribute group - - id: attributes.system.processes - prefix: system.processes + # system.process.* metrics and attribute group + - id: attributes.system.process + prefix: system.process type: attribute_group brief: "Describes System Process metric attributes" attributes: @@ -475,18 +475,18 @@ groups: examples: ["running"] - - id: metric.system.processes.count + - id: metric.system.process.count type: metric - metric_name: system.processes.count + metric_name: system.process.count brief: "Total number of processes in each state" instrument: updowncounter unit: "{process}" attributes: - - ref: system.processes.status + - ref: system.process.status - - id: metric.system.processes.created + - id: metric.system.process.created_total type: metric - metric_name: system.processes.created + metric_name: system.process.created_total brief: "Total number of processes created over uptime of the host" instrument: counter unit: "{process}" From b572e1d042549bd8e841aa64097927277eab590b Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Thu, 2 Nov 2023 09:28:17 +0000 Subject: [PATCH 2/7] Add changelog and schema-next entries Signed-off-by: ChrsMark --- CHANGELOG.md | 4 ++++ schema-next.yaml | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e1382e9c0d..effe211c79 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,6 +28,10 @@ release. ([#429](https://github.com/open-telemetry/semantic-conventions/pull/429)) - Use seconds as default duration for FaaS duration histograms ([#384](https://github.com/open-telemetry/semantic-conventions/pull/384)) +- Rename `system.processes.*` namespace to `system.process.*` + ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) +- Rename `system.processes.created` to `system.process.created_total` + ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) ### Features diff --git a/schema-next.yaml b/schema-next.yaml index 4c3647ce4d..31bc111462 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -10,6 +10,15 @@ versions: thread.daemon: jvm.thread.daemon apply_to_metrics: - jvm.thread.count + # https://github.com/open-telemetry/semantic-conventions/pull/484 + - rename_attributes: + attribute_map: + system.processes.status: system.process.status + apply_to_metrics: + - system.processes.count + - rename_metrics: + system.processes.count: system.process.count + system.processes.created: system.process.created_total 1.22.0: spans: changes: From 3ea59ebf550a5a7c629ac9aefcb2c5982442abca Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Thu, 2 Nov 2023 10:39:54 +0000 Subject: [PATCH 3/7] fix links Signed-off-by: ChrsMark --- docs/system/system-metrics.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 5ca3d40e75..67a76a8229 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -52,8 +52,8 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam * [Metric: `system.network.io`](#metric-systemnetworkio) * [Metric: `system.network.connections`](#metric-systemnetworkconnections) - [Aggregate System Process Metrics](#aggregate-system-process-metrics) - * [Metric: `system.process.count`](#metric-systemprocessescount) - * [Metric: `system.process.created_total`](#metric-systemprocessescreated) + * [Metric: `system.process.count`](#metric-systemprocesscount) + * [Metric: `system.process.created_total`](#metric-systemprocesscreated_total) - [`system.{os}.` - OS Specific System Metrics](#systemos---os-specific-system-metrics) * [Metric: `system.linux.memory.available`](#metric-systemlinuxmemoryavailable) From 2521a0c7644651af41a089316bd3543d2f1eb443 Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Mon, 27 Nov 2023 08:13:44 +0000 Subject: [PATCH 4/7] Rename to system.process.created.count Signed-off-by: ChrsMark --- CHANGELOG.md | 2 +- docs/system/system-metrics.md | 8 ++++---- model/metrics/system-metrics.yaml | 4 ++-- schema-next.yaml | 2 +- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 911ae94ec5..054dcdc94d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -93,7 +93,7 @@ stabilized. ([#479](https://github.com/open-telemetry/semantic-conventions/pull/479)) - Rename `system.processes.*` namespace to `system.process.*` ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) -- Rename `system.processes.created` to `system.process.created_total` +- Rename `system.processes.created` to `system.process.created.count` ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) - Change sampling relevant from `MUST` to `SHOULD` ([#486](https://github.com/open-telemetry/semantic-conventions/pull/486)) diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 35100630b3..7a8161decc 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -743,17 +743,17 @@ This metric is [recommended][MetricRecommended]. | `defunct` | defunct | -### Metric: `system.process.created_total` +### Metric: `system.process.created.count` This metric is [recommended][MetricRecommended]. - + | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `system.process.created_total` | Counter | `{process}` | Total number of processes created over uptime of the host | +| `system.process.created.count` | Counter | `{process}` | Total number of processes created over uptime of the host | - + ## `system.{os}.` - OS Specific System Metrics diff --git a/model/metrics/system-metrics.yaml b/model/metrics/system-metrics.yaml index d43b25932f..b8e27fa5ed 100644 --- a/model/metrics/system-metrics.yaml +++ b/model/metrics/system-metrics.yaml @@ -479,9 +479,9 @@ groups: attributes: - ref: system.process.status - - id: metric.system.process.created_total + - id: metric.system.process.created.count type: metric - metric_name: system.process.created_total + metric_name: system.process.created.count brief: "Total number of processes created over uptime of the host" instrument: counter unit: "{process}" diff --git a/schema-next.yaml b/schema-next.yaml index 70f419e246..51259e9a81 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -23,7 +23,7 @@ versions: - system.processes.count - rename_metrics: system.processes.count: system.process.count - system.processes.created: system.process.created_total + system.processes.created: system.process.created.count 1.22.0: spans: changes: From 141823e00dd5f9e6a1dc869f8d47c3ce8a595e35 Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Tue, 28 Nov 2023 12:27:56 +0000 Subject: [PATCH 5/7] Remove .count suffix Signed-off-by: ChrsMark --- CHANGELOG.md | 2 +- docs/system/system-metrics.md | 10 +++++----- model/metrics/system-metrics.yaml | 4 ++-- schema-next.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 054dcdc94d..305ee30267 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -93,7 +93,7 @@ stabilized. ([#479](https://github.com/open-telemetry/semantic-conventions/pull/479)) - Rename `system.processes.*` namespace to `system.process.*` ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) -- Rename `system.processes.created` to `system.process.created.count` +- Rename `system.processes.created` to `system.process.created` ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) - Change sampling relevant from `MUST` to `SHOULD` ([#486](https://github.com/open-telemetry/semantic-conventions/pull/486)) diff --git a/docs/system/system-metrics.md b/docs/system/system-metrics.md index 7a8161decc..59dd808491 100644 --- a/docs/system/system-metrics.md +++ b/docs/system/system-metrics.md @@ -53,7 +53,7 @@ Resource attributes related to a host, SHOULD be reported under the `host.*` nam * [Metric: `system.network.connections`](#metric-systemnetworkconnections) - [Aggregate System Process Metrics](#aggregate-system-process-metrics) * [Metric: `system.process.count`](#metric-systemprocesscount) - * [Metric: `system.process.created_total`](#metric-systemprocesscreated_total) + * [Metric: `system.process.created`](#metric-systemprocesscreated) - [`system.{os}.` - OS Specific System Metrics](#systemos---os-specific-system-metrics) * [Metric: `system.linux.memory.available`](#metric-systemlinuxmemoryavailable) @@ -743,17 +743,17 @@ This metric is [recommended][MetricRecommended]. | `defunct` | defunct | -### Metric: `system.process.created.count` +### Metric: `system.process.created` This metric is [recommended][MetricRecommended]. - + | Name | Instrument Type | Unit (UCUM) | Description | | -------- | --------------- | ----------- | -------------- | -| `system.process.created.count` | Counter | `{process}` | Total number of processes created over uptime of the host | +| `system.process.created` | Counter | `{process}` | Total number of processes created over uptime of the host | - + ## `system.{os}.` - OS Specific System Metrics diff --git a/model/metrics/system-metrics.yaml b/model/metrics/system-metrics.yaml index b8e27fa5ed..9f288e87ff 100644 --- a/model/metrics/system-metrics.yaml +++ b/model/metrics/system-metrics.yaml @@ -479,9 +479,9 @@ groups: attributes: - ref: system.process.status - - id: metric.system.process.created.count + - id: metric.system.process.created type: metric - metric_name: system.process.created.count + metric_name: system.process.created brief: "Total number of processes created over uptime of the host" instrument: counter unit: "{process}" diff --git a/schema-next.yaml b/schema-next.yaml index 51259e9a81..6a61314ad1 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -23,7 +23,7 @@ versions: - system.processes.count - rename_metrics: system.processes.count: system.process.count - system.processes.created: system.process.created.count + system.processes.created: system.process.created 1.22.0: spans: changes: From 44c67d217d9a20aec1ea68f2af02b1f7e3c46b0d Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Tue, 28 Nov 2023 15:20:31 +0000 Subject: [PATCH 6/7] Remove extra changelog entry Signed-off-by: ChrsMark --- CHANGELOG.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 305ee30267..2cdf5b1acd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -93,8 +93,6 @@ stabilized. ([#479](https://github.com/open-telemetry/semantic-conventions/pull/479)) - Rename `system.processes.*` namespace to `system.process.*` ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) -- Rename `system.processes.created` to `system.process.created` - ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) - Change sampling relevant from `MUST` to `SHOULD` ([#486](https://github.com/open-telemetry/semantic-conventions/pull/486)) - Make `user_agent.original` and `http.request.header.*` sampling relevant From 96af48102f1657be2460b394981bca2021b8e4bf Mon Sep 17 00:00:00 2001 From: ChrsMark Date: Tue, 19 Dec 2023 18:02:11 +0000 Subject: [PATCH 7/7] Fix changelog and schema Signed-off-by: ChrsMark --- CHANGELOG.md | 5 +++-- schema-next.yaml | 20 +++++++++++--------- 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c6b93d686b..6b62c84eb6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,9 @@ release. ### Breaking +- Rename `system.processes.*` namespace to `system.process.*` + ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) + ### Features ### Fixes @@ -144,8 +147,6 @@ stabilized. ([#478](https://github.com/open-telemetry/semantic-conventions/pull/478)) - Remove outdated `http.request.header.host` guidance ([#479](https://github.com/open-telemetry/semantic-conventions/pull/479)) -- Rename `system.processes.*` namespace to `system.process.*` - ([#484](https://github.com/open-telemetry/semantic-conventions/pull/484)) - Change sampling relevant from `MUST` to `SHOULD` ([#486](https://github.com/open-telemetry/semantic-conventions/pull/486)) - Make `user_agent.original` and `http.request.header.*` sampling relevant diff --git a/schema-next.yaml b/schema-next.yaml index ee67a445b1..aca72805d2 100644 --- a/schema-next.yaml +++ b/schema-next.yaml @@ -2,6 +2,17 @@ file_format: 1.1.0 schema_url: https://opentelemetry.io/schemas/next versions: next: + metrics: + changes: + # https://github.com/open-telemetry/semantic-conventions/pull/484 + - rename_attributes: + attribute_map: + system.processes.status: system.process.status + apply_to_metrics: + - system.processes.count + - rename_metrics: + system.processes.count: system.process.count + system.processes.created: system.process.created 1.24.0: metrics: changes: @@ -24,15 +35,6 @@ versions: thread.daemon: jvm.thread.daemon apply_to_metrics: - jvm.thread.count - # https://github.com/open-telemetry/semantic-conventions/pull/484 - - rename_attributes: - attribute_map: - system.processes.status: system.process.status - apply_to_metrics: - - system.processes.count - - rename_metrics: - system.processes.count: system.process.count - system.processes.created: system.process.created 1.22.0: spans: changes: