Clarify unit annotation format for metric semantic conventions

[arminru]

The semantic conventions for metrics currently use both spaces and underscores in unit annotations consisting of multiple words. Additionally, we have examples where the spaces between words are just omitted.

Before calling any of the metrics semantic conventions stable, we should add guidance on what's preferred and align the existing conventions to be consistent.

Also, as per the UCUM standard, both 1 and {count} are considered equivalent, which might lead to inconsistent conventions. A preference for either of them could also be laid out by the OTel spec.

Examples

https://github.com/open-telemetry/opentelemetry-specification/blob/534d4562b9e4f9ba030146783a1785f94b266862/specification/metrics/semantic_conventions/instrumentation/kafka.md?plain=1#L40-L42
https://github.com/open-telemetry/opentelemetry-specification/blob/534d4562b9e4f9ba030146783a1785f94b266862/specification/metrics/semantic_conventions/instrumentation/kafka.md?plain=1#L78-L83
https://github.com/open-telemetry/opentelemetry-specification/blob/534d4562b9e4f9ba030146783a1785f94b266862/specification/metrics/semantic_conventions/instrumentation/kafka.md?plain=1#L65
https://github.com/open-telemetry/opentelemetry-specification/blob/534d4562b9e4f9ba030146783a1785f94b266862/specification/metrics/semantic_conventions/faas-metrics.md?plain=1#L43

[tigrannajaryan]

@arminru do yo plan to work on this? If not we need a "help wanted" label.

[evan-bradley]

I'd like to take a look at this. @jsuereth do you see this issue depending on any output from the Semantic Conventions Working Group, or can it be worked on in parallel?

[evan-bradley]

Was going through my backlog and saw this issue, I'm no longer able to work on this. @jsuereth can this be closed, or is it still needed?

[trask]

transferring to https://github.com/open-telemetry/semantic-conventions

[trask]

The semantic conventions for metrics currently use both spaces and underscores in unit annotations consisting of multiple words. Additionally, we have examples where the spaces between words are just omitted.

Before calling any of the metrics semantic conventions stable, we should add guidance on what's preferred and align the existing conventions to be consistent.

Also, as per the UCUM standard, both 1 and {count} are considered equivalent, which might lead to inconsistent conventions. A preference for either of them could also be laid out by the OTel spec.

I believe this can be closed now. I checked and there are no units with spaces in them. And I believe this section now addresses the requested guidance: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/metrics.md#instrument-units