Skip to content

Commit 95a15a3

Browse files
Add dashboard to Grafana community built dashboards (#3)
Add dashboard to Grafana Official & community built dashboards. Rework README to describe import from Grafana Official & community built dashboards, separate build section cause it is not a obligatory stage for using dashboard now.
2 parents 6857f69 + 7bf83a5 commit 95a15a3

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,25 @@
11
# Tarantool Grafana dashboard
22

3+
Dashboard for Tarantool application and database server monitoring, based on [grafonnet](https://github.com/grafana/grafonnet-lib) library.
4+
5+
Our pages on Grafana Official & community built dashboards: [InfluxDB](https://grafana.com/grafana/dashboards/12567).
6+
7+
You can find screenshots and short description of contents on Grafana pages.
8+
9+
# How to import
10+
11+
* Open Grafana import menu.
12+
13+
![Grafana import button in v6.6.0](./docs/grafana_import_v6.png)
14+
15+
* Paste dashboard id (`12567` for InfluxDB) or link to dashboard (https://grafana.com/grafana/dashboards/12567 for InfluxDB) or upload json file (download it from Grafana page: [InfluxDB](https://grafana.com/grafana/dashboards/12567); or build it by yourself).
16+
17+
* Set dashboard name, folder, uid (if needed), and metrics database parameters (i.e., InfluxDB source and measurement).
18+
19+
![Grafana import setup in v6.6.0 for InfluxDB](./docs/grafana_import_setup_v6.png)
20+
21+
# How to build
22+
323
## Requirements and setup
424

525
1. Install [go-jsonnet](https://github.com/google/go-jsonnet) compiler. We use v0.16.0.
@@ -12,13 +32,11 @@
1232

1333
```docker-compose up -d``` will start 5 containers: Tarantool, Telegraf, InfluxDB, Prometheus and Grafana, which build cluster with two fully operational metrics datasources (InfluxDB and Prometheus), extracting metrics from Tarantool instance. We recommend using the exact versions we use in experimental cluster (e.g. Grafana v6.6.0).
1434

15-
## Usage
16-
17-
Currently we provide only InfluxDB-based dashboard template.
35+
## How to compile dashboard
1836

1937
### InfluxDB dashboard
2038

21-
* Compile board template with
39+
Compile board template with
2240
```bash
2341
jsonnet -J ./vendor/ ./tarantool/dashboard.libsonnet -o ./output.json
2442
```
@@ -28,16 +46,6 @@ jsonnet -J ./vendor/ ./tarantool/dashboard.libsonnet | xclip -selection clipboar
2846
```
2947
to put json template into clipboard.
3048

31-
* Open Grafana import menu.
32-
33-
![Grafana import button in v6.6.0](./docs/grafana_import_v6.png)
34-
35-
* Paste json template from clipboard or upload json template file.
36-
37-
* Set dashboard name, folder, uid (if needed), InfluxDB source and measurement of your project's metrics.
38-
39-
![Grafana import setup in v6.6.0](./docs/grafana_import_setup_v6.png)
40-
4149
## Tests
4250

4351
You can run tests with `./tests.sh` script. `jsonnet` and `jsonnetfmt` must be added to terminal PATH variable.

0 commit comments

Comments
 (0)