Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
bigchaindb/docs/source/monitoring.md
vrde 9d04018533
Update docs
2016-04-26 04:29:32 +02:00

1.8 KiB
Raw Blame History

Monitoring

BigchainDB uses StatsD for monitoring. We require some additional infrastructure to take full advantage of its functionality:

  • an agent to listen for metrics: Telegraf,
  • a time-series database: InfluxDB, and
  • a frontend to display analytics: Grafana.

We put each of those inside its own Docker container. The whole system is illustrated below.

BigchainDB monitoring system diagram: Application metrics flow from servers running BigchainDB to Telegraf to InfluxDB to Grafana

For ease of use, we've created a Docker Compose file (named docker-compose-monitor.yml) to define the monitoring system setup. To use it, just go to to the top bigchaindb directory and run:

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

then point a browser tab to:

http://localhost:3000/dashboard/script/bigchaindb_dashboard.js

The 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 load

then 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!