open-telemetry / semantic-conventions

Defines standards for generating consistent, accessible telemetry across a variety of domains
Apache License 2.0
256 stars 165 forks source link

Update Contributing.MD to describe how to use attribute registry when defining new semconv. #532

Open jsuereth opened 10 months ago

jsuereth commented 10 months ago

Today, CONTRIBUTING asks users to fill out yaml files for metrics and definitions, but doesn't describe the new attribute registry layout we're moving towards. We should update that with guidance on where to put attributes and how to reference them.

cc @AlexanderWert

AlexanderWert commented 10 months ago

Will write something for that

joaopgrassi commented 7 months ago

We don't specifically talk about the registry, but we say changes must be done in model. https://github.com/open-telemetry/semantic-conventions/blob/main/CONTRIBUTING.md#how-to-contribute. Do you think this is enough, or should we modify it still to say: