|
1 | 1 | # Checkmk data source |
2 | 2 |
|
3 | | - |
| 3 | +[](https://www.grafana.com) |
| 4 | +[](https://grafana.com/grafana/plugins/checkmk-cloud-datasource) |
| 5 | +[](https://github.com/Checkmk/grafana-checkmk-datasource) |
| 6 | +[](https://github.com/Checkmk/grafana-checkmk-datasource/actions/workflows/ci.yml?query=event%3Aschedule) |
4 | 7 |
|
5 | | -This is a [Grafana][1] [data source][2] plugin for visualizing Checkmk metrics |
6 | | -in Grafana. |
7 | 8 |
|
8 | | -The plugin requires Checkmk >= 2.1.0 and Grafana >= 8.0 |
9 | | -(It is possible query data from Checkmk >= 2.0.0p20 but host and service |
10 | | -dropdowns are not constrained by other active filters and single metric graphs |
11 | | -do not work with Checkmk Raw Edition) |
| 9 | + |
| 10 | +## Introduction |
12 | 11 |
|
13 | | -All Checkmk Editions are supported by this plugin, but with different query |
14 | | -interface as the Enterprise Edition has a more comprehensive filtering engine. |
| 12 | +This [data source][2] plugin for [Grafana][1] allows to address Checkmk as source and to display individual metrics in Grafana. |
15 | 13 |
|
16 | | -Please consult the chapter ["Integrating Checkmk in Grafana"][3] in the |
17 | | -official Checkmk documentation on how to use this plugin. |
| 14 | +## Requirements |
18 | 15 |
|
19 | | - |
| 16 | +To make use of the plugin, you need to take care the correct versions are installed. You need to match both, the Grafana and the Checkmk version: |
| 17 | + |
| 18 | +- **Grafana 8.0.0 or higher** |
| 19 | +- **Checkmk Cloud Edition 2.2.0 or higher** for the signed plugin available from [Grafana][6] |
| 20 | +- **Checkmk 2.1.0 or higher** for the unsigned plugin available from [Github][8] |
| 21 | + |
| 22 | +## Installing the plug-in |
| 23 | + |
| 24 | +The signed plug-in can be installed from the [Grafana marketplace][6] or by using the `grafana-cli`: |
| 25 | + |
| 26 | +```bash |
| 27 | +grafana-cli plugins install checkmk-cloud-datasource |
| 28 | +``` |
| 29 | + |
| 30 | +For the installation of the unsigned plugin, please take a look at the official [Checkmk user guide][3]. |
| 31 | + |
| 32 | +## Official documentation |
| 33 | + |
| 34 | +For detailed information regarding the installation, configuration and usage, |
| 35 | +please consult the official [Checkmk User Guide][3]. |
| 36 | + |
| 37 | +## Further information |
20 | 38 |
|
21 | 39 | See [CHANGELOG.md][4] for information about updating from previous |
22 | 40 | versions. |
23 | 41 |
|
24 | 42 | See [DEVELOPMENT.md][5] for information about how to test, build and |
25 | 43 | release this software. |
26 | 44 |
|
| 45 | +## License |
| 46 | + |
| 47 | +This project is using the [Apache-2.0 license][7]. |
| 48 | + |
27 | 49 | [1]: https://grafana.com/grafana/ |
28 | 50 | [2]: https://grafana.com/docs/grafana/latest/datasources/ |
29 | 51 | [3]: https://docs.checkmk.com/latest/en/grafana.html |
30 | 52 | [4]: https://github.com/checkmk/grafana-checkmk-datasource/blob/main/CHANGELOG.md |
31 | 53 | [5]: https://github.com/checkmk/grafana-checkmk-datasource/blob/main/DEVELOPMENT.md |
| 54 | +[6]: https://grafana.com/grafana/plugins/checkmk-cloud-datasource/ |
| 55 | +[7]: https://github.com/checkmk/grafana-checkmk-datasource/blob/main/LICENSE |
| 56 | +[8]: https://github.com/Checkmk/grafana-checkmk-datasource |
0 commit comments