compliantkubernetes
compliantkubernetes copied to clipboard
elastisys
Update metrics documentation
Description:
We need to update the metrics documentation to make it clear for a developer wants to get started get all the pieces needed and involved. So that they can get the confidence and the know-how to create the required resources, and so they can inspect that what they create is actually picked up. Preferably also sending them to upstream documentation for specific details, rather than them being expected to trudge through all upstream documentation as a "further reading".
And this would be nice to have to make the user experience better: https://github.com/elastisys/compliantkubernetes-apps/issues/819
Definition of done:
Improved metrics documentation for developers.
Hi @aarnq . Can you clarify what is missing? I thought that this section should clarify what are the required Kubernetes resources. Is it difficult to see the forest for all the trees? :smile:
Hi, sure. :slightly_smiling_face: The main thing I want to see is that the whole process is explained for an application developer to start collect metrics for their own app, rather than only providing a limited example for something that is already prepared and is known to work. Since it doesn't tell the full story of what a developer needs to do to make it work. What does the app need to expose metrics, what is the best practice? What does Prometheus needs to scrape it (and point to the upstream spec for how to configured it, not just a limited example), how one can verify in CK8s that it is picked up, and what can one do in case it isn't?
And I think it would be good to give alerting the same treatment. Cause even though I think it does explains the process for setting up alerts better, it still misses links to the spec of the CRD and PromQL to write rules.
Thanks, understood! You are right, this page hasn't aged well compared to the other pages. I'll try to make some room for it, but no promises. :smile: Perhaps @davidumea can pick it up?
Thanks, understood! You are right, this page hasn't aged well compared to the other pages. I'll try to make some room for it, but no promises. smile Perhaps @davidumea can pick it up?
I might pick it up as part of a sprint unless someone else wants to do it :slightly_smiling_face:
