Skip to content

[chore] Clarify .count for updowncounters guidance#2317

Merged
lmolkova merged 4 commits intoopen-telemetry:mainfrom
ChrsMark:updowncounter_guidance
Jul 1, 2025
Merged

[chore] Clarify .count for updowncounters guidance#2317
lmolkova merged 4 commits intoopen-telemetry:mainfrom
ChrsMark:updowncounter_guidance

Conversation

@ChrsMark
Copy link
Copy Markdown
Member

@ChrsMark ChrsMark commented Jun 2, 2025

Fixes #2306

Changes

This PR tries to clarfiy the guidance regarding the usage of .count for UpDownCounters as it was described at #2306.

/cc @trask @lmolkova @braydonk

Merge requirement checklist

joaopgrassi
joaopgrassi previously approved these changes Jun 2, 2025
@ChrsMark ChrsMark moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Jun 3, 2025
@ChrsMark ChrsMark requested review from lmolkova and trask June 5, 2025 14:45
Copy link
Copy Markdown
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've added this to Mon SIG meeting agenda just to confirm with more folks, thanks

Comment thread docs/general/naming.md Outdated
@joaopgrassi joaopgrassi dismissed their stale review June 13, 2025 07:56

Dismissing as we seem to have a bigger problem, @lmolkova found. Let's see what we can come up to improve this.

@ChrsMark
Copy link
Copy Markdown
Member Author

@lmolkova @joaopgrassi @trask, should we then keep the guidance and make it more explicit with sth like all updowncounters SHOULD be named with .count instead of using pluralisation?

@lmolkova
Copy link
Copy Markdown
Member

@ChrsMark we have a bunch of metrics that use .active or some more suitable alternative to .count, so I was thinking about

- Use count instead of pluralization for UpDownCounters
+ Do not pluralize UpDownCounter names

with some examples using .count and others and explanation that it's a matter of consistency across conventions.

ChrsMark added 2 commits June 24, 2025 14:46
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark requested review from joaopgrassi and lmolkova June 24, 2025 11:50
@ChrsMark
Copy link
Copy Markdown
Member Author

@ChrsMark we have a bunch of metrics that use .active or some more suitable alternative to .count, so I was thinking about

- Use count instead of pluralization for UpDownCounters
+ Do not pluralize UpDownCounter names

with some examples using .count and others and explanation that it's a matter of consistency across conventions.

Ok, I'm fine with that. I updated the PR accordingly. If there are suggestions about the wording or more examples to add let me know.

Comment thread docs/general/naming.md Outdated
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Comment thread docs/general/naming.md Outdated
Comment thread docs/general/naming.md Outdated
Comment thread docs/general/naming.md Outdated
Comment thread docs/general/naming.md Outdated
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
@ChrsMark ChrsMark requested a review from lmolkova June 30, 2025 08:00
@ChrsMark
Copy link
Copy Markdown
Member Author

Thank's @lmolkova , your comments should be addressed now, please take another look.

@joaopgrassi
Copy link
Copy Markdown
Member

joaopgrassi commented Jul 1, 2025

@ChrsMark I think all comments are solved now, so I resolved them. I think we are good to merge this now. CC @lmolkova

@lmolkova lmolkova added this pull request to the merge queue Jul 1, 2025
Merged via the queue into open-telemetry:main with commit b32b0d9 Jul 1, 2025
14 checks passed
spurplewang pushed a commit to spurplewang/semantic-conventions that referenced this pull request Jul 10, 2025
Signed-off-by: ChrsMark <chrismarkou92@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Clarify .count guidance for UpDownCounters

9 participants