luxolus/open-vault
2
0
Fork 0
Code Issues 1 Pull requests Releases Activity

Docs for the telemetry object

Browse source
This commit is contained in:
Nate Brown 2015-07-14 15:44:48 -07:00
parent 0ec0b41aa3
commit 65dc78ba35
1 changed files with 21 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
website/source/docs/config/index.html.md
View file

@ -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.