-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Update internal-telemetry.md #6799
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
Conversation
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.
Looking good! I added some suggestions for clarity. Once we get the content ready, we can tackle the CI.
original `http*` and `rpc*` metric names with dots are preserved. The | ||
[internal metrics](#lists-of-internal-metrics) on this page are listed in their | ||
original form, such as`rpc.server.duration`. For more information, see the |
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.
I've preemptively added this statement, but I can also remove it. @songy23 or @jade-guiton-dd, do you have any thoughts on whether we should change the http*
and rpc*
metrics to have dots in the list of metrics below?
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.
I think it would make sense to change them to dots. This should be less confusing for users exporting internal metrics through OTLP, and hopefully Prometheus exporter users will read through the new section.
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.
Note: the underscores in requests_per_rpc
, responses_per_rpc
, active_requests
, open_connections
are part of the original metric names and shouldn't be replaced by dots (reference 1, reference 2).
While checking this, I noticed that the list of http_
metrics is already completely outdated since I updated it 7 months ago... I'll file a separate PR later to update them
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, @jade-guiton-dd! Sorry for the delay. I was away for a few days and am still catching up. I'll make the changes to this PR this week so we can get your follow-up PR merged as well.
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.
I've made the underscore-to-dot changes, @jade-guiton-dd. Thanks!
Signed-off-by: tiffany76 <30397949+tiffany76@users.noreply.github.com>
Thank you for your contribution @BeverlyJaneJ! 🎉 We would like to hear from you about your experience contributing to OpenTelemetry by taking a few minutes to fill out this survey. |
Per this issue:
Created a new section on metric naming to clarify that some metrics have a suffix added as a result of the Prometheus exporter, and others have the dot replaced with an underscore.
Preview: https://deploy-preview-6799--opentelemetry.netlify.app/docs/collector/internal-telemetry/