Should metrics description be a full sentence?

[reyang]

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

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

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.

[carlosalberto]

Looks like a good, non-polemical improvement to make.

[trask]

@reyang do you think this is a blocker for HTTP stability?

[reyang]

I don't think so, worst case I'll send a small PR just to fix the HTTP metrics descriptions (to align with OpenMetrics convention). Assigning this to myself.

[reyang]

Update: I've scanned through the HTTP metrics semantic conventions and confirmed that all descriptions are now aligned with OpenMetrics convention, so it is not blocking HTTP semantic convention stability.

@trask FYI