status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Cleanup docs/agent/telemetry

This commit is contained in:
Ryan Breen 2015-02-04 00:10:25 -05:00
parent 8975c49c96
commit c9a23fca9d
1 changed files with 11 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
website/source/docs/agent/telemetry.html.markdown
View File

@ -3,29 +3,28 @@ layout: "docs"
page_title: "Telemetry" page_title: "Telemetry"
sidebar_current: "docs-agent-telemetry" sidebar_current: "docs-agent-telemetry"
description: |- description: |-
The Consul agent collects various metrics data at runtime about the performance of different libraries and sub-systems. These metrics are aggregated on a ten second interval and are retained for one minute. The Consul agent collects various runtime metrics about the performance of different libraries and subsystems. These metrics are aggregated on a ten second interval and are retained for one minute.
--- ---
# Telemetry # Telemetry
The Consul agent collects various metrics data at runtime about the performance The Consul agent collects various runtime metrics about the performance of
of different libraries and sub-systems. These metrics are aggregated on a ten second different libraries and subsystems. These metrics are aggregated on a ten
interval and are retained for one minute. second interval and are retained for one minute.
To view the telemetry information, you must send a `USR1` signal to the Consul To view this data, you must send a signal to the Consul process: on Unix,
process. Windows users must use the `BREAK` signal instead. this is `USR1` while on Windows it is `BREAK`. Once Consul receives the signal,
Once Consul receives the signal, it will dump the current telemetry it will dump the current telemetry information to the agent's `stderr`.
information to the stderr of the agent.
In general, the telemetry information is used for debugging or otherwise This telemetry information can be used for debugging or otherwise
getting a better view into what Consul is doing. getting a better view of what Consul is doing.
Additionally, if the `statsite_addr` [configuration option](/docs/agent/options.html) Additionally, if the `statsite_addr` [configuration option](/docs/agent/options.html)
is provided, then the telemetry information will be streamed to a is provided, the telemetry information will be streamed to a
[statsite](http://github.com/armon/statsite) server where it can be [statsite](http://github.com/armon/statsite) server where it can be
aggregate and flushed to Graphite or any other metrics store. aggregate and flushed to Graphite or any other metrics store.
Below is an example output: Below is an output:
```text ```text
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.num_goroutines': 19.000 [2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.num_goroutines': 19.000