Consul integration metrics
The official Datadog integration for monitoring Consul. It collects 152 metrics.
Official summary
Alert on Consul health checks, see service-to-node mappings, and much more.
Metric types
- gauge (value at a point in time): 101
- count (occurrences in the interval): 51
Metrics
Descriptions are the official definitions, unedited.
| Metric | Type | Unit |
|---|---|---|
consul.[Integration] The number of nodes with service status critical from those registered | gauge | node |
consul.[Integration] The number of nodes with service status passing from those registered | gauge | node |
consul.[Integration] The number of nodes | gauge | node |
consul.[Integration] The number of nodes with service status warning from those registered | gauge | node |
consul.[Integration] Metrics to count the number of services matching criteria like the service tag, node name, or status. To be queried using the sum by aggregator. | gauge | service |
consul.[Integration] Total critical services on nodes | gauge | service |
consul.[Integration] Total passing services on nodes | gauge | service |
consul.[Integration] Total services registered on nodes | gauge | service |
consul.[Integration] Total warning services on nodes | gauge | service |
consul.[Integration] The number of nodes registered in the consul cluster | gauge | node |
consul.A metric representing the status of a service check. A value of 0 = unavailable, 1 = passing, 2 = warning, 3 = critical | gauge | - |
consul.[DogStatsD] [Prometheus] This increments whenever a Consul agent in client mode makes an RPC request to a Consul server. This gives a measure of how much a given agent is loading the Consul servers. This is only generated by agents in client mode, not Consul servers. | count | request |
consul.[DogStatsD] [Prometheus] Increments whenever a Consul agent in client mode makes an RPC request to a Consul server and fails | count | request |
consul.[DogStatsD] Tracks how long it takes to service the given HTTP request for the given verb and path. Using a DogStatsD mapper as described in the README, the paths are mapped to tags and do not include details like service or key names. For these paths, an underscore is present as a placeholder, for example: http_method:GET, path:v1.kv._) | gauge | millisecond |
consul.[Prometheus] A count of how long it takes to service the given HTTP request for the given verb and path. It includes labels for path and method. Path does not include details like service or key names. For these paths, an underscore is present as a placeholder, for example: path=v1.kv._) | count | millisecond |
consul.[Prometheus] A quantile of how long it takes to service the given HTTP request for the given verb and path. Includes labels for path and method. Path does not include details like service or key names. For these paths, an underscore is present as a placeholder, for example: path=v1.kv._) | gauge | millisecond |
consul.[Prometheus] The sum of how long it takes to service the given HTTP request for the given verb and path. Includes labels for path and method. Path does not include details like service or key names. For these paths, an underscore is present as a placeholder, for example: path=v1.kv._) | count | millisecond |
consul.[DogStatsD] [Prometheus] This metric counts the number of times the Consul agent has performed failure detection on another agent at a slower probe rate. The agent uses its own health metric as an indicator to perform this action. If its health score is low, it means that the node is healthy, and vice versa. | gauge | - |
consul.[DogStatsD] The p95 for the number of gossips (messages) broadcasted to a set of randomly selected nodes. | gauge | message |
consul.[DogStatsD] The avg for the number of gossips (messages) broadcasted to a set of randomly selected nodes. | gauge | message |
consul.[DogStatsD] [Prometheus] The number of samples of consul.memberlist.gossip | count | - |
consul.[DogStatsD] The max for the number of gossips (messages) broadcasted to a set of randomly selected nodes. | gauge | message |
consul.[DogStatsD] The median for the number of gossips (messages) broadcasted to a set of randomly selected nodes. | gauge | message |
consul.[Prometheus] The quantile for the number of gossips (messages) broadcasted to a set of randomly selected nodes. | gauge | message |
consul.[DogStatsD] [Prometheus] The sum of the number of gossips (messages) broadcasted to a set of randomly selected nodes. | count | message |
consul.[DogStatsD] [Prometheus] This metric describes a node's perception of its own health based on how well it is meeting the soft real-time requirements of the protocol. This metric ranges from 0 to 8, where 0 indicates "totally healthy". For more details see section IV of the Lifeguard paper: https://arxiv.org/pdf/1707.00788.pdf | gauge | - |
consul.[DogStatsD] [Prometheus] This metric counts the number of alive Consul agents, that the agent has mapped out so far, based on the message information given by the network layer. | count | - |
consul.[DogStatsD] [Prometheus] This metric counts the number of times a Consul agent has marked another agent to be a dead node. | count | message |
consul.[DogStatsD] [Prometheus] The number of times a Consul agent suspects another as failed while probing during gossip protocol | count | - |
consul.[DogStatsD] The p95 for the time taken to perform a single round of failure detection on a select Consul agent. | gauge | node |
consul.[DogStatsD] The avg for the time taken to perform a single round of failure detection on a select Consul agent. | gauge | node |
consul.[DogStatsD] [Prometheus] The number of samples of consul.memberlist.probenode | count | - |
consul.[DogStatsD] The max for the time taken to perform a single round of failure detection on a select Consul agent. | gauge | node |
consul.[DogStatsD] The median for the time taken to perform a single round of failure detection on a select Consul agent. | gauge | node |
consul.[Prometheus] The quantile for the time taken to perform a single round of failure detection on a select Consul agent. | gauge | node |
consul.[DogStatsD] [Prometheus] The sum for the time taken to perform a single round of failure detection on a select Consul agent. | count | node |
consul.[DogStatsD] The p95 for the number of Consul agents that have exchanged state with this agent. | gauge | node |
consul.[DogStatsD] The avg for the number of Consul agents that have exchanged state with this agent. | gauge | node |
consul.[DogStatsD] [Prometheus] The number of samples of consul.memberlist.pushpullnode | count | - |
consul.[DogStatsD] The max for the number of Consul agents that have exchanged state with this agent. | gauge | node |
consul.[DogStatsD] The median for the number of Consul agents that have exchanged state with this agent. | gauge | node |
consul.[Prometheus] The quantile for the number of Consul agents that have exchanged state with this agent. | gauge | - |
consul.[DogStatsD] [Prometheus] The sum for the number of Consul agents that have exchanged state with this agent. | count | - |
consul.[DogStatsD] [Prometheus] This metric counts the number of times a Consul agent has accepted an incoming TCP stream connection. | count | connection |
consul.[DogStatsD] [Prometheus] This metric counts the number of times a Consul agent has initiated a push/pull sync with an other agent. | count | connection |
consul.[DogStatsD] [Prometheus] This metric measures the total number of bytes sent by a Consul agent through the TCP protocol | count | byte |
consul.[DogStatsD] [Prometheus] This metric measures the total number of bytes sent/received by a Consul agent through the UDP protocol. | count | byte |
consul.[DogStatsD] [Prometheus] This metric measures the total number of bytes sent/received by a Consul agent through the UDP protocol. | count | byte |
consul.[Integration] Maximum latency from this node to all others | gauge | millisecond |
consul.[Integration] Median latency from this node to all others | gauge | millisecond |
consul.[Integration] Minimum latency from this node to all others | gauge | millisecond |
consul.[Integration] P25 latency from this node to all others | gauge | millisecond |
consul.[Integration] P75 latency from this node to all others | gauge | millisecond |
consul.[Integration] P90 latency from this node to all others | gauge | millisecond |
consul.[Integration] P95 latency from this node to all others | gauge | millisecond |
consul.[Integration] P99 latency from this node to all others | gauge | millisecond |
consul.[Integration] The number of peers in the peer set | gauge | - |
consul.[DogStatsD] [Prometheus] The number of raft transactions occurring | count | transaction |
consul.[DogStatsD] The p95 time it takes to commit a new entry to the raft log on the leader | gauge | millisecond |
consul.[DogStatsD] The average time it takes to commit a new entry to the raft log on the leader | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The number of samples of raft.commitTime | count | - |
consul.[DogStatsD] The max time it takes to commit a new entry to the raft log on the leader | gauge | millisecond |
consul.[DogStatsD] The median time it takes to commit a new entry to the raft log on the leader | gauge | millisecond |
consul.[Prometheus] The quantile time it takes to commit a new entry to the raft log on the leader | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The sum of the time it takes to commit a new entry to the raft log on the leader | count | millisecond |
consul.[DogStatsD] The p95 time it takes for the leader to write log entries to disk | gauge | millisecond |
consul.[DogStatsD] The average time it takes for the leader to write log entries to disk | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The number of samples of raft.leader.dispatchLog | count | - |
consul.[DogStatsD] The max time it takes for the leader to write log entries to disk | gauge | millisecond |
consul.[DogStatsD] The median time it takes for the leader to write log entries to disk | gauge | millisecond |
consul.[Prometheus] The quantile time it takes for the leader to write log entries to disk | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The sum of the time it takes for the leader to write log entries to disk | count | millisecond |
consul.[DogStatsD] The p95 time elapsed since the leader was last able to check its lease with followers | gauge | millisecond |
consul.[DogStatsD] The average time elapsed since the leader was last able to check its lease with followers | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The number of samples of raft.leader.lastContact | count | - |
consul.[DogStatsD] The max time elapsed since the leader was last able to check its lease with followers | gauge | millisecond |
consul.[DogStatsD] The median time elapsed since the leader was last able to check its lease with followers | gauge | millisecond |
consul.[Prometheus] The quantile time elapsed since the leader was last able to check its lease with followers | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The sum of the time elapsed since the leader was last able to check its lease with followers | count | millisecond |
consul.[DogStatsD] [Prometheus] Measures the number of logs replicated to an agent, to bring it up to speed with the leader's logs. | count | entry |
consul.[DogStatsD] [Prometheus] The count the time taken by the append entries RFC to replicate the log entries of a leader agent onto its follower agent(s) | count | millisecond |
consul.[Prometheus] The quantile of the time taken by the append entries RFC to replicate the log entries of a leader agent onto its follower agent(s) | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The sum the time taken by the append entries RFC to replicate the log entries of a leader agent onto its follower agent(s) | count | millisecond |
consul.[DogStatsD] [Prometheus] The count the time taken to invoke appendEntries on a peer. | count | millisecond |
consul.[Prometheus] The quantile of the time taken to invoke appendEntries on a peer. | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The sum of the time taken to invoke appendEntries on a peer. | count | millisecond |
consul.[DogStatsD] [Prometheus]The number of initiated leader elections | count | event |
consul.[DogStatsD] [Prometheus] The number of completed leader elections | count | event |
consul.[DogStatsD] The p95 for the number of nanoseconds consumed by stop-the-world garbage collection (GC) pauses since Consul started. | gauge | nanosecond |
consul.[DogStatsD] The avg for the number of nanoseconds consumed by stop-the-world garbage collection (GC) pauses since Consul started. | gauge | nanosecond |
consul.[DogStatsD] [Prometheus] The number of samples of consul.runtime.gc_pause_ns | count | - |
consul.[DogStatsD] The max for the number of nanoseconds consumed by stop-the-world garbage collection (GC) pauses since Consul started. | gauge | nanosecond |
consul.[DogStatsD] The median for the number of nanoseconds consumed by stop-the-world garbage collection (GC) pauses since Consul started. | gauge | nanosecond |
consul.[Prometheus] The quantile of nanoseconds consumed by stop-the-world garbage collection (GC) pauses since Consul started. | gauge | nanosecond |
consul.[DogStatsD] [Prometheus] The sum of nanoseconds consumed by stop-the-world garbage collection (GC) pauses since Consul started. | count | nanosecond |
consul.[DogStatsD] The p95 in milliseconds for the node coordinate adjustment | gauge | millisecond |
consul.[DogStatsD] The avg in milliseconds for the node coordinate adjustment | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The number of samples of consul.serf.coordinate.adjustment_ms | count | - |
consul.[DogStatsD] The max in milliseconds for the node coordinate adjustment | gauge | millisecond |
consul.[DogStatsD] The median in milliseconds for the node coordinate adjustment | gauge | millisecond |
consul.[Prometheus] The quantile in milliseconds for the node coordinate adjustment | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The sum in milliseconds for the node coordinate adjustment | count | millisecond |
consul.[DogStatsD] [Prometheus] This increments when a Consul agent processes a serf event | count | event |
consul.[DogStatsD] [Prometheus] This increments when a Consul agent is marked dead. This can be an indicator of overloaded agents, network problems, or configuration errors where agents cannot connect to each other on the required ports. | count | - |
consul.[DogStatsD] [Prometheus] The number of times a Consul agent is marked dead and then quickly recovers | count | - |
consul.[DogStatsD] [Prometheus] This increments when a Consul agent processes a join event | count | event |
consul.[DogStatsD] [Prometheus] This increments when a Consul agent leaves the cluster. | count | - |
consul.[DogStatsD] [Prometheus] This increments when a Consul agent updates. | count | - |
consul.[DogStatsD] The p95 for the number of serf messages received | gauge | message |
consul.[DogStatsD] The avg for the number of serf messages received | gauge | message |
consul.[DogStatsD] [Prometheus] The count of serf messages received | count | - |
consul.[DogStatsD] The max for the number of serf messages received | gauge | message |
consul.[DogStatsD] The median for the number of serf messages received | gauge | message |
consul.[Prometheus] The quantile for the number of serf messages received | gauge | message |
consul.[DogStatsD] [Prometheus] The sum for the number of serf messages received | count | message |
consul.[DogStatsD] The p95 for the number of serf messages sent | gauge | message |
consul.[DogStatsD] The avg for the number of serf messages sent | gauge | message |
consul.[DogStatsD] [Prometheus] The count of serf messages sent | count | - |
consul.[DogStatsD] The max for the number of serf messages sent | gauge | message |
consul.[DogStatsD] The median for the number of serf messages sent | gauge | message |
consul.[Prometheus] The quantile for the number of serf messages sent | gauge | message |
consul.[DogStatsD] [Prometheus] The sum of the number of serf messages sent | count | message |
consul.[DogStatsD] The p95 for the size of the serf event queue | gauge | - |
consul.[DogStatsD] The avg size of the serf event queue | gauge | - |
consul.[DogStatsD] [Prometheus] The number of items in the serf event queue | count | - |
consul.[DogStatsD] The max size of the serf event queue | gauge | - |
consul.[DogStatsD] The median size of the serf event queue | gauge | - |
consul.[Prometheus] The quantile for the size of the serf event queue | gauge | - |
consul.[DogStatsD] The p95 for the size of the serf intent queue | gauge | - |
consul.[DogStatsD] The avg size of the serf intent queue | gauge | - |
consul.[DogStatsD] [Prometheus] The number of items in the serf intent queue | count | - |
consul.[DogStatsD] The max size of the serf intent queue | gauge | - |
consul.[DogStatsD] The median size of the serf intent queue | gauge | - |
consul.[Prometheus] The quantile for the size of the serf intent queue | gauge | - |
consul.[DogStatsD] The p95 for the size of the serf query queue | gauge | - |
consul.[DogStatsD] The avg size of the serf query queue | gauge | - |
consul.[DogStatsD] [Prometheus] The number of items in the serf query queue | count | - |
consul.[DogStatsD] The max size of the serf query queue | gauge | - |
consul.[DogStatsD] The median size of the serf query queue | gauge | - |
consul.[Prometheus] The quantile for the size of the serf query queue | gauge | - |
consul.[DogStatsD] The p95 of the time taken by the Consul agent to append an entry into the existing log. | gauge | millisecond |
consul.[DogStatsD] The avg of the time taken by the Consul agent to append an entry into the existing log. | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The number of samples of consul.serf.snapshot.appendline | count | - |
consul.[DogStatsD] The max of the time taken by the Consul agent to append an entry into the existing log. | gauge | millisecond |
consul.[DogStatsD] The median of the time taken by the Consul agent to append an entry into the existing log. | gauge | millisecond |
consul.[Prometheus] The quantile of the time taken by the Consul agent to append an entry into the existing log. | gauge | millisecond |
consul.[DogStatsD] The p95 of the time taken by the Consul agent to compact a log. This operation occurs only when the snapshot becomes large enough to justify the compaction . | gauge | millisecond |
consul.[DogStatsD] The avg of the time taken by the Consul agent to compact a log. This operation occurs only when the snapshot becomes large enough to justify the compaction . | gauge | millisecond |
consul.[DogStatsD] [Prometheus] The number of samples of consul.serf.snapshot.compact | count | - |
consul.[DogStatsD] The max of the time taken by the Consul agent to compact a log. This operation occurs only when the snapshot becomes large enough to justify the compaction . | gauge | millisecond |
consul.[DogStatsD] The median of the time taken by the Consul agent to compact a log. This operation occurs only when the snapshot becomes large enough to justify the compaction . | gauge | millisecond |
consul.[Prometheus] The quantile of the time taken by the Consul agent to compact a log. This operation occurs only when the snapshot becomes large enough to justify the compaction . | gauge | millisecond |
Official documentation
Metric names and descriptions are the official Datadog integration definitions (Copyright Datadog, Inc., BSD-3-Clause), reproduced unedited. The full license terms are on the About page.