consul/website/source/docs/commands
Jack Pearkes 8c684db488 New command: consul debug (#4754)
* agent/debug: add package for debugging, host info

* api: add v1/agent/host endpoint

* agent: add v1/agent/host endpoint

* command/debug: implementation of static capture

* command/debug: tests and only configured targets

* agent/debug: add basic test for host metrics

* command/debug: add methods for dynamic data capture

* api: add debug/pprof endpoints

* command/debug: add pprof

* command/debug: timing, wg, logs to disk

* vendor: add gopsutil/disk

* command/debug: add a usage section

* website: add docs for consul debug

* agent/host: require operator:read

* api/host: improve docs and no retry timing

* command/debug: fail on extra arguments

* command/debug: fixup file permissions to 0644

* command/debug: remove server flags

* command/debug: improve clarity of usage section

* api/debug: add Trace for profiling, fix profile

* command/debug: capture profile and trace at the same time

* command/debug: add index document

* command/debug: use "clusters" in place of members

* command/debug: remove address in output

* command/debug: improve comment on metrics sleep

* command/debug: clarify usage

* agent: always register pprof handlers and protect

This will allow us to avoid a restart of a target agent
for profiling by always registering the pprof handlers.

Given this is a potentially sensitive path, it is protected
with an operator:read ACL and enable debug being
set to true on the target agent. enable_debug still requires
a restart.

If ACLs are disabled, enable_debug is sufficient.

* command/debug: use trace.out instead of .prof

More in line with golang docs.

* agent: fix comment wording

* agent: wrap table driven tests in t.run()
2018-10-19 08:41:03 -07:00
..
catalog Add catalog CLI functions (#3204) 2017-07-14 12:45:08 -07:00
connect [WIP] Initial draft of Sidecar Service and Managed Proxy deprecation docs (#4752) 2018-10-11 10:44:42 +01:00
intention Starting Docs (#46) 2018-06-25 12:24:05 -07:00
kv Update kv docs detail for accuracy 2018-06-21 13:21:26 -05:00
operator Add UpgradeVersionTag information to docs 2017-07-18 14:01:21 -07:00
services website: docs for services CLI 2018-10-01 10:27:15 -07:00
snapshot Update the snapshot agent documentation(#4758) 2018-10-05 13:55:06 -04:00
_http_api_options_client.html.md [WIP] Initial draft of Sidecar Service and Managed Proxy deprecation docs (#4752) 2018-10-11 10:44:42 +01:00
_http_api_options_server.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
agent.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
catalog.html.md Add catalog CLI functions (#3204) 2017-07-14 12:45:08 -07:00
connect.html.md Starting Docs (#46) 2018-06-25 12:24:05 -07:00
debug.html.markdown.erb New command: consul debug (#4754) 2018-10-19 08:41:03 -07:00
event.html.markdown.erb Convert event command to use base.Command 2017-02-08 16:56:58 -05:00
exec.html.markdown.erb Clean up subprocess handling and make shell use optional (#3509) 2017-10-04 16:48:00 -07:00
force-leave.html.markdown.erb docs: Clarify force-remove limited to same DC, fixes #1264 2017-03-30 14:44:10 -04:00
index.html.md [WIP] Initial draft of Sidecar Service and Managed Proxy deprecation docs (#4752) 2018-10-11 10:44:42 +01:00
info.html.markdown.erb Convert info command to use base.Command 2017-02-08 16:58:04 -05:00
intention.html.md Starting Docs (#46) 2018-06-25 12:24:05 -07:00
join.html.markdown.erb Convert join command to use base.Command 2017-02-08 17:14:02 -05:00
keygen.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
keyring.html.markdown.erb Shows the segment name in the keyring API and command output. 2017-09-07 12:17:39 -07:00
kv.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
leave.html.markdown.erb Convert leave command to use base.Command 2017-02-09 16:48:12 -05:00
license.html.markdown.erb Add licensing documentation. 2018-05-24 10:10:00 -04:00
lock.html.markdown.erb Clean up subprocess handling and make shell use optional (#3509) 2017-10-04 16:48:00 -07:00
maint.html.markdown.erb Update maint.html.markdown.erb 2017-09-01 17:51:02 -07:00
members.html.markdown.erb Add doc sections for network segments 2017-08-31 11:19:08 -07:00
monitor.html.markdown.erb Convert monitor command to use base.Command 2017-02-09 17:31:52 -05:00
operator.html.markdown.erb Spelling (#3958) 2018-03-19 16:56:00 +00:00
reload.html.markdown.erb Convert rtt command to use base.Command 2017-02-09 19:38:06 -05:00
rtt.html.markdown.erb Removes remoteConsuls in favor of the new router. 2017-03-16 16:42:19 -07:00
services.html.md website: docs for services CLI 2018-10-01 10:27:15 -07:00
snapshot.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
validate.html.md Updates documentation for consul validate. 2017-10-19 18:59:05 -07:00
version.html.md website: rename *.markdown to *.md 2017-05-17 20:25:45 +02:00
watch.html.markdown.erb Clean up subprocess handling and make shell use optional (#3509) 2017-10-04 16:48:00 -07:00