-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Collector telemetry lifecycle #5092
Collector telemetry lifecycle #5092
Conversation
This is an initial attempt at documenting the lifecycle of telemetry emitted by the Collector. Fixes open-telemetry/opentelemetry-collector#10003 Signed-off-by: Alex Boten <[email protected]>
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 for putting this together! I've made a few inline suggestions.
I also think it makes sense to shift this section up a hierarchical level, so the first heading would be "## Telemetry lifecycle". And then we can position it below Events observable with internal logs, so we don't break up the Types of internal telemetry section. Happy to discuss.
Co-authored-by: Tiffany Hrabusa <[email protected]>
Co-authored-by: Patrice Chalin <[email protected]>
Co-authored-by: Tiffany Hrabusa <[email protected]>
Reviving my comment about the information architecture, I think this section needs to be shifted one hierarchical level higher and positioned below the Events observable with internal logs section. Right now, it is inserted into the Types of internal telemetry section. I think it works better as its own ##-level section, right before Use internal telemetry to monitor the Collector. |
Co-authored-by: Tiffany Hrabusa <[email protected]>
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 this looks good to me for a first version. At some point I would like to define how the transition between states works, but I don't think we need that right now
@tiffany76 I don't have a strong preference here, happy to move this if it will move this PR along |
@codeboten You can move it in this PR, or I can follow up with an IA PR once this one is merged. It's up to you. |
/fix:format |
You triggered fix:format action run at https://github.com/open-telemetry/opentelemetry.io/actions/runs/10912550443 |
IMPORTANT: (RE-)RUN
|
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.
Approving and setting this as "ready to be merged." Once a docs maintainer gets to it, I'll follow up with a PR to move the section. No need to hold this one up.
This is an initial attempt at documenting the lifecycle of telemetry emitted by the Collector.
Fixes open-telemetry/opentelemetry-collector#10003
Pinging @open-telemetry/collector-approvers for reviews on this
Preview: https://deploy-preview-5092--opentelemetry.netlify.app/docs/collector/internal-telemetry/#telemetry-lifecycle