mirror of
https://github.com/ceph/ceph
synced 2024-12-22 03:22:00 +00:00
ecaf9070ae
As this new version is recently released it's still not in every distro we use. We now build jsonnet from source so that we can use this new version of jsonnet. This commit could be reverted later on when the new version would be available everywhere. Signed-off-by: Arthur Outhenin-Chalandre <arthur.outhenin-chalandre@cern.ch>
53 lines
2.3 KiB
Markdown
53 lines
2.3 KiB
Markdown
## Prometheus Monitoring Mixin for Ceph
|
|
A set of Grafana dashboards and Prometheus alerts for Ceph.
|
|
|
|
All the Grafana dashboards are already generated in the `dashboards_out`
|
|
directory and alerts in the `prometheus_alerts.yaml` file.
|
|
|
|
You can use the Grafana dashboards and alerts with Jsonnet like any other
|
|
prometheus mixin. You can find more ressources about mixins in general on
|
|
[monitoring.mixins.dev](https://monitoring.mixins.dev/).
|
|
|
|
### Grafana dashboards for Ceph
|
|
In `dashboards_out` you can find a collection of
|
|
[Grafana](https://grafana.com/grafana) dashboards for Ceph Monitoring.
|
|
|
|
These dashboards are based on metrics collected
|
|
from [prometheus](https://prometheus.io/) scraping the [prometheus mgr
|
|
plugin](http://docs.ceph.com/en/latest/mgr/prometheus/) and the
|
|
[node_exporter](https://github.com/prometheus/node_exporter).
|
|
|
|
#### Requirements
|
|
|
|
- [Status Panel](https://grafana.com/plugins/vonage-status-panel) installed on
|
|
your Grafana instance
|
|
- [Pie Chart Panel](https://grafana.com/grafana/plugins/grafana-piechart-panel/)
|
|
installed on your Grafana instance
|
|
|
|
|
|
### Prometheus alerts
|
|
In `prometheus_alerts.yaml` you'll find a set of Prometheus
|
|
alert rules that should provide a decent set of default alerts for a
|
|
Ceph cluster. Just put this file in a place according to your Prometheus
|
|
configuration (wherever the `rules` configuration stanza points).
|
|
|
|
#### SNMP
|
|
Ceph provides a MIB (CEPH-PROMETHEUS-ALERT-MIB.txt) to support sending Prometheus
|
|
alerts through to an SNMP management platform. The translation from Prometheus
|
|
alert to SNMP trap requires the Prometheus alert to contain an OID that maps to
|
|
a definition within the MIB. When making changes to the Prometheus alert rules
|
|
file, developers should include any necessary changes to the MIB.
|
|
|
|
### Building from Jsonnet
|
|
|
|
- Install [jsonnet](https://jsonnet.org/) (at least v0.18.0)
|
|
- By installing the package `jsonnet` in most of the distro and
|
|
`golang-github-google-jsonnet` in fedora
|
|
- Install [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler)
|
|
|
|
To rebuild all the generated files, you can run `tox -egrafonnet-fix`.
|
|
|
|
The jsonnet code located in this directory depends on some Jsonnet third party
|
|
libraries. To update those libraries you can run `jb update` and then update
|
|
the generated files using `tox -egrafonnet-fix`.
|