2014-02-08 00:41:03 +00:00
---
layout: "docs"
page_title: "Telemetry"
sidebar_current: "docs-agent-telemetry"
2014-10-19 23:40:10 +00:00
description: |-
2015-02-04 05:10:25 +00:00
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.
2014-02-08 00:41:03 +00:00
---
# Telemetry
2015-02-04 05:10:25 +00:00
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.
2014-02-08 00:41:03 +00:00
2015-02-04 05:10:25 +00:00
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` .
2014-02-08 00:41:03 +00:00
2015-02-04 05:10:25 +00:00
This telemetry information can be used for debugging or otherwise
getting a better view of what Consul is doing.
2014-02-08 00:41:03 +00:00
2014-07-11 01:06:36 +00:00
Additionally, if the `statsite_addr` [configuration option ](/docs/agent/options.html )
2015-02-04 05:10:25 +00:00
is provided, the telemetry information will be streamed to a
2014-07-11 01:06:36 +00:00
[statsite ](http://github.com/armon/statsite ) server where it can be
aggregate and flushed to Graphite or any other metrics store.
2014-04-04 21:55:23 +00:00
2015-02-04 19:07:33 +00:00
Below is sample output of a telemetry dump:
2014-02-08 00:41:03 +00:00
2014-10-19 23:40:10 +00:00
```text
2014-02-18 23:30:07 +00:00
[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.alloc_bytes': 755960.000
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.malloc_count': 7550.000
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.free_count': 4387.000
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.heap_objects': 3163.000
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.total_gc_pause_ns': 1151002.000
[2014-01-29 10:56:50 -0800 PST][G] 'consul-agent.runtime.total_gc_runs': 4.000
[2014-01-29 10:56:50 -0800 PST][C] 'consul-agent.agent.ipc.accept': Count: 5 Sum: 5.000
[2014-01-29 10:56:50 -0800 PST][C] 'consul-agent.agent.ipc.command': Count: 10 Sum: 10.000
[2014-01-29 10:56:50 -0800 PST][C] 'consul-agent.serf.events': Count: 5 Sum: 5.000
[2014-01-29 10:56:50 -0800 PST][C] 'consul-agent.serf.events.foo': Count: 4 Sum: 4.000
[2014-01-29 10:56:50 -0800 PST][C] 'consul-agent.serf.events.baz': Count: 1 Sum: 1.000
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.memberlist.gossip': Count: 50 Min: 0.007 Mean: 0.020 Max: 0.041 Stddev: 0.007 Sum: 0.989
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.serf.queue.Intent': Count: 10 Sum: 0.000
[2014-01-29 10:56:50 -0800 PST][S] 'consul-agent.serf.queue.Event': Count: 10 Min: 0.000 Mean: 2.500 Max: 5.000 Stddev: 2.121 Sum: 25.000
2014-02-08 00:41:03 +00:00
```
