From f647483035355fa072a30f2f633295094d579c8f Mon Sep 17 00:00:00 2001 From: Ryan Breen Date: Wed, 4 Feb 2015 00:10:25 -0500 Subject: [PATCH 1/2] Cleanup docs/agent/telemetry --- .../source/docs/agent/telemetry.html.markdown | 23 +++++++++---------- 1 file changed, 11 insertions(+), 12 deletions(-) diff --git a/website/source/docs/agent/telemetry.html.markdown b/website/source/docs/agent/telemetry.html.markdown index 6f20d59be..4240e7274 100644 --- a/website/source/docs/agent/telemetry.html.markdown +++ b/website/source/docs/agent/telemetry.html.markdown @@ -3,29 +3,28 @@ layout: "docs" page_title: "Telemetry" sidebar_current: "docs-agent-telemetry" 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 -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. -To view the telemetry information, you must send a `USR1` signal to the Consul -process. Windows users must use the `BREAK` signal instead. -Once Consul receives the signal, it will dump the current telemetry -information to the stderr of the agent. +To view this data, you must send a signal to the Consul process: on Unix, +this is `USR1` while on Windows it is `BREAK`. Once Consul receives the signal, +it will dump the current telemetry information to the agent's `stderr`. -In general, the telemetry information is used for debugging or otherwise -getting a better view into what Consul is doing. +This telemetry information can be used for debugging or otherwise +getting a better view of what Consul is doing. 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 aggregate and flushed to Graphite or any other metrics store. -Below is an example output: +Below is an output: ```text [2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.num_goroutines': 19.000 From 5b693d86a9cfb1eb528cdb148bb151ba9914413b Mon Sep 17 00:00:00 2001 From: Ryan Breen Date: Wed, 4 Feb 2015 14:07:33 -0500 Subject: [PATCH 2/2] Finalize telemetry docs edits. --- website/source/docs/agent/telemetry.html.markdown | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/source/docs/agent/telemetry.html.markdown b/website/source/docs/agent/telemetry.html.markdown index 4240e7274..3c2de9e80 100644 --- a/website/source/docs/agent/telemetry.html.markdown +++ b/website/source/docs/agent/telemetry.html.markdown @@ -24,7 +24,7 @@ is provided, the telemetry information will be streamed to a [statsite](http://github.com/armon/statsite) server where it can be aggregate and flushed to Graphite or any other metrics store. -Below is an output: +Below is sample output of a telemetry dump: ```text [2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.num_goroutines': 19.000