open-telemetry
/
semantic-conventions
mirror of https://github.com/open-telemetry/semantic-conventions.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
semantic-conventions/docs/attributes-registry/system.md

184 lines
15 KiB
Markdown
Raw Blame History

<!--- Hugo front matter used to generate the website version of this page:
--->
<!-- NOTE: THIS FILE IS AUTOGENERATED. DO NOT EDIT BY HAND. -->
<!-- see templates/registry/markdown/attribute_namespace.md.j2 -->
# System
- [System](#system-attributes)
- [System Cpu](#system-cpu-attributes)
- [System Deprecated](#system-deprecated-attributes)
- [System Filesystem](#system-filesystem-attributes)
- [System Memory](#system-memory-attributes)
- [System Network](#system-network-attributes)
- [System Paging](#system-paging-attributes)
- [System Process](#system-process-attributes)
## System Attributes
Describes System attributes
| Attribute | Type | Description | Examples | Stability |
| --------------- | ------ | --------------------- | -------------- | ---------------------------------------------------------------- |
| `system.device` | string | The device identifier | `(identifier)` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Cpu Attributes
Describes System CPU attributes
| Attribute | Type | Description | Examples | Stability |
| --------------------------- | ------ | ------------------------------- | ------------------------ | ---------------------------------------------------------------- |
| `system.cpu.logical_number` | int | The logical CPU number [0..n-1] | `1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system.cpu.state` | string | The state of the CPU | `user`; `system`; `nice` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.cpu.state` 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 | Stability |
| ----------- | ----------- | ---------------------------------------------------------------- |
| `user` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `nice` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `idle` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `iowait` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `interrupt` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `steal` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Deprecated Attributes
Deprecated system attributes.
| Attribute | Type | Description | Examples | Stability |
| ------------------------- | ------ | ------------------------------------------------ | -------------------------------- | --------------------------------------------------------------------------------------------------- |
| `system.processes.status` | string | Deprecated, use `system.process.status` instead. | `running`; `sleeping`; `stopped` | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Replaced by `system.process.status`. |
`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.
| Value | Description | Stability |
| ---------- | ----------- | ---------------------------------------------------------------- |
| `running` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `sleeping` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `stopped` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `defunct` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Filesystem Attributes
Describes Filesystem attributes
| Attribute | Type | Description | Examples | Stability |
| ------------------------------ | ------ | ------------------------- | -------------------------- | ---------------------------------------------------------------- |
| `system.filesystem.mode` | string | The filesystem mode | `rw, ro` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system.filesystem.mountpoint` | string | The filesystem mount path | `/mnt/data` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system.filesystem.state` | string | The filesystem state | `used`; `free`; `reserved` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system.filesystem.type` | string | The filesystem type | `fat32`; `exfat`; `ntfs` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.filesystem.state` 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 | Stability |
| ---------- | ----------- | ---------------------------------------------------------------- |
| `used` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `free` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `reserved` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.filesystem.type` 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 | Stability |
| --------- | ----------- | ---------------------------------------------------------------- |
| `fat32` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `exfat` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ntfs` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `refs` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hfsplus` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ext4` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Memory Attributes
Describes System Memory attributes
| Attribute | Type | Description | Examples | Stability |
| --------------------- | ------ | ---------------- | ------------------------ | ---------------------------------------------------------------- |
| `system.memory.state` | string | The memory state | `used`; `free`; `shared` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.memory.state` 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 | Stability |
| --------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `used` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `free` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `shared` | none | ![Deprecated](https://img.shields.io/badge/-deprecated-red)<br>Removed, report shared memory usage with `metric.system.memory.shared` metric |
| `buffers` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cached` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Network Attributes
Describes Network attributes
| Attribute | Type | Description | Examples | Stability |
| ---------------------- | ------ | ------------------------------------------------ | -------------------------------- | ---------------------------------------------------------------- |
| `system.network.state` | string | A stateless protocol MUST NOT set this attribute | `close`; `close_wait`; `closing` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.network.state` 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 | Stability |
| ------------- | ----------- | ---------------------------------------------------------------- |
| `close` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `close_wait` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `closing` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `delete` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `established` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `fin_wait_1` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `fin_wait_2` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `last_ack` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `listen` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `syn_recv` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `syn_sent` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `time_wait` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Paging Attributes
Describes System Memory Paging attributes
| Attribute | Type | Description | Examples | Stability |
| ------------------------- | ------ | --------------------------- | ---------------- | ---------------------------------------------------------------- |
| `system.paging.direction` | string | The paging access direction | `in`; `out` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system.paging.state` | string | The memory paging state | `used`; `free` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `system.paging.type` | string | The memory paging type | `major`; `minor` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.paging.direction` 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 | Stability |
| ----- | ----------- | ---------------------------------------------------------------- |
| `in` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `out` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.paging.state` 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 | Stability |
| ------ | ----------- | ---------------------------------------------------------------- |
| `used` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `free` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`system.paging.type` 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 | Stability |
| ------- | ----------- | ---------------------------------------------------------------- |
| `major` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `minor` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
## System Process Attributes
Describes System Process attributes
| Attribute | Type | Description | Examples | Stability |
| ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | ---------------------------------------------------------------- |
| `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`; `sleeping`; `stopped` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
`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 | Stability |
| ---------- | ----------- | ---------------------------------------------------------------- |
| `running` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `sleeping` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `stopped` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `defunct` | none | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
Reference in New Issue View Git Blame Copy Permalink