Create a new OOTB dashboard ( pod metrics) with templating variable
Problem to solve
We added a pod metrics dashboard a few milestones back. It was not made visible to users because it required support for variables. Once #214539 (closed) is done, we can add a pod_name
variable to the pod metrics dashboard.
Intended users
User experience goal
When a user opens the metrics dashboard, they are taken to the default dashboard. This issue will add another out-of-the-box dashboard that users can view. The default dashboard will remain unchanged. Users will have a new "Pod metrics" dashboard visible in the dashboards dropdown selector.
This dashboard will support both external and internal Prometheus instance
Proposal
-
Add a templating variable to the pod metrics dashboard like the following:
templating: variables: pod_name: label: 'Pod name' type: metric_label_values options: query: 'container_memory_working_set_bytes' label: 'pod_name'
This should create a dropdown selector on the metrics dashboard UI which will contain the names of all pods of the cluster. Choosing a pod from the dropdown should change the dashboard to show data from that pod.
-
Make this dashboard visible in the dashboard dropdown selector.
Further details
The pod metrics dashboard will allow users to view charts showing the CPU, memory, network and disk related metrics for all pods in their K8s cluster. We have a dashboard which shows memory and CPU usage but only for pods which contain the deployed application.
Documentation
Availability & Testing
What does success look like, and how can we measure that?
A new OOTB dashboard is available (alongside our "Default dashboard"
On that dashboard, users can see a new pod metrics dashboard, which shows memory, cpu, disk and network metrics for all pods in the K8s cluster. Adding alerts will not be possible since these metrics have not been added to the database.