Skip to content
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

Remove mention of internal telemetry that does not exist #5483

Closed
jade-guiton-dd opened this issue Oct 25, 2024 · 4 comments · Fixed by #5567
Closed

Remove mention of internal telemetry that does not exist #5483

jade-guiton-dd opened this issue Oct 25, 2024 · 4 comments · Fixed by #5567
Labels
bug Something isn't working help wanted Extra attention is needed sig:collector

Comments

@jade-guiton-dd
Copy link
Contributor

jade-guiton-dd commented Oct 25, 2024

What needs to be changed?

The "Values observable with internal metrics" section in the Collector "Internal telemetry" page (docs/collector/internal-telemetry) mentions a number of metrics which (as far as I know) are not actually implemented, or listed in the detailed table of metrics below. To list some: data reception / export rates in bytes, data drop rates caused by throttling / invalid data, incoming connection rate, queue size in bytes, end-to-end and per-component latency, etc.

It looks like this list was taken from an old "Observability Vision" document added to the core repo years ago, and the wording somehow changed from "these values need to be observable" to "these values are observable" along the way. (Thank you to @mx-psi for finding this PR.)

The simplest solution would be to delete the section, and let people rely on the table below it. A more involved solution would be to rewrite the section to only include things that actually ended up being implemented. We may want to keep the current contents around somewhere to serve as a roadmap for future new internal metrics.

@svrnm
Copy link
Member

svrnm commented Oct 25, 2024

@open-telemetry/collector-approvers ptal

@hyang023
Copy link
Contributor

hyang023 commented Oct 31, 2024

+1 that this documentation was extremely misleading and needs updating
I spent a signficant amount of time looking for these nonexistent collector latency metrics

@tiffany76 tiffany76 added the help wanted Extra attention is needed label Nov 2, 2024
@jpkrohling
Copy link
Member

@jade-guiton-dd, you probably have the best context right now about what we actually have there available at the moment. Would you be open to adjusting this page?

@jade-guiton-dd
Copy link
Contributor Author

jade-guiton-dd commented Nov 8, 2024

Sure, I can make the change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working help wanted Extra attention is needed sig:collector
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

5 participants