elastic / elastic/docs-content

Improve documentation for controller manager metrics

Open
#1,883 7 comments 0 reactions 0 assignees View on GitHub
Team:Ingest
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 21h
Merged PRs (30d)
141

Description

## 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](https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-module-kubernetes.html). However, this is not enough to understand all the metrics and the meaning of each one in [here](https://www.elastic.co/guide/en/beats/metricbeat/current/exported-fields-kubernetes.html#_controllermanager) 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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.