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

Collector telemetry lifecycle #5092

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

codeboten
Copy link
Contributor

@codeboten codeboten commented Aug 22, 2024

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

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 <223565+codeboten@users.noreply.github.com>
@codeboten codeboten requested a review from a team August 22, 2024 21:40
@opentelemetrybot opentelemetrybot requested review from a team and atoulme and removed request for a team August 22, 2024 21:40
Copy link
Contributor

@tiffany76 tiffany76 left a 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.

content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
content/en/docs/collector/internal-telemetry.md Outdated Show resolved Hide resolved
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
@opentelemetrybot opentelemetrybot requested a review from a team August 22, 2024 22:56
codeboten and others added 3 commits September 9, 2024 08:57
Co-authored-by: Patrice Chalin <chalin@users.noreply.github.com>
Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
@tiffany76
Copy link
Contributor

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.

Screenshot from 2024-09-09 17-06-39

Co-authored-by: Tiffany Hrabusa <30397949+tiffany76@users.noreply.github.com>
@opentelemetrybot opentelemetrybot requested a review from a team September 10, 2024 20:56
Copy link
Member

@mx-psi mx-psi left a 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

@opentelemetrybot opentelemetrybot requested a review from a team September 16, 2024 17:16
@codeboten
Copy link
Contributor Author

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.

@tiffany76 I don't have a strong preference here, happy to move this if it will move this PR along

@tiffany76
Copy link
Contributor

tiffany76 commented Sep 17, 2024

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.

@tiffany76
Copy link
Contributor

/fix:format

@opentelemetrybot
Copy link
Collaborator

@opentelemetrybot
Copy link
Collaborator

fix:format was successful.

IMPORTANT: (RE-)RUN /fix:all to ensure that there are no remaining check issues.

Copy link
Contributor

@tiffany76 tiffany76 left a 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Ready to be merged
Development

Successfully merging this pull request may close these issues.

[telemetry] Define lifecycle and stability of telemetry
6 participants