Include attribute name pluralization guidelines (#1115) #1140
Conversation
specification/common/common.md
Outdated
| - When attribute represents a single entity, the attribute name SHOULD BE singular. | ||
|
|
||
| - When attribute can represent multiple entities, the attribute name SHOULD BE pluralized | ||
| and the value type SHOULD BE an array. |
There was a problem hiding this comment.
One thing I am unsure is how this impacts Erlang, which seem to not support homogenous arrays as of now. Since this case (attributes representing multiple entities) is not common, I don't think it is a concern though
There was a problem hiding this comment.
I'm not sure this is a new problem with this PR, since the specs already define an array of primitive type value for attributes, and the otel proto defines an ArrayValue for attributes.
pmm-sumo
force-pushed
the
attr-name-guidance
branch
from
bc921f2
to
f4210c3
Compare
specification/common/common.md
Outdated
| and the value type SHOULD BE an array. | ||
|
|
||
| - When attribute represents a measurement, | ||
| [Metric Name Pluralization Guidelines](https://github.com/pmm-sumo/opentelemetry-specification/blob/master/specification/metrics/semantic_conventions/README.md#pluralization) |
There was a problem hiding this comment.
❤️ (though this isn't merged yet)
|
In #1115 I've asked for more details about when an attribute might represent multiple entities. I've tried to focus attention on how the semantics might differ between these interpretations. I've pointed out that I think of |
Co-authored-by: Justin Foote <justinandrewfoote@gmail.com>
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
|
@jmacd Hey, could you comment on the latest iteration? |
|
@pmm-sumo Hey hey, just realized there's a small issue with a broken link, as reported by docfx:
Once that's fixed, we are good to merge this PR 😃 |
Yeah, I am wondering what's the best approach here. The link refers to another PR which is not merged yet. Actually, the whole whole paragraph refers to the PR. I see #1109 has 3 approvals already, so perhaps we could wait until it gets merged first? What do you think @carlosalberto ? |
|
@pmm-sumo Oh, right, my bad. Let's hold it for a bit 😉 |
|
I'm trying to merge the referred-to PR but the CLA bot is wedged. I'll keep trying. |
|
Thank you @carlosalberto and @jmacd |
Fixes #1115
Changes
Provides proposal for attribute name pluralization guidelines
Depends on https://github.com/open-telemetry/opentelemetry-specification/pull/1109/files
Related issues #