From fad3e4d97cd3da12f3f9eb66d4ba28a7451aeeae Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Sun, 23 Feb 2014 17:09:59 -0800 Subject: [PATCH] website: Documenting the info command --- command/info.go | 2 +- website/source/docs/agent/rpc.html.markdown | 20 +++++++ .../source/docs/commands/index.html.markdown | 1 + .../source/docs/commands/info.html.markdown | 60 +++++++++++++++++++ website/source/layouts/docs.erb | 5 +- 5 files changed, 86 insertions(+), 2 deletions(-) create mode 100644 website/source/docs/commands/info.html.markdown diff --git a/command/info.go b/command/info.go index 8154d84037..b69f35ee8b 100644 --- a/command/info.go +++ b/command/info.go @@ -57,7 +57,7 @@ func (i *InfoCommand) Run(args []string) int { // Iterate over each top-level key for _, key := range keys { - i.Ui.Output(key) + i.Ui.Output(key + ":") // Sort the sub-keys subvals := stats[key] diff --git a/website/source/docs/agent/rpc.html.markdown b/website/source/docs/agent/rpc.html.markdown index 7fe2900d0e..e69897f082 100644 --- a/website/source/docs/agent/rpc.html.markdown +++ b/website/source/docs/agent/rpc.html.markdown @@ -53,6 +53,7 @@ Possible commands include: * monitor - Starts streaming logs over the connection * stop - Stops streaming logs * leave - Consul agent performs a graceful leave and shutdown +* stats - Provides various debugging statistics Below each command is documented along with any request or response body that is applicable. @@ -196,3 +197,22 @@ There is no special response body. The leave command is used trigger a graceful leave and shutdown. There is no request body, or special response body. +### stats + +The stats command is used to provide operator information for debugginer. +There is no request body, the response body looks like: + +``` + { + "agent": { + "check_monitors": 0, + ... + }, + "consul: { + "server": "true", + ... + }, + ... + } +``` + diff --git a/website/source/docs/commands/index.html.markdown b/website/source/docs/commands/index.html.markdown index dcf9f6e1cf..e193d3a189 100644 --- a/website/source/docs/commands/index.html.markdown +++ b/website/source/docs/commands/index.html.markdown @@ -26,6 +26,7 @@ usage: consul [--version] [--help] [] Available commands are: agent Runs a Consul agent force-leave Forces a member of the cluster to enter the "left" state + info Provides debugging information for operators join Tell Consul agent to join cluster keygen Generates a new encryption key leave Gracefully leaves the Consul cluster and shuts down diff --git a/website/source/docs/commands/info.html.markdown b/website/source/docs/commands/info.html.markdown new file mode 100644 index 0000000000..d542330736 --- /dev/null +++ b/website/source/docs/commands/info.html.markdown @@ -0,0 +1,60 @@ +--- +layout: "docs" +page_title: "Commands: Info" +sidebar_current: "docs-commands-info" +--- + +# Consul Info + +Command: `consul info` + +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. + +Here is an example output: + + agent: + check_monitors = 0 + check_ttls = 0 + checks = 0 + services = 0 + consul: + bootstrap = true + leader = true + server = true + raft: + applied_index = 45758 + commit_index = 45758 + fsm_pending = 0 + last_log_index = 45758 + last_log_term = 3 + last_snapshot_index = 45713 + last_snapshot_term = 1 + num_peers = 0 + state = Leader + term = 3 + serf-lan: + members = 1 + serf-wan: + datacenters = 1 + members = 1 + +There are currently the top-level keys for: + +* agent: Provides information about the agent +* consul: Information about the consul library (client or server) +* raft: Provides info about the Raft [consensus library](/docs/internals/consensus.html) +* serf-lan: Provides info about the LAN [gossip pool](/docs/internals/gossip.html) +* serf-wan: Provides info about the WAN [gossip pool](/docs/internals/gossip.html) + +## Usage + +Usage: `consul info` + +The command-line flags are all optional. The list of available flags are: + +* `-rpc-addr` - Address to the RPC server of the agent you want to contact + to send this command. If this isn't specified, the command will contact + "127.0.0.1:8400" which is the default RPC address of a Consul agent. + diff --git a/website/source/layouts/docs.erb b/website/source/layouts/docs.erb index fa9db1c074..34d6fed501 100644 --- a/website/source/layouts/docs.erb +++ b/website/source/layouts/docs.erb @@ -69,8 +69,11 @@ > monitor - + + > + info +