From 5bc591c6c40c7965b48cf261ae4da5199305c2b8 Mon Sep 17 00:00:00 2001 From: ryan Date: Tue, 23 Feb 2016 16:14:27 +0100 Subject: [PATCH] reorganize documentation --- README.md | 17 ----------------- docs/source/index.rst | 1 + docs/source/monitoring.md | 16 ++++++++++++++++ 3 files changed, 17 insertions(+), 17 deletions(-) create mode 100644 docs/source/monitoring.md diff --git a/README.md b/README.md index bd1a06e6..948b879c 100644 --- a/README.md +++ b/README.md @@ -79,20 +79,3 @@ $ bigchaindb show-config ``` $ py.test -v ``` - -#### 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/)). - -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: - -```sh -$ 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 as above, 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](https://github.com/rhsimplex/grafana-bigchaindb-docker/blob/master/bigchaindb_dashboard.js) to your liking! \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index f8ef2a32..d15ff99b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -21,6 +21,7 @@ Table of Contents models json-serialization developer-interface + monitoring contributing faq release-notes diff --git a/docs/source/monitoring.md b/docs/source/monitoring.md new file mode 100644 index 00000000..7fee3620 --- /dev/null +++ b/docs/source/monitoring.md @@ -0,0 +1,16 @@ +# 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/)). + +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: + +```text +$ 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 as above, 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](https://github.com/rhsimplex/grafana-bigchaindb-docker/blob/master/bigchaindb_dashboard.js) to your liking! \ No newline at end of file