easylinux/kube-prometheus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Hints and notes added to handle grafana dashboards (#534)

Browse Source
This commit is contained in:
eedugon
2017-08-02 12:09:44 +02:00
committed by Frederic Branczyk
parent d34811cbe9
commit 66dd7b253d
2 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -79,6 +79,8 @@ sidecar container aims to emulate the behavior, by keeping the Grafana database
with the provided ConfigMap. Hence, the Grafana pod is effectively stateless. with the provided ConfigMap. Hence, the Grafana pod is effectively stateless.
This allows managing dashboards via `git` etc. and easily deploying them via CD pipelines. This allows managing dashboards via `git` etc. and easily deploying them via CD pipelines.
For information about how to update/handle the dashboards check [Developing alerts and dashboards](docs/developing-alerts-and-dashboards.md) doc.
In the future, a separate Grafana operator will support gathering dashboards from multiple In the future, a separate Grafana operator will support gathering dashboards from multiple
ConfigMaps based on label selection. ConfigMaps based on label selection.

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
```
That will update the ConfigMap `grafana-dashboards`. Change should be automatically detected by grafana-watcher and dashboards reloaded.