mirrors/kube-prometheus
1
0
Fork 0
mirror of https://github.com/prometheus-operator/kube-prometheus.git synced 2025-10-28 22:51:02 +01:00
Code Issues Projects Releases Wiki Activity

hints and notes added to handle grafana dashboards

Browse Source 
Added some comments to the doc, to:
- Point the directory where make generate should be executed from
- Mention that the dashboard file should be suffixed with "-dashboard.json".
- Added hints to apply the new configMap and restart grafana
This commit is contained in:
eedugon 2017-08-02 11:37:22 +02:00 committed by GitHub
parent 29d696ca08
commit f201c79f5d
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/developing-alerts-and-dashboards.md
View File

@ -6,6 +6,8 @@ For both, the Prometheus alerting rules as well as the Grafana dashboards, there
The source of truth for the alerts and dashboards are the files in the `assets/` directory. The respective files have to be changed there and then the `make generate` make target is executed to re-generate the Kubernetes manifests. The source of truth for the alerts and dashboards are the files in the `assets/` directory. The respective files have to be changed there and then the `make generate` make target is executed to re-generate the Kubernetes manifests.
Note: `make generate` should be executed from kube-prometheus base directory.
## Alerts ## Alerts
The `ConfigMap` that is generated and holds the alerting rule files can be found in `manifests/prometheus/prometheus-k8s-rules.yaml`. The `ConfigMap` that is generated and holds the alerting rule files can be found in `manifests/prometheus/prometheus-k8s-rules.yaml`.
@ -22,6 +24,12 @@ The `ConfigMap` that is generated and holds the dashboard definitions can be fou
As Grafana's support for applying dashboards from files is limited a sidecar (called "grafana-watcher") was implemented. It watches the dashboard definitions provided through the `ConfigMap` and ensures that Grafana's SQLite database is in sync with the dashboard definitions. As Grafana's support for applying dashboards from files is limited a sidecar (called "grafana-watcher") was implemented. It watches the dashboard definitions provided through the `ConfigMap` and ensures that Grafana's SQLite database is in sync with the dashboard definitions.
To edit/create a dashboard login to Grafana and modify and save the dashboard. Then download the dashboard definition in Grafana through `Share` -> `Export` -> `Save to file`. Move the file to `assets/grafana/` and re-generate the manifests. To edit/create a dashboard login to Grafana and modify and save the dashboard. Then download the dashboard definition in Grafana through `Share` -> `Export` -> `Save to file`. Move the file to `assets/grafana/` and re-generate the manifests (executing `make generate` from kube-prometheus base directory).
Then the generated manifest can be applied against a Kubernetes cluster. Note: The dashboard json file to be copied in `assets/grafana/` should be suffixed with `-dashboard.json`, otherwise it won't be processed by `make generate`.
Then the generated manifest can be applied against a Kubernetes cluster with something like:
`kubectl -n monitoring apply -f manifests/grafana/grafana-dashboards.yaml`
And to apply the changes, restart grafana:
`kubectl -n monitoring delete pod -l app=grafana`