open-consul/website/pages/commands/info.mdx

80 lines
1.8 KiB
Plaintext
Raw Normal View History

2014-02-24 01:09:59 +00:00
---
layout: commands
2020-04-07 18:55:19 +00:00
page_title: 'Commands: Info'
sidebar_title: info
2020-04-07 18:55:19 +00:00
description: >-
The `info` command provides various debugging information that can be useful
to operators. Depending on if the agent is a client or server, information
about different sub-systems will be returned.
2014-02-24 01:09:59 +00:00
---
# Consul Info
Command: `consul info`
The `info` command provides various debugging information that can be
2014-02-24 01:09:59 +00:00
useful to operators. Depending on if the agent is a client or server,
information about different sub-systems will be returned.
2014-04-09 18:06:27 +00:00
There are currently the top-level keys for:
2020-04-07 18:55:19 +00:00
- agent: Provides information about the agent
- consul: Information about the consul library (client or server)
2020-04-09 23:46:54 +00:00
- raft: Provides info about the Raft [consensus library](/docs/internals/consensus)
- serf_lan: Provides info about the LAN [gossip pool](/docs/internals/gossip)
- serf_wan: Provides info about the WAN [gossip pool](/docs/internals/gossip)
2014-04-09 18:06:27 +00:00
2014-02-24 01:09:59 +00:00
Here is an example output:
```text
agent:
check_monitors = 0
check_ttls = 0
checks = 0
services = 0
consul:
bootstrap = true
known_datacenters = 1
leader = true
server = true
raft:
applied_index = 45832
commit_index = 45832
fsm_pending = 0
last_log_index = 45832
last_log_term = 4
last_snapshot_index = 45713
last_snapshot_term = 1
num_peers = 2
state = Leader
term = 4
serf_lan:
event_queue = 0
event_time = 2
failed = 0
intent_queue = 0
left = 0
member_time = 7
members = 3
query_queue = 0
query_time = 1
serf_wan:
event_queue = 0
event_time = 1
failed = 0
intent_queue = 0
left = 0
member_time = 1
members = 1
query_queue = 0
query_time = 1
```
2014-02-24 01:09:59 +00:00
## Usage
Usage: `consul info`
#### API Options
2014-02-24 01:09:59 +00:00
2020-04-07 18:55:19 +00:00
@include 'http_api_options_client.mdx'