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

Jump to bottom

Document the difference between host and system metrics #324

Merged
merged 9 commits into from
Oct 2, 2023
Merged

Document the difference between host and system metrics #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
76cf4ab
Document the difference between host and system metrics
ChrsMark Sep 13, 2023
2a84cda
Update docs/resource/host.md
ChrsMark Sep 19, 2023
ac139c7
Update docs/system/system-metrics.md
ChrsMark Sep 19, 2023
88ebcef
Review changes
ChrsMark Sep 19, 2023
12ad001
Improve wording about tech specific metrics
ChrsMark Sep 20, 2023
de28506
Update docs/system/system-metrics.md
ChrsMark Sep 20, 2023
7eaf3e6
Merge branch 'main' into add_host_system_clarifications
joaopgrassi Sep 22, 2023
d6e3474
Merge branch 'main' into add_host_system_clarifications
joaopgrassi Oct 2, 2023
b1104ca
Merge branch 'main' into add_host_system_clarifications
jsuereth Oct 2, 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
3 changes: 3 additions & 0 deletions docs/resource/host.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@

**Description:** A host is defined as a computing instance. For example, physical servers, virtual machines, switches or disk array.

The `host.*` namespace SHOULD be exclusively used to capture resource attributes.
To report host metrics, the `system.*` namespace SHOULD be used.

<!-- semconv host -->
| Attribute | Type | Description | Examples | Requirement Level |
|---|---|---|---|---|
Expand Down
6 changes: 6 additions & 0 deletions docs/system/system-metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,12 @@ 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.

The `system.*` namespace SHOULD be exclusively used to report hosts' metrics.
The `system.*` namespace SHOULD only be used when the metrics are collected from within the target system. (physical servers, virtual machines etc).
Metrics collected from technology-specific, well-defined APIs (e.g. Kubelet's API or container runtimes)
should be reported under their respective namespace (e.g. k8s.*, container.*).
Resource attributes related to a host, SHOULD be reported under the `host.*` namespace.

<!-- Re-generate TOC with `markdown-toc --no-first-h1 -i` -->

<!-- toc -->
Expand Down
Loading