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

Improve documentation for controller manager metrics #2474

Open
constanca-m opened this issue Jan 5, 2023 · 4 comments
Open

Improve documentation for controller manager metrics #2474

constanca-m opened this issue Jan 5, 2023 · 4 comments
Assignees

Comments

@constanca-m
Copy link
Contributor

constanca-m commented Jan 5, 2023

Problem

When users try to monitor their Kubernetes application, they don't have a way to understand our predefined dashboards without having solid knowledge about Kubernetes.

Right now, the documentation for that can be found in this page. However, this is not enough to understand all the metrics and the meaning of each one in here doesn't it make it clearer.

Solution

Create a new documentation that highlights the metrics available on the controller manager dataset and which problems we can detect with those. With this new document we can expect to have the answer for these type of questions:

  • What can we conclude from the unfinished work of some workqueue? What does that mean?
  • Why is it important to track the CPU time spent?
  • What is the take away on resident memory variations?

This new page would use visualizations to make the answer for these type of questions more clear. This page should not use the predefined dashboard, as a change on it would require an update to this page.

@constanca-m constanca-m self-assigned this Jan 5, 2023
@constanca-m constanca-m changed the title Improve documentation for Kubernetes metrics used by controller manager Improve documentation for controller manager metrics Jan 5, 2023
@gizas
Copy link
Contributor

gizas commented Jan 11, 2023

Constanca do you think this issue and this elastic/integrations#4886 can be combined into one?

@constanca-m
Copy link
Contributor Author

I think so @gizas , but since we haven't decided on a common structure, I think it is better to start with just one thing and see if it is worth it.

@rameshelastic
Copy link

@constanca-m , is this issue being worked on?

@constanca-m
Copy link
Contributor Author

It is not @rameshelastic. I am only working on TSDB now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants