bigchaindb/docs/source/monitoring.md

1.3 KiB

Monitoring

BigchainDB uses statsd for monitoring. To fully take advantage of this functionality requires some additional infrastructure: an agent to listen for metrics (e.g. telegraf), a time-series database (e.g. influxdb), and a frontend to display analytics (e.g. Grafana).

For ease of use, we've provided a docker compose file that sets up all these services for testing. Simply run in the BigchainDB directory:

$ docker-compose -f docker-compose-monitor.yml build
$ docker-compose -f docker-compose-monitor.yml up

and point a browser tab to http://localhost:3000/dashboard/script/bigchaindb_dashboard.js. Login and password are admin by default. If BigchainDB is running and processing transactions, you should see analytics—if not, start BigchainDB and load some test transactions:

$ bigchaindb-benchmark load

and refresh the page after a few seconds.

If you're not interested in monitoring, don't worry: BigchainDB will function just fine without any monitoring setup.

Feel free to modify the custom Grafana dashboard to your liking!