semantic-conventions
semantic-conventions copied to clipboard
[Page feedback]: Duplicated & illogical hw.type list content
URL
https://opentelemetry.io/docs/specs/semconv/hardware/common/
Description
Issues with the hw.type documentation on that page:
- Identical
hw.typelist is specified 5 times on that page. Once would be enough - HW type list includes metric types (e.g.
temperature) in addition to HW types (e.g.gpu) [1] - Lists state that "If one of them applies, then the respective value MUST be used", however there's no guidance when (completely normal) metrics match multiple list items, for example "GPU memory temperature" or "GPU power supply voltage"
Note: same issues are also visible on other hardware semantic pages.
[1] There are pages for corresponding metrics (their sensors):
- https://opentelemetry.io/docs/specs/semconv/hardware/temperature/
- https://opentelemetry.io/docs/specs/semconv/hardware/voltage/
Obviously there must be something providing the metric, whether it's analog or digital sensor, or just algorithm deriving metric value from other (sensor, register, whatever) values. However, if temperature & voltage metrics (their sensors) are listed separately from the component they measure, why other metrics and whatever handles them, are not:
- Energy usage (limits etc)
- Error counters (HW event trigger limits etc)
- Frequency (overclocking, throttling etc.
?
Tip
React with 👍 to help prioritize this issue. Please use comments to provide useful context, avoiding +1 or me too, to help us triage it. Learn more here.