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]>
opentelemetrybot
requested review from
a team and
atoulme
and removed request for
a team
tiffany76
left a comment
tiffany76
left a comment
There was a problem hiding this comment.
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]>
mx-psi
left a comment
mx-psi
left a comment
There was a problem hiding this comment.
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
|
tiffany76
left a comment
tiffany76
left a comment
There was a problem hiding this comment.
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.
7 participants
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