Skip to content

Commit 8af31d2

Browse files
committed
Added review suggestions
1 parent 9da02ce commit 8af31d2

File tree

3 files changed

+19
-41
lines changed

3 files changed

+19
-41
lines changed

docs/system/system-metrics.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1332,14 +1332,10 @@ This metric is [recommended][MetricRecommended].
13321332
The metric represents the percentage of time that tasks were stalled on a given resource
13331333
over the specified time window.
13341334

1335-
The "some" stall type indicates at least some tasks are stalled on the resource.
1336-
The "full" stall type indicates all non-idle tasks are stalled simultaneously, representing
1337-
a more severe state where the system is thrashing and CPU cycles are wasted.
1338-
13391335
PSI is available on Linux systems with kernel 4.20 or later and requires CONFIG_PSI=y.
13401336
CPU "full" stall is reported as zero at the system level for backward compatibility (available since 5.13).
13411337

1342-
Values are percentages in the range [0, 100]. The ratios are tracked over 10-second, 60-second,
1338+
The ratios are tracked over 10-second, 60-second,
13431339
and 300-second windows.
13441340

13451341
See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html) and
@@ -1349,15 +1345,13 @@ See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html
13491345

13501346
| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
13511347
|---|---|---|---|---|---|
1352-
| [`system.psi.resource`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The resource experiencing pressure (cpu, memory, or io) [1] | `cpu`; `memory`; `io` |
1353-
| [`system.psi.stall_type`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The stall type (some or full) [2] | `some`; `full` |
1354-
| [`system.psi.window`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The time window over which pressure is calculated [3] | `10s`; `60s`; `300s` |
1348+
| [`system.psi.resource`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The resource experiencing pressure [1] | `cpu`; `memory`; `io` |
1349+
| [`system.psi.stall_type`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The PSI stall type | `some`; `full` |
1350+
| [`system.psi.window`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The time window over which pressure is calculated [2] | `10s`; `60s`; `300s` |
13551351

13561352
**[1] `system.psi.resource`:** Linux PSI (Pressure Stall Information) measures resource pressure for CPU, memory, and I/O. See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html).
13571353

1358-
**[2] `system.psi.stall_type`:** PSI distinguishes between "some" stall (at least some tasks stalled) and "full" stall (all non-idle tasks stalled simultaneously).
1359-
1360-
**[3] `system.psi.window`:** Typically one of: 10s, 60s, or 300s
1354+
**[2] `system.psi.window`:** PSI tracks pressure as percentages over 10-second, 60-second, and 300-second windows. This attribute identifies which time window the metric represents.
13611355

13621356
---
13631357

@@ -1375,12 +1369,12 @@ See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html
13751369

13761370
| Value | Description | Stability |
13771371
|---|---|---|
1378-
| `full` | All non-idle tasks are stalled on the resource simultaneously [4] | ![Development](https://img.shields.io/badge/-development-blue) |
1379-
| `some` | At least some tasks are stalled on the resource [5] | ![Development](https://img.shields.io/badge/-development-blue) |
1372+
| `full` | All non-idle tasks are stalled on the resource simultaneously [3] | ![Development](https://img.shields.io/badge/-development-blue) |
1373+
| `some` | At least some tasks are stalled on the resource [4] | ![Development](https://img.shields.io/badge/-development-blue) |
13801374

1381-
**[4]:** The "full" line indicates the share of time in which all non-idle tasks are stalled on a given resource simultaneously. This represents a state where actual CPU cycles are going to waste and the workload is thrashing. CPU full is undefined at the system level and is set to zero for backward compatibility (available since Linux 5.13).
1375+
**[3]:** The "full" line indicates the share of time in which all non-idle tasks are stalled on a given resource simultaneously. This represents a state where actual CPU cycles are going to waste and the workload is thrashing. CPU full is undefined at the system level and is set to zero for backward compatibility (available since Linux 5.13).
13821376

1383-
**[5]:** The "some" line indicates the share of time in which at least some tasks are stalled on a given resource.
1377+
**[4]:** The "some" line indicates the share of time in which at least some tasks are stalled on a given resource.
13841378

13851379
<!-- markdownlint-restore -->
13861380
<!-- prettier-ignore-end -->
@@ -1407,28 +1401,22 @@ Unlike the percentage-based `system.linux.psi.pressure` metric, this allows dete
14071401
of latency spikes that wouldn't necessarily make a noticeable impact on time averages.
14081402
It also enables calculating average trends over custom time frames.
14091403

1410-
The "some" stall type indicates at least some tasks are stalled on the resource.
1411-
The "full" stall type indicates all non-idle tasks are stalled simultaneously.
1412-
14131404
PSI is available on Linux systems with kernel 4.20 or later and requires CONFIG_PSI=y.
14141405
CPU "full" stall is reported as zero at the system level for backward compatibility (available since 5.13).
14151406

14161407
This is a monotonically increasing counter that resets on system reboot.
14171408

1418-
See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html) and
1419-
[/proc/pressure/*](https://man7.org/linux/man-pages/man5/proc.5.html) files.
1409+
See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html)
14201410

14211411
**Attributes:**
14221412

14231413
| Key | Stability | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Value Type | Description | Example Values |
14241414
|---|---|---|---|---|---|
1425-
| [`system.psi.resource`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The resource experiencing pressure (cpu, memory, or io) [1] | `cpu`; `memory`; `io` |
1426-
| [`system.psi.stall_type`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The stall type (some or full) [2] | `some`; `full` |
1415+
| [`system.psi.resource`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The resource experiencing pressure [1] | `cpu`; `memory`; `io` |
1416+
| [`system.psi.stall_type`](/docs/registry/attributes/system.md) | ![Development](https://img.shields.io/badge/-development-blue) | `Required` | string | The PSI stall type | `some`; `full` |
14271417

14281418
**[1] `system.psi.resource`:** Linux PSI (Pressure Stall Information) measures resource pressure for CPU, memory, and I/O. See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html).
14291419

1430-
**[2] `system.psi.stall_type`:** PSI distinguishes between "some" stall (at least some tasks stalled) and "full" stall (all non-idle tasks stalled simultaneously).
1431-
14321420
---
14331421

14341422
`system.psi.resource` 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.
@@ -1445,12 +1433,12 @@ See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html
14451433

14461434
| Value | Description | Stability |
14471435
|---|---|---|
1448-
| `full` | All non-idle tasks are stalled on the resource simultaneously [3] | ![Development](https://img.shields.io/badge/-development-blue) |
1449-
| `some` | At least some tasks are stalled on the resource [4] | ![Development](https://img.shields.io/badge/-development-blue) |
1436+
| `full` | All non-idle tasks are stalled on the resource simultaneously [2] | ![Development](https://img.shields.io/badge/-development-blue) |
1437+
| `some` | At least some tasks are stalled on the resource [3] | ![Development](https://img.shields.io/badge/-development-blue) |
14501438

1451-
**[3]:** The "full" line indicates the share of time in which all non-idle tasks are stalled on a given resource simultaneously. This represents a state where actual CPU cycles are going to waste and the workload is thrashing. CPU full is undefined at the system level and is set to zero for backward compatibility (available since Linux 5.13).
1439+
**[2]:** The "full" line indicates the share of time in which all non-idle tasks are stalled on a given resource simultaneously. This represents a state where actual CPU cycles are going to waste and the workload is thrashing. CPU full is undefined at the system level and is set to zero for backward compatibility (available since Linux 5.13).
14521440

1453-
**[4]:** The "some" line indicates the share of time in which at least some tasks are stalled on a given resource.
1441+
**[3]:** The "some" line indicates the share of time in which at least some tasks are stalled on a given resource.
14541442

14551443
<!-- markdownlint-restore -->
14561444
<!-- prettier-ignore-end -->

model/system/metrics.yaml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -591,14 +591,10 @@ groups:
591591
attributes:
592592
- ref: system.psi.resource
593593
requirement_level: required
594-
brief: "The resource experiencing pressure (cpu, memory, or io)"
595594
- ref: system.psi.stall_type
596595
requirement_level: required
597-
brief: "The stall type (some or full)"
598596
- ref: system.psi.window
599597
requirement_level: required
600-
brief: "The time window over which pressure is calculated"
601-
note: "Typically one of: 10s, 60s, or 300s"
602598
entity_associations:
603599
- host
604600

@@ -621,16 +617,13 @@ groups:
621617
622618
This is a monotonically increasing counter that resets on system reboot.
623619
624-
See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html) and
625-
[/proc/pressure/*](https://man7.org/linux/man-pages/man5/proc.5.html) files.
620+
See [Linux kernel PSI documentation](https://docs.kernel.org/accounting/psi.html)
626621
instrument: counter
627622
unit: "us"
628623
attributes:
629624
- ref: system.psi.resource
630625
requirement_level: required
631-
brief: "The resource experiencing pressure (cpu, memory, or io)"
632626
- ref: system.psi.stall_type
633627
requirement_level: required
634-
brief: "The stall type (some or full)"
635628
entity_associations:
636629
- host

model/system/registry.yaml

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ groups:
165165
stability: development
166166
brief: "I/O resource pressure"
167167
stability: development
168-
brief: "The PSI resource being measured"
168+
brief: "The resource experiencing pressure"
169169
examples: ["cpu", "memory", "io"]
170170
note: >
171171
Linux PSI (Pressure Stall Information) measures resource pressure for CPU, memory, and I/O.
@@ -193,13 +193,10 @@ groups:
193193
stability: development
194194
brief: "The PSI stall type"
195195
examples: ["some", "full"]
196-
note: >
197-
PSI distinguishes between "some" stall (at least some tasks stalled) and
198-
"full" stall (all non-idle tasks stalled simultaneously).
199196
- id: system.psi.window
200197
type: string
201198
stability: development
202-
brief: "The time window for PSI pressure calculation"
199+
brief: "The time window over which pressure is calculated"
203200
examples: ["10s", "60s", "300s"]
204201
note: >
205202
PSI tracks pressure as percentages over 10-second, 60-second, and 300-second windows.

0 commit comments

Comments
 (0)