2014-02-08 00:41:03 +00:00
|
|
|
---
|
|
|
|
|
layout: "docs"
|
|
|
|
|
page_title: "Telemetry"
|
|
|
|
|
sidebar_current: "docs-agent-telemetry"
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Telemetry
|
|
|
|
|
|
2014-02-18 23:30:07 +00:00
|
|
|
The Consul agent collects various metrics data at runtime about the performance
|
2014-02-08 00:41:03 +00:00
|
|
|
of different libraries and sub-systems. These metrics are aggregated on a ten second
|
|
|
|
|
interval and are retained for one minute.
|
|
|
|
|
|
2014-02-18 23:30:07 +00:00
|
|
|
To view the telemetry information, you must send a `USR1` signal to the Consul
|
2014-02-08 00:41:03 +00:00
|
|
|
process. Windows users must use the `BREAK` signal instead.
|
2014-02-18 23:30:07 +00:00
|
|
|
Once Consul receives the signal, it will dump the current telemetry
|
2014-02-08 00:41:03 +00:00
|
|
|
information to the stderr of the agent.
|
|
|
|
|
|
|
|
|
|
In general, the telemetry information is used for debugging or otherwise
|
2014-02-18 23:30:07 +00:00
|
|
|
getting a better view into what Consul is doing.
|
2014-02-08 00:41:03 +00:00
|
|
|
|
2014-04-04 21:55:23 +00:00
|
|
|
Additionally, if the `-statsite` [option](/docs/agent/options.html) is provided,
|
2014-04-09 18:06:27 +00:00
|
|
|
then the telemetry information will be streamed to a [statsite](http://github.com/armon/statsite)
|
2014-04-04 21:55:23 +00:00
|
|
|
server where it can be aggregate and flushed to Graphite or any other metrics store.
|
|
|
|
|
|
2014-02-08 00:41:03 +00:00
|
|
|
Below is an example output:
|
|
|
|
|
|
|
|
|
|
```
|
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
|
|
|
```
|
|
|
|
|
|
