-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Update Documentation for Internal Metric Naming Conventions #5178
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update Documentation for Internal Metric Naming Conventions #5178
Conversation
tiffany76
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great job! I added short code formatting for the call-out to match others on the page.
I also think this note would be better placed further down where the list of metrics occurs. Right about line 189 should do it.
|
Hi @tiffany76, |
|
/fix:format |
|
You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10819988623 |
|
IMPORTANT: (RE-)RUN
|
|
LGTM, @Tharanishwaran! Thanks for your contribution. @open-telemetry/collector-approvers, PTAL. |
codeboten
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @Tharanishwaran! Added a note, the prefix was not applied to internal metrics emitted via OTLP
Co-authored-by: Alex Boten <[email protected]>
|
Many thanks to @tiffany76, @codeboten for your useful comments and taking the time to review the changes. I am glad that the checks passed and the PR finally got approval. If possible, one of the maintainers kindly goes ahead and merges the PR. Truly I appreciate the time and your support |
|
Thank you @Tharanishwaran for calling it out, we have run into the same issue in 0.106 & 0.107 |
Co-authored-by: Yang Song <[email protected]>
|
Thank you @songy23 for your comment I’ve implemented the suggested change regarding the otelcol_ prefix |
tiffany76
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One tiny change.
|
/fix:format |
|
You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10838462302 |
|
IMPORTANT: (RE-)RUN
|
|
/fix:all |
|
You triggered fix:all action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10842811641 |
|
IMPORTANT: (RE-)RUN
|
This PR updates the documentation to clarify the internal metric naming conventions for the OpenTelemetry Collector.
Changes:
Added a note to explain:
1.Starting from v0.106.1: Metrics from Collector components are prefixed with otelcol_, while metrics from
instrumentation libraries are not prefixed.
This update ensures that users understand the changes in metric naming conventions across different versions of the Collector.
Related Issue:
Fixes #4933