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.

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

move common hardware attributes and metrics to registry #1030

Merged
merged 33 commits into from
Aug 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
a36b95c
add common hardware attributes
trisch-me May 10, 2024
edb94e6
add hardware to the issues
trisch-me May 10, 2024
a82ab2d
EOLs
trisch-me May 10, 2024
8765f5f
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me May 10, 2024
2f576ae
update toc
trisch-me May 10, 2024
84cfdd8
fix violations
trisch-me May 10, 2024
26ecec6
Apply suggestions from code review
trisch-me May 11, 2024
51911cb
Merge branch 'main' into hardware_basic
trisch-me May 11, 2024
427370c
fix lint
trisch-me May 14, 2024
f586c14
Merge branch 'hardware_basic' of github.com:trisch-me/semantic-conven…
trisch-me May 14, 2024
56998ad
Merge branch 'main' into hardware_basic
trisch-me May 15, 2024
f9f2a24
Merge branch 'main' into hardware_basic
trisch-me May 17, 2024
aa9f74a
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me May 17, 2024
20f237a
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me May 21, 2024
8aff38f
update md files after fixing generation
trisch-me May 21, 2024
ce012f7
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Jun 5, 2024
4cfa4ef
review comments
trisch-me Jun 6, 2024
0f0b24a
fix lint
trisch-me Jun 6, 2024
cd8affa
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Jun 11, 2024
590baa4
address comments
trisch-me Jun 11, 2024
5d899b6
Merge branch 'main' into hardware_basic
trisch-me Jul 23, 2024
9d04215
add namespace to id; updare error parameters
trisch-me Jul 23, 2024
8cb3452
Merge branch 'main' into hardware_basic
trisch-me Jul 30, 2024
3900bde
Merge branch 'main' into hardware_basic
trisch-me Jul 31, 2024
d91cffe
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Aug 1, 2024
2a454fb
Merge branch 'main' of github.com:open-telemetry/semantic-conventions…
trisch-me Aug 2, 2024
7da5243
wording updated; stale keywords removed
trisch-me Aug 2, 2024
c6ec213
Merge branch 'hardware_basic' of github.com:trisch-me/semantic-conven…
trisch-me Aug 2, 2024
4767f96
update link to document status
trisch-me Aug 2, 2024
fbe0c4e
remove auto toc generation
trisch-me Aug 2, 2024
86a962f
fix lint
trisch-me Aug 2, 2024
45462b8
Merge branch 'main' into hardware_basic
trisch-me Aug 5, 2024
e38cf6f
Merge branch 'main' into hardware_basic
lmolkova Aug 5, 2024
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
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ body:
- area:gen-ai
- area:go
- area:graphql
- area:hardware
lmolkova marked this conversation as resolved.
Show resolved Hide resolved
- area:heroku
- area:host
- area:http
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/change_proposal.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ body:
- area:gen-ai
- area:go
- area:graphql
- area:hardware
- area:heroku
- area:host
- area:http
Expand Down
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/new-conventions.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ body:
- area:gen-ai
- area:go
- area:graphql
- area:hardware
- area:heroku
- area:host
- area:http
Expand Down
1 change: 1 addition & 0 deletions docs/attributes-registry/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,7 @@ Currently, the following namespaces exist:
- [Gen AI](gen-ai.md)
- [Go](go.md)
- [GraphQL](graphql.md)
- [Hardware](hardware.md)
- [Heroku](heroku.md)
- [Host](host.md)
- [HTTP](http.md)
Expand Down
48 changes: 48 additions & 0 deletions docs/attributes-registry/hardware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!--- 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 -->

# Hardware

## Hardware Attributes

Attributes for hardware.

| Attribute | Type | Description | Examples | Stability |
| ----------- | ------ | ---------------------------------------------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------------------------------------- |
| `hw.id` | string | An identifier for the hardware component, unique within the monitored host | `win32battery_battery_testsysa33_1` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hw.name` | string | An easily-recognizable name for the hardware component | `eth0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hw.parent` | string | Unique identifier of the parent component (typically the `hw.id` attribute of the enclosure, or disk controller) | `dellStorage_perc_0` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hw.state` | string | The current state of the component | `ok`; `degraded`; `failed` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `hw.type` | string | Type of the component [1] | `battery`; `cpu`; `disk_controller` | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

**[1]:** Describes the category of the hardware component for which `hw.state` is being reported. For example, `hw.type=temperature` along with `hw.state=degraded` would indicate that the temperature of the hardware component has been reported as `degraded`.

`hw.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 |
| ---------- | ----------- | ---------------------------------------------------------------- |
| `degraded` | Degraded | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `failed` | Failed | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `ok` | Ok | ![Experimental](https://img.shields.io/badge/-experimental-blue) |

`hw.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 |
| ----------------- | --------------- | ---------------------------------------------------------------- |
| `battery` | Battery | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `cpu` | CPU | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `disk_controller` | Disk controller | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `enclosure` | Enclosure | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `fan` | Fan | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `gpu` | GPU | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `logical_disk` | Logical disk | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `memory` | Memory | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `network` | Network | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `physical_disk` | Physical disk | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `power_supply` | Power supply | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `tape_drive` | Tape drive | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `temperature` | Temperature | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
| `voltage` | Voltage | ![Experimental](https://img.shields.io/badge/-experimental-blue) |
17 changes: 17 additions & 0 deletions docs/hardware/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!--- Hugo front matter used to generate the website version of this page:
linkTitle: Hardware
--->

# Semantic Conventions for Hardware

**Status**: [Experimental][DocumentStatus]

This document describes instruments and attributes for common hardware level
metrics in OpenTelemetry. Consider the [general metric semantic conventions](/docs/general/metrics.md#general-metric-semantic-conventions)
when creating instruments not explicitly defined in the specification.

Semantic conventions for hardware are defined as following:

* [Common Hardware Metrics](common.md): Semantic Conventions for *common* hardware metrics.

[DocumentStatus]: https://opentelemetry.io/docs/specs/otel/document-status
Loading
Loading