added docs for configuration of telemetry publishing nobs

This commit is contained in:
Diptanu Choudhury 2016-08-23 14:17:57 -05:00
parent 416ed7692e
commit 8885cee346
2 changed files with 16 additions and 3 deletions

View File

@ -193,6 +193,10 @@ nodes, unless otherwise specified:
server to forward metrics to. server to forward metrics to.
* `disable_hostname`: A boolean indicating if gauge values should not be * `disable_hostname`: A boolean indicating if gauge values should not be
prefixed with the local hostname. prefixed with the local hostname.
* `publish_allocation_metrics`: Enables publishing runtime metrics of
allocations. Default is `false`.
* `publish_node_metrics`: Enables publishing runtime metrics of nodes. Default
is `false`.
* `circonus_api_token` * `circonus_api_token`
A valid [Circonus](http://circonus.com/) API Token used to create/manage check. If provided, metric management is enabled. A valid [Circonus](http://circonus.com/) API Token used to create/manage check. If provided, metric management is enabled.
* `circonus_api_app` * `circonus_api_app`

View File

@ -216,9 +216,18 @@ when retrieving metrics using the above described signals.
# Client Metrics # Client Metrics
The Nomad client emits metrics related to the resource usage of the allocations The Nomad client emits metrics related to the resource usage of the allocations
and tasks running on it and the node itself. By default the collection interval and tasks running on it and the node itself. Operators have to explicity turn
is 1 second but it can be changed by the changing the value of the on publishing host and allocation metrics. Publishing allocation and host
`collection_interval` key in the `telemetry` configuration block. metrics can be turned on by setting the value of `publish_allocation_metrics`
`publish_node_metrics` to `true`.
By default the collection interval is 1 second but it can be changed by the
changing the value of the `collection_interval` key in the `telemetry`
configuration block.
Please see the [agent configuration](/docs/agent/config.html#telemetry_config)
page for more details.
## Host Metrics ## Host Metrics