From 65dc78ba35f5b076ddc35e850806be14609fcbec Mon Sep 17 00:00:00 2001 From: Nate Brown Date: Tue, 14 Jul 2015 15:44:48 -0700 Subject: [PATCH] Docs for the telemetry object --- website/source/docs/config/index.html.md | 26 +++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) diff --git a/website/source/docs/config/index.html.md b/website/source/docs/config/index.html.md index 4de6cef58..664867d96 100644 --- a/website/source/docs/config/index.html.md +++ b/website/source/docs/config/index.html.md @@ -22,6 +22,11 @@ listener "tcp" { address = "127.0.0.1:8200" tls_disable = 1 } + +telemetry { + statsite_address = "127.0.0.1:8125" + disable_hostname = true +} ``` After the configuration is written, use the `-config` flag with `vault server` @@ -41,11 +46,8 @@ to specify where the configuration is. server from executing the `mlock` syscall to prevent memory from being swapped to disk. This is not recommended in production (see below). -* `statsite_addr` (optional) - An address to a [Statsite](https://github.com/armon/statsite) - instances for metrics. This is highly recommended for production usage. - -* `statsd_addr` (optional) - This is the same as `statsite_addr` but - for StatsD. +* `telemetry` (optional) - Configures the telemetry reporting system + (see below). In production, you should only consider setting the `disable_mlock` option on Linux systems that only use encrypted swap or do not use swap at all. @@ -190,3 +192,17 @@ The supported options are: * `tls_key_file` (required unless disabled) - The path to the private key for the certificate. + +## Telemetry Reference + +For the `telemetry` section, there is no resource name. All configuration +is within the object itself. + +* `statsite_address` (optional) - An address to a [Statsite](https://github.com/armon/statsite) + instances for metrics. This is highly recommended for production usage. + +* `statsd_address` (optional) - This is the same as `statsite_address` but + for StatsD. + +* `disable_hostname` (optional) - Whether or not to prepend runtime telemetry + with the machines hostname. This is a global option. Defaults to false.