semantic-conventions icon indicating copy to clipboard operation
semantic-conventions copied to clipboard

Write Metric guidance that description should be a full sentance.

Open reyang opened this issue 3 years ago • 4 comments

OpenMetrics provided such example: https://github.com/OpenObservability/OpenMetrics/blob/main/specification/OpenMetrics.md#overall-structure

image

The current metrics semantic convention is different (and inconsistent):

image

Ask:

  1. Make it consistent at least for the semantic conventions that are in scope for the initial stable release.
  2. Align with OpenMetrics, description should have the first letter uppercase, and end with ..

Additional Ask (not blocking):

  1. The build tool should fail/block the CI if there is any description not following the convention/rule.

reyang avatar Nov 22 '22 18:11 reyang