Add list of metrics by level to Collector's internal telemetry docs #4278
Labels
Comments
|
Pretty interesting change. Thanks for raising this, @tiffany76 ! @open-telemetry/collector-maintainers how would you like this information to be presented? What's the default state and under which circumstances would each level be used? |
|
Now that the Collector PR 9767 has been merged, I'm going to work on this issue in parallel with the other internal telemetry docs. I'll put up a fresh PR this week. @theletterf Thanks for posing those questions. @open-telemetry/collector-approvers, if you have any thoughts before I get started, please share! |
|
Hi folks, I need some help with this one. I've got my Collector instance up and running, and I'm feeding it telemetry with I've also checked the Semantic Conventions docs, but I don't see internal metrics called out. Where could I find or how could I generate a complete list of internal metrics? Relatedly, does the list of internal metrics change depending on which components are being used? And if so, do we want to list all internal metrics or only those that have a verbosity level other than the now-default |
|
@dmitryax @codeboten do we have an easy way to grep for this? |
|
Thanks to @theletterf's guidance, I have the process metrics file. Based on that file, I was able to grep for and find the following metrics: I know I'm missing the Next week, I'll pull everything I've found into a list and then compare it against the metrics my own Collector is emitting and against vendor distribution lists (see Splunk's and DataDog's). Then I'll put up a PR. If you think I over-included or missed anything, please let me know. Thanks! |
|
After considering this content, I think it fits in well with the documentation covered in the second internal observability PR (#4322), so rather than put up a separate PR for this issue, I'm solving it as part of the work I'm already doing. I've put up a table, but it's still a WIP. |
|
Just a note on this issue, there's work underway in the collector repo to generate documentation for all internal metrics produced automatically. You can see the result here: https://github.com/open-telemetry/opentelemetry-collector/blob/9cbcacca8d1a307317096ad7ed39d5f3acb10575/processor/batchprocessor/documentation.md It would be great at some point to pull in this data in the main docs, or link to it |
That's great news, @codeboten, and it will directly address @chalin's concern about maintaining the list I generated. I will keep an eye on your PR's progress, and then we'll see if we can rework the List of metrics section on opentelemetry.io. |
|
Raised an issue to explore the possibility of automating the list of metrics: #4523 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Desired feature or idea: The documentation for configuring internal metrics for the Collector should include a list of the metrics available at each level (basic, normal, detailed, etc.). Work is being done on this list in open-telemetry/opentelemetry-collector#9767. Once the list is finalized, it should be added to the website documentation.
Additional context:
The text was updated successfully, but these errors were encountered: