Skip to content

Commit

Permalink
Replace duplicate info with doc link. Add screenshots to README
Browse files Browse the repository at this point in the history
Closes #37 (with doc)
  • Loading branch information
DifferentialOrange committed Feb 5, 2021
1 parent ebc7efd commit 6d94278
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 17 deletions.
19 changes: 2 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,9 @@ Dashboard for Tarantool application and database server monitoring, based on [gr

Our pages on Grafana Official & community built dashboards: [InfluxDB](https://grafana.com/grafana/dashboards/12567), [Prometheus](https://grafana.com/grafana/dashboards/13054).

You can find screenshots and short description of contents on Grafana pages.
Refer to dashboard [documentation page](https://www.tarantool.io/en/doc/latest/book/monitoring/grafana_dashboard/) for prerequirements and installation guide.

# How to use

Guide on Tarantool project prerequirements and metrics collectors configuration can be found on corresponding Grafana Official & community built dashboards pages: [InfluxDB](https://grafana.com/grafana/dashboards/12567), [Prometheus](https://grafana.com/grafana/dashboards/13054).

# How to import

1. Open Grafana import menu.
<br/><br/>![Grafana import button in v6.6.0](./docs/grafana_import_v6.png)

1. Select one of the following options:
* Paste dashboard id: `12567` for InfluxDB, `13054` for Prometheus;
* Paste link to dashboard: https://grafana.com/grafana/dashboards/12567 for InfluxDB, https://grafana.com/grafana/dashboards/13054 for Prometheus;
* Upload json file or paste json file contents: download it from Grafana page ([InfluxDB](https://grafana.com/grafana/dashboards/12567), [Prometheus](https://grafana.com/grafana/dashboards/13054)) or build it by yourself.

1. Set dashboard name, folder, uid (if needed), and database-related query parameters (InfluxDB source, measurement and policy or Prometheus source, job and rate() time range).
<br/><br/>![Grafana import setup in v6.6.0 for InfluxDB](./docs/grafana_import_setup_v6.png)
<img src="./doc/monitoring/images/Prometheus_dashboard_1.png" width="310"/> <img src="./doc/monitoring/images/Prometheus_dashboard_2.png" width="310"/> <img src="./doc/monitoring/images/Prometheus_dashboard_3.png" width="310"/>

# How to build

Expand Down
Binary file removed docs/grafana_import_setup_v6.png
Binary file not shown.
Binary file removed docs/grafana_import_v6.png
Binary file not shown.

0 comments on commit 6d94278

Please sign in to comment.