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

[component] Status Reporting Documentation #10422

Merged
merged 4 commits into from
Jun 20, 2024

Conversation

mwear
Copy link
Member

@mwear mwear commented Jun 17, 2024

This PR adds documentation for the collector status reporting system. It describes the current state of the system and has a section for best practices that we intend to evolve as we develop them. The intended audience is future users of the system and anyone interested in getting a deeper look into how the system works without having to read all of the code. This is intended to be complementary to the in-progress RFC.

Here is a preview with the diagrams properly rendered.

Copy link

codecov bot commented Jun 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.35%. Comparing base (aa31b27) to head (07e9961).
Report is 15 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10422   +/-   ##
=======================================
  Coverage   92.35%   92.35%           
=======================================
  Files         386      386           
  Lines       18370    18408   +38     
=======================================
+ Hits        16965    17001   +36     
- Misses       1052     1053    +1     
- Partials      353      354    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mwear mwear changed the title [component] Status Reporting Documentation [chore] Status Reporting Documentation Jun 17, 2024
@codeboten codeboten added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Jun 17, 2024
@mwear mwear changed the title [chore] Status Reporting Documentation [component] Status Reporting Documentation Jun 17, 2024
@mwear mwear marked this pull request as ready for review June 18, 2024 02:37
@mwear mwear requested review from a team and mx-psi June 18, 2024 02:37
@mx-psi mx-psi requested a review from TylerHelmuth June 18, 2024 10:40
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 we should link this from the godoc on component

docs/component-status.md Outdated Show resolved Hide resolved
@mx-psi mx-psi merged commit 3ffb41e into open-telemetry:main Jun 20, 2024
49 checks passed
@github-actions github-actions bot added this to the next release milestone Jun 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog PRs that do not require a CHANGELOG.md entry
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants