Skip to content

Commit 78c373e

Browse files
thompson-tomothompson-tomo
authored
[chore] Add missing system briefs #2507 (#2600)
1 parent 2067f5a commit 78c373e

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

‎docs/system/system-metrics.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,7 @@ This metric is [recommended][MetricRecommended].
352352

353353
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
354354
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
355-
| `system.memory.utilization` | Gauge | `1` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
355+
| `system.memory.utilization` | Gauge | `1` | Percentage of memory bytes in use. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
356356

357357
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
358358
|---|---|---|---|---|---|
@@ -427,7 +427,7 @@ This metric is [recommended][MetricRecommended].
427427

428428
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
429429
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
430-
| `system.paging.utilization` | Gauge | `1` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
430+
| `system.paging.utilization` | Gauge | `1` | Swap (unix) or pagefile (windows) utilization. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
431431

432432
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
433433
|---|---|---|---|---|---|
@@ -461,7 +461,7 @@ This metric is [recommended][MetricRecommended].
461461

462462
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
463463
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
464-
| `system.paging.faults` | Counter | `{fault}` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
464+
| `system.paging.faults` | Counter | `{fault}` | The number of page faults. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
465465

466466
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
467467
|---|---|---|---|---|---|
@@ -494,7 +494,7 @@ This metric is [recommended][MetricRecommended].
494494

495495
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
496496
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
497-
| `system.paging.operations` | Counter | `{operation}` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
497+
| `system.paging.operations` | Counter | `{operation}` | The number of paging operations. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
498498

499499
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
500500
|---|---|---|---|---|---|
@@ -541,7 +541,7 @@ This metric is [recommended][MetricRecommended].
541541

542542
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
543543
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
544-
| `system.disk.io` | Counter | `By` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
544+
| `system.disk.io` | Counter | `By` | Disk bytes transferred. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
545545

546546
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
547547
|---|---|---|---|---|---|
@@ -575,7 +575,7 @@ This metric is [recommended][MetricRecommended].
575575

576576
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
577577
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
578-
| `system.disk.operations` | Counter | `{operation}` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
578+
| `system.disk.operations` | Counter | `{operation}` | Disk operations count. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
579579

580580
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
581581
|---|---|---|---|---|---|
@@ -679,7 +679,7 @@ This metric is [recommended][MetricRecommended].
679679

680680
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
681681
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
682-
| `system.disk.merged` | Counter | `{operation}` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
682+
| `system.disk.merged` | Counter | `{operation}` | The number of disk reads/writes merged into single physical disk access operations. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
683683

684684
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
685685
|---|---|---|---|---|---|
@@ -795,7 +795,7 @@ This metric is [recommended][MetricRecommended].
795795

796796
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
797797
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
798-
| `system.filesystem.utilization` | Gauge | `1` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
798+
| `system.filesystem.utilization` | Gauge | `1` | Fraction of filesystem bytes used. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
799799

800800
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
801801
|---|---|---|---|---|---|
@@ -930,7 +930,7 @@ This metric is [recommended][MetricRecommended].
930930

931931
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
932932
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
933-
| `system.network.packet.count` | Counter | `{packet}` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
933+
| `system.network.packet.count` | Counter | `{packet}` | The number of packets transferred. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
934934

935935
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
936936
|---|---|---|---|---|---|
@@ -1004,7 +1004,7 @@ This metric is [recommended][MetricRecommended].
10041004

10051005
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
10061006
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
1007-
| `system.network.io` | Counter | `By` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
1007+
| `system.network.io` | Counter | `By` | The number of bytes transmitted and received. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
10081008

10091009
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
10101010
|---|---|---|---|---|---|
@@ -1038,7 +1038,7 @@ This metric is [recommended][MetricRecommended].
10381038

10391039
| Name | Instrument Type | Unit (UCUM) | Description | Stability | Entity Associations |
10401040
| -------- | --------------- | ----------- | -------------- | --------- | ------ |
1041-
| `system.network.connection.count` | UpDownCounter | `{connection}` | TODO. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
1041+
| `system.network.connection.count` | UpDownCounter | `{connection}` | The number of connections. | ![Development](https://img.shields.io/badge/-development-blue) | [`host`](/docs/registry/entities/host.md#host) |
10421042

10431043
| Attribute | Type | Description | Examples | [Requirement Level](https://opentelemetry.io/docs/specs/semconv/general/attribute-requirement-level/) | Stability |
10441044
|---|---|---|---|---|---|

‎model/system/metrics.yaml‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ groups:
149149
code_generation:
150150
metric_value_type: double
151151
stability: development
152-
brief: TODO.
152+
brief: Percentage of memory bytes in use.
153153
instrument: gauge
154154
unit: "1"
155155
attributes:
@@ -183,7 +183,7 @@ groups:
183183
code_generation:
184184
metric_value_type: double
185185
stability: development
186-
brief: TODO.
186+
brief: Swap (unix) or pagefile (windows) utilization.
187187
instrument: gauge
188188
unit: "1"
189189
attributes:
@@ -201,7 +201,7 @@ groups:
201201
code_generation:
202202
metric_value_type: int
203203
stability: development
204-
brief: TODO.
204+
brief: The number of page faults.
205205
instrument: counter
206206
unit: "{fault}"
207207
attributes:
@@ -216,7 +216,7 @@ groups:
216216
annotations:
217217
code_generation:
218218
metric_value_type: int
219-
brief: TODO.
219+
brief: The number of paging operations.
220220
instrument: counter
221221
unit: "{operation}"
222222
attributes:
@@ -233,7 +233,7 @@ groups:
233233
code_generation:
234234
metric_value_type: int
235235
stability: development
236-
brief: TODO.
236+
brief: Disk bytes transferred.
237237
instrument: counter
238238
unit: "By"
239239
attributes:
@@ -249,7 +249,7 @@ groups:
249249
code_generation:
250250
metric_value_type: int
251251
stability: development
252-
brief: TODO.
252+
brief: Disk operations count.
253253
instrument: counter
254254
unit: "{operation}"
255255
attributes:
@@ -308,7 +308,7 @@ groups:
308308
code_generation:
309309
metric_value_type: int
310310
stability: development
311-
brief: TODO.
311+
brief: The number of disk reads/writes merged into single physical disk access operations.
312312
instrument: counter
313313
unit: "{operation}"
314314
attributes:
@@ -364,7 +364,7 @@ groups:
364364
code_generation:
365365
metric_value_type: double
366366
stability: development
367-
brief: TODO.
367+
brief: Fraction of filesystem bytes used.
368368
instrument: gauge
369369
unit: "1"
370370
attributes:
@@ -428,7 +428,7 @@ groups:
428428
code_generation:
429429
metric_value_type: int
430430
stability: development
431-
brief: TODO.
431+
brief: The number of packets transferred.
432432
instrument: counter
433433
unit: "{packet}"
434434
attributes:
@@ -466,7 +466,7 @@ groups:
466466
code_generation:
467467
metric_value_type: int
468468
stability: development
469-
brief: TODO.
469+
brief: The number of bytes transmitted and received.
470470
instrument: counter
471471
unit: "By"
472472
attributes:
@@ -482,7 +482,7 @@ groups:
482482
code_generation:
483483
metric_value_type: int
484484
stability: development
485-
brief: TODO.
485+
brief: The number of connections.
486486
instrument: updowncounter
487487
unit: "{connection}"
488488
attributes:

0 commit comments

Comments
 (0)