System Semantic Conventions stability

May 13, 2024 · View on GitHub

Description

The OpenTelemetry Collector community would like to stabilize system semantic conventions including system metrics in order to help the adoption of the OTel hostmetricsreceiver.

Project Board

See: https://github.com/orgs/open-telemetry/projects/55/views/3

done

(@frzifus) https://github.com/open-telemetry/semantic-conventions/issues/98

Finally

Stabilize existing semantic conventions (system metrics)

Deliverables

Mark the system semantic conventions as stable.
Update existing OpenTelemetry Collector hostmetricsreceiver to conform with the stable conventions.

Staffing / Help Wanted

The goal is to follow @tedsuo's proposed Semantic Convention Process.

Stage 1: SIG Preparation
Stage 2: Stabilizing the Specification
Stage 3: Implementation

Required staffing

@mx-psi, @frzifus project leads
@jsuereth technical committee sponsor
domain experts:
- @MovieStoreGuy
- @dmitryax
- @gbbr
- @sallyom
- @ChrsMark
- @kaiyan-sheng
- @braydonk
- @bertysentry
- @dineshg13

Meetings

cncf-slack #otel-system-metrics meeting-notes google-doc

Timeline

Stage 1 (SIG Preparation) is happening now.

Stage 2 (Stabilizing the Specification) will begin as soon as we have adequate staffing for this project, and we coordinate a weekly meeting times (currently targeting mid-july).

Stage 3 (Implementation) will begin as soon as the system metrics are marked stable, and it should be relatively short we only need to update conformance to the specification for a single collector package.

Labels

The tracking issue should be properly labeled to indicate what parts of the specification it is focused on.

Linked Issues and PRs

All PRs, Issues, and OTEPs related to the project should link back to the tracking issue, so that they can be easily found.