Skip to content

Commit 5f75001

Browse files
DifferentialOrangevasiliy-t
authored andcommitted
Add README with requirements and usage guide
1 parent 386be0a commit 5f75001

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

README.md

Lines changed: 43 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,43 @@
1-
# tarantool-dashboard
2-
tarantool grafana dashboard
1+
# Tarantool Grafana dashboard
2+
3+
## Requirements and setup
4+
5+
1. Install [go-jsonnet](https://github.com/google/go-jsonnet) compiler. We use v0.16.0.
6+
7+
1. Install [jsonnet-bundler](https://github.com/jsonnet-bundler/jsonnet-bundler) package manager.
8+
9+
1. Install jsonnet package dependencies with ```jb install```.
10+
11+
## Experimantal cluster
12+
13+
```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).
14+
15+
## Usage
16+
17+
Currently we provide only InfluxDB-based dashboard template.
18+
19+
### InfluxDB dashboard
20+
21+
* Compile board template with
22+
```bash
23+
jsonnet -J ./vendor/ ./tarantool/dashboard.libsonnet -o ./output.json
24+
```
25+
to save json template into `output.json` file or
26+
```bash
27+
jsonnet -J ./vendor/ ./tarantool/dashboard.libsonnet | xclip -selection clipboard
28+
```
29+
to put json template into clipboard.
30+
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+
41+
## Tests
42+
43+
You can run tests with `./tests.sh` script. `jsonnet` and `jsonnetfmt` must be added to terminal PATH variable.

docs/grafana_import_setup_v6.png

34.1 KB
Loading

docs/grafana_import_v6.png

12.9 KB
Loading

0 commit comments

Comments
 (0)