From 8fd45048a48e5983c9ec20472a34cdbe196f7d27 Mon Sep 17 00:00:00 2001 From: ryan Date: Wed, 24 Feb 2016 11:17:34 +0100 Subject: [PATCH] add loading text to monitoring documentation --- docs/source/monitoring.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/docs/source/monitoring.md b/docs/source/monitoring.md index db794a62..436a42aa 100644 --- a/docs/source/monitoring.md +++ b/docs/source/monitoring.md @@ -1,6 +1,6 @@ # Monitoring -BigchainDB uses [statsd](https://github.com/etsy/statsd) for monitoring. To fully take advantage of this functionality requires some additional infrastructure: an agent to listen for metrics (e.g. [telegraf](https://github.com/influxdata/telegraf)), a time-series database (e.g. [influxdb](https://influxdata.com/time-series-platform/influxdb/), and a frontend to display analytics (e.g. [Grafana](http://grafana.org/)). +BigchainDB uses [statsd](https://github.com/etsy/statsd) for monitoring. To fully take advantage of this functionality requires some additional infrastructure: an agent to listen for metrics (e.g. [telegraf](https://github.com/influxdata/telegraf)), a time-series database (e.g. [influxdb](https://influxdata.com/time-series-platform/influxdb/)), and a frontend to display analytics (e.g. [Grafana](http://grafana.org/)). 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: @@ -9,7 +9,13 @@ $ 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](installing.html#run-bigchaindb) and refresh the page after a few seconds. +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](installing.html#run-bigchaindb) and load some test transactions: + +```text +$ 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.