Document customizing Grafana dashboards

This commit is contained in:
Catherine Luse
2021-06-26 17:36:37 -07:00
parent 2dad6c5f4b
commit 0fb6252c7b
2 changed files with 38 additions and 6 deletions
@@ -1,5 +1,5 @@
---
title: Prometheus Expression Reference
title: PromQL Expression Reference
weight: 6
aliases:
- /rancher/v2.5/en/project-admin/tools/monitoring/expression
@@ -11,7 +11,7 @@ aliases:
The PromQL expressions in this doc can be used to configure alerts.
For more information about querying Prometheus, refer to the official [Prometheus documentation.](https://prometheus.io/docs/prometheus/latest/querying/basics/)
For more information about querying the Prometheus time series database, refer to the official [Prometheus documentation.](https://prometheus.io/docs/prometheus/latest/querying/basics/)
<!-- TOC -->
@@ -5,16 +5,48 @@ weight: 5
In this section, you'll learn how to customize the Grafana dashboard to show metrics that apply to a certain container.
In the left navigation bar, click the icon with four boxes and click **Manage.**
### Prerequisites
Before you can customize a Grafana dashboard, the `rancher-monitoring` application must be installed.
To see the links to the external monitoring UIs, including Grafana dashboards, you will need at least a [project-member role.]({{<baseurl>}}/rancher/v2.5/en/monitoring-alerting/rbac/#users-with-rancher-cluster-manager-based-permissions)
### Signing in to Grafana
1. In the Rancher UI, go to the cluster that has the dashboard you want to customize.
1. In the left navigation menu, click **Monitoring.**
1. Click **Grafana.** The Grafana dashboard should open in a new tab.
1. Go to the log in icon in the lower left corner and click **Sign In.**
1. Log in to Grafana. The default Admin username and password for the Grafana instance is `admin/prom-operator`. (Regardless of who has the password, cluster administrator permission in Rancher is still required access the Grafana instance.) Alternative credentials can also be supplied on deploying or upgrading the chart.
### Getting the PromQL Query Powering a Grafana Panel
For any panel, you can click the title and click **Explore** to get the PromQL queries powering the graphic.
For this example, we would like to get the CPU usage for the Alertmanager container, so we click **CPU Utilization > Inspect.**
1. The **Data** tab shows the underlying data as a time series, with the time in first column and the PromQL query result in the second column. Copy the PromQL query.
```
(1 - (avg(irate({__name__=~"node_cpu_seconds_total|windows_cpu_time_total",mode="idle"}[5m])))) * 100
```
### Modifying an Existing Grafana Panel
1. Open the Grafana dashboard.
### Creating a New Grafana Panel in a Dashboard
- lets say you want metrics that apply only for the container alertmanager.
- link to the promql queries used to make grafana dashboards. To get those queries,
- go to grafana
- right click on a graphic and click explore
- it shows you the PromQL queries that are embedded in it
- show screenshot of how to get to explore
- show screenshot of how to modify the query
- can modify it
- grafana shows you updated based on your modifications to the query
- customizing grafana dashboards section
- also link to persisting grafana dashboards section