docs(telemetry): update telemetry payload documentation #400
Conversation
Update telemetry documentation to reflect the new split architecture:
- cozystack-operator collects cluster-level metrics
- cozystack-controller collects application-level metrics
Updated metrics:
- Added cozy_cluster_capacity for cpu, memory, GPU resources
- Added cozy_package_info for installed packages
- Added cozy_application_count for application instances
- Removed cozy_workloads_count (replaced by cozy_application_count)
- Removed cozy_tenants_count (now counted as cozy_application_count{kind="Tenant"})
- Removed bundle/oidc labels from cozy_cluster_info
Co-Authored-By: Claude <noreply@anthropic.com>
Signed-off-by: Andrei Kvapil <kvapss@gmail.com>
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for cozystack ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Summary of ChangesHello @kvaps, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request updates the telemetry documentation to align with a new split architecture, where telemetry data is collected by both Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request effectively updates the telemetry documentation to align with the new split architecture, separating metrics from cozystack-operator and cozystack-controller. The new metrics like cozy_cluster_capacity and cozy_package_info are well-documented, and the payload examples are updated clearly. My review includes a minor suggestion to improve the grammar in one sentence for better readability. Overall, the changes are accurate and improve the documentation.
| ### Example of Telemetry Payload: | ||
|
|
||
| Below is how a typical telemetry payload looks like in Cozystack: | ||
| Below is how a typical telemetry payload looks like in Cozystack. |
There was a problem hiding this comment.
For better readability and grammatical correctness, consider rephrasing this sentence. The construct "how ... looks like" is generally considered incorrect; "what ... looks like" or "how ... looks" are the preferred forms.
| Below is how a typical telemetry payload looks like in Cozystack. | |
| Below is an example of a typical telemetry payload in Cozystack. |
Summary
Update telemetry documentation to reflect the new split architecture between cozystack-operator and cozystack-controller.
Changes
cozy_cluster_capacitymetric (cpu, memory, GPU)cozy_package_infometric for installed packagescozy_workloads_countwithcozy_application_countcozy_tenants_count(nowcozy_application_count{kind="Tenant"})Related
Depends on: cozystack/cozystack#1869
Test plan