-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
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 we should link this from the godoc on component
Co-authored-by: Pablo Baeyens <pbaeyens31+github@gmail.com>
7cd1d9c
to
07e9961
Compare
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.