Skip to content

Commit

Permalink
Rename system.processes.* namespace to system.process.* (open-telemet…
Browse files Browse the repository at this point in the history
…ry#484)

Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Co-authored-by: Joao Grassi <joao.grassi@dynatrace.com>
  • Loading branch information
2 people authored and pyohannes committed Jan 17, 2024
1 parent 382c882 commit 8d1507f
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 20 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
24 changes: 12 additions & 12 deletions docs/system/system-metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.processes.count`](#metric-systemprocessescount)
* [Metric: `system.processes.created`](#metric-systemprocessescreated)
* [Metric: `system.process.count`](#metric-systemprocesscount)
* [Metric: `system.process.created`](#metric-systemprocesscreated)
- [`system.{os}.` - OS Specific System Metrics](#systemos---os-specific-system-metrics)
* [Metric: `system.linux.memory.available`](#metric-systemlinuxmemoryavailable)

Expand Down Expand Up @@ -718,22 +718,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].

<!-- semconv metric.system.processes.count(metric_table) -->
<!-- semconv metric.system.process.count(metric_table) -->
| 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 |
<!-- endsemconv -->

<!-- semconv metric.system.processes.count(full) -->
<!-- semconv metric.system.process.count(full) -->
| 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 |
|---|---|
Expand All @@ -743,17 +743,17 @@ This metric is [recommended][MetricRecommended].
| `defunct` | defunct |
<!-- endsemconv -->

### Metric: `system.processes.created`
### Metric: `system.process.created`

This metric is [recommended][MetricRecommended].

<!-- semconv metric.system.processes.created(metric_table) -->
<!-- semconv metric.system.process.created(metric_table) -->
| Name | Instrument Type | Unit (UCUM) | Description |
| -------- | --------------- | ----------- | -------------- |
| `system.processes.created` | 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 |
<!-- endsemconv -->

<!-- semconv metric.system.processes.created(full) -->
<!-- semconv metric.system.process.created(full) -->
<!-- endsemconv -->

## `system.{os}.` - OS Specific System Metrics
Expand Down
16 changes: 8 additions & 8 deletions model/metrics/system-metrics.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -447,9 +447,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:
Expand All @@ -470,18 +470,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
type: metric
metric_name: system.processes.created
metric_name: system.process.created
brief: "Total number of processes created over uptime of the host"
instrument: counter
unit: "{process}"
Expand Down
11 changes: 11 additions & 0 deletions schema-next.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 8d1507f

Please sign in to comment.