From 70b60562d8227b723a96d0ed3c74cdb82f7b2bc2 Mon Sep 17 00:00:00 2001 From: libscott Date: Thu, 29 Jun 2017 14:19:08 +0200 Subject: [PATCH] Document graphite configuration parameter (#1594) * document graphite configuration parameter * add example * graphite settings docs follows wsserver * Removed outer JSON braces @ graphite.host docs --- .../source/server-reference/configuration.md | 27 +++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/docs/server/source/server-reference/configuration.md b/docs/server/source/server-reference/configuration.md index 76a76456..7edc184c 100644 --- a/docs/server/source/server-reference/configuration.md +++ b/docs/server/source/server-reference/configuration.md @@ -45,6 +45,7 @@ For convenience, here's a list of all the relevant environment variables (docume `BIGCHAINDB_DATABASE_KEYFILE`
`BIGCHAINDB_DATABASE_KEYFILE_PASSPHRASE`
`BIGCHAINDB_DATABASE_CRLFILE`
+`BIGCHAINDB_GRAPHITE_HOST`
The local config file is `$HOME/.bigchaindb` by default (a file which might not even exist), but you can tell BigchainDB to use a different file by using the `-c` command-line option, e.g. `bigchaindb -c path/to/config_file.json start` or using the `BIGCHAINDB_CONFIG_PATH` environment variable, e.g. `BIGHAINDB_CONFIG_PATH=.my_bigchaindb_config bigchaindb start`. @@ -497,3 +498,29 @@ logging of the `core.py` module to be more verbose, you would set the ``` **Defaults to**: `"{}"` + + +## graphite.host + +The host name or IP address of a server listening for statsd events on UDP +port 8125. This defaults to `localhost`, and if no statsd collector is running, +the events are simply dropped by the operating system. + +**Example using environment variables** +```text +export BIGCHAINDB_GRAPHITE_HOST=10.0.0.5 +``` + +**Example config file snippet** +```js +"graphite": { + "host": "10.0.0.5" +} +``` + +**Default values (from a config file)** +```js +"graphite": { + "host": "localhost" +} +```