monitoring documentation, prometheus config, grafana dashboard

2020-10-21 15:38:48 +03:00
parent d9b05233b0
commit 909c85b547
6 changed files with 372 additions and 2 deletions
@@ -98,6 +98,16 @@ TODO: Add the rest of the standard endpoints add unique endpoints (e.g. getSlice
 `make test` will run the unit tests  
 `make test` setups a clean `vulcanize_testing` db

+## Monitoring
+
+* Enable http server and metrics using parameters `--http --metrics`
+* ipld-eth-server exposes prometheus metrics at `/metric` endpoint
+* start prometheus using `monitoring/prometheus.yml` config (`prometheus --config.file=monitoring/prometheus.yml`)
+* start grafana, connect to prometheus datasource and import dashboard from `monitoring/grafana/dashboard_main.json`
+
+![](monitoring/grafana.png)
+
+
 ## Contributing
 Contributions are welcome!