Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

system: shared IO direction attributes #530

Merged
merged 17 commits into from
Nov 22, 2023
Merged

system: shared IO direction attributes #530

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
a9791c0
Created network and disk io.direction attributes
braydonk Nov 16, 2023
b2068e9
make table-generation
braydonk Nov 16, 2023
1bb5ef9
move io direction attributes to global registry
braydonk Nov 18, 2023
315ec6f
table generation for global registry attributes
braydonk Nov 18, 2023
2d60518
Merge branch 'main' into system_shared_attr
braydonk Nov 18, 2023
0618096
Update model/registry/network.yaml
AlexanderWert Nov 22, 2023
89c5552
Update model/registry/disk.yaml
AlexanderWert Nov 22, 2023
2ff5d1a
Merge branch 'main' into system_shared_attr
AlexanderWert Nov 22, 2023
b170d7e
Update docs/attributes-registry/network.md
AlexanderWert Nov 22, 2023
f0f9f2b
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
ad18ddf
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
f8a33ca
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
8bfae17
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
6c9d5fc
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
bdeaca2
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
91436d6
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
638b97e
Update docs/system/system-metrics.md
AlexanderWert Nov 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions docs/system/system-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,10 +359,10 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.disk.io(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `disk.io.direction` | string | The disk IO operation direction | `read` | Recommended |
AlexanderWert marked this conversation as resolved.
Show resolved Hide resolved
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.disk.direction` | string | The disk operation direction | `read` | Recommended |

`system.disk.direction` MUST be one of the following:
`disk.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
Expand All @@ -383,10 +383,10 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.disk.operations(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `disk.io.direction` | string | The disk IO operation direction | `read` | Recommended |
AlexanderWert marked this conversation as resolved.
Show resolved Hide resolved
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.disk.direction` | string | The disk operation direction | `read` | Recommended |

`system.disk.direction` MUST be one of the following:
`disk.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
Expand Down Expand Up @@ -435,10 +435,10 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.disk.operation_time(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `disk.io.direction` | string | The disk IO operation direction | `read` | Recommended |
AlexanderWert marked this conversation as resolved.
Show resolved Hide resolved
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.disk.direction` | string | The disk operation direction | `read` | Recommended |

`system.disk.direction` MUST be one of the following:
`disk.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
Expand All @@ -459,10 +459,10 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.disk.merged(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `disk.io.direction` | string | The disk IO operation direction | `read` | Recommended |
AlexanderWert marked this conversation as resolved.
Show resolved Hide resolved
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.disk.direction` | string | The disk operation direction | `read` | Recommended |

`system.disk.direction` MUST be one of the following:
`disk.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
Expand Down Expand Up @@ -575,14 +575,14 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.network.dropped(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `network.io.direction` | string | The network IO operation direction | `send` | Recommended |
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.network.direction` | string | | `transmit` | Recommended |

`system.network.direction` MUST be one of the following:
`network.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
| `transmit` | transmit |
| `send` | send |
AlexanderWert marked this conversation as resolved.
Show resolved Hide resolved
| `receive` | receive |
<!-- endsemconv -->

Expand All @@ -599,14 +599,14 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.network.packets(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `network.io.direction` | string | The network IO operation direction | `send` | Recommended |
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.network.direction` | string | | `transmit` | Recommended |

`system.network.direction` MUST be one of the following:
`network.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
| `transmit` | transmit |
| `send` | send |
| `receive` | receive |
<!-- endsemconv -->

Expand All @@ -629,14 +629,14 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.network.errors(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `network.io.direction` | string | The network IO operation direction | `send` | Recommended |
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.network.direction` | string | | `transmit` | Recommended |

`system.network.direction` MUST be one of the following:
`network.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
| `transmit` | transmit |
| `send` | send |
| `receive` | receive |
<!-- endsemconv -->

Expand All @@ -653,14 +653,14 @@ This metric is [recommended][MetricRecommended].
<!-- semconv metric.system.network.io(full) -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
| `network.io.direction` | string | The network IO operation direction | `send` | Recommended |
| `system.device` | string | The device identifier | `(identifier)` | Recommended |
| `system.network.direction` | string | | `transmit` | Recommended |

`system.network.direction` MUST be one of the following:
`network.io.direction` MUST be one of the following:

| Value | Description |
|---|---|
| `transmit` | transmit |
| `send` | send |
| `receive` | receive |
<!-- endsemconv -->

Expand Down
55 changes: 33 additions & 22 deletions model/metrics/system-metrics.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,20 +213,22 @@
- ref: system.paging.direction

# system.disk.* metrics and attribute group
- id: attributes.system.disk
prefix: system.disk

# General disk attributes
- id: attributes.disk
prefix: disk
type: attribute_group
brief: "Describes System Disk metric attributes"
brief: "Describes attributes used in disk-related metrics"
attributes:
- id: direction
- id: io.direction
type:
allow_custom_values: false
members:
- id: read
value: 'read'
- id: write
value: 'write'
brief: "The disk operation direction"
brief: "The disk IO operation direction"
examples: ["read"]

- id: metric.system.disk.io
Expand All @@ -237,7 +239,7 @@
unit: "By"
attributes:
- ref: system.device
- ref: system.disk.direction
- ref: disk.io.direction

- id: metric.system.disk.operations
type: metric
Expand All @@ -247,7 +249,7 @@
unit: "{operation}"
attributes:
- ref: system.device
- ref: system.disk.direction
- ref: disk.io.direction

- id: metric.system.disk.io_time
type: metric
Expand Down Expand Up @@ -278,7 +280,7 @@
- Windows: "Avg. Disk sec/Read" perf counter multiplied by "Disk Reads/sec" perf counter (similar for Writes)
attributes:
- ref: system.device
- ref: system.disk.direction
- ref: disk.io.direction

- id: metric.system.disk.merged
type: metric
Expand All @@ -288,7 +290,7 @@
unit: "{operation}"
attributes:
- ref: system.device
- ref: system.disk.direction
- ref: disk.io.direction

# system.filesystem.* metrics and attribute group
- id: attributes.system.filesystem
Expand Down Expand Up @@ -361,22 +363,31 @@
- ref: system.filesystem.mode
- ref: system.filesystem.mountpoint

# system.network.* metrics and attribute group
- id: attributes.system.network
prefix: system.network
# system.network.* metrics and attribute group

Check failure on line 366 in model/metrics/system-metrics.yaml

View workflow job for this annotation

GitHub Actions / yamllint 

[trailing-spaces] trailing spaces

Check failure on line 367 in model/metrics/system-metrics.yaml

View workflow job for this annotation

GitHub Actions / yamllint 

[trailing-spaces] trailing spaces
# General network attributes
- id: attributes.network
braydonk marked this conversation as resolved.
Show resolved Hide resolved
prefix: network
type: attribute_group
brief: "Describes Network metric attributes"
brief: "Describes attributes used in network-related metrics"
attributes:
- id: direction
- id: io.direction
type:
allow_custom_values: false
members:
- id: transmit
value: 'transmit'
- id: send
value: 'send'
- id: receive
value: 'receive'
brief: ""
examples: ["transmit"]
brief: "The network IO operation direction"
examples: ["send"]

Check failure on line 384 in model/metrics/system-metrics.yaml

View workflow job for this annotation

GitHub Actions / yamllint 

[trailing-spaces] trailing spaces
# System-specific network attributes
- id: attributes.system.network
prefix: system.network
type: attribute_group
brief: "Describes Network metric attributes"
attributes:
- id: state
type:
allow_custom_values: false
Expand Down Expand Up @@ -422,7 +433,7 @@
from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2)
attributes:
- ref: system.device
- ref: system.network.direction
- ref: network.io.direction

- id: metric.system.network.packets
type: metric
Expand All @@ -432,7 +443,7 @@
unit: "{packet}"
attributes:
- ref: system.device
- ref: system.network.direction
- ref: network.io.direction

- id: metric.system.network.errors
type: metric
Expand All @@ -448,7 +459,7 @@
from [`GetIfEntry2`](https://docs.microsoft.com/windows/win32/api/netioapi/nf-netioapi-getifentry2).
attributes:
- ref: system.device
- ref: system.network.direction
- ref: network.io.direction

- id: metric.system.network.io
type: metric
Expand All @@ -458,7 +469,7 @@
unit: "By"
attributes:
- ref: system.device
- ref: system.network.direction
- ref: network.io.direction

- id: metric.system.network.connections
type: metric
Expand Down
Loading