Skip to content

Commit

Permalink
Add docs for elastic-agent diagnostics collect (elastic#1176)
Browse files Browse the repository at this point in the history
* Add docs for elastic-agent diagnostics collect

Add documentation for the elastic-agent diagnostics collect subvommand.
This command produces an archive that can be used to help debug issued
with the elastic-agent.

* Apply suggestions from code review

Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: DeDe Morton <dede.morton@elastic.co>
  • Loading branch information
michel-laterman and dedemorton authored Oct 25, 2021
1 parent 5dbdf62 commit d913b55
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions commands.asciidoc
Original file line number Diff line number Diff line change
@@ -31,21 +31,34 @@ run these commands.

Gather diagnostics information from the {agent} and applications it's running.

This command displays version numbers and application metadata.
If no options are specified, this command displays version numbers and application metadata.

If `collect` is specified, it produces an archive containing application metadata, configuration information, the policy, and any local logs.

Note that *credentials are not redacted* in the archive; they may appear in plain text in the configuration or policy files inside the archive.

[discrete]
=== Synopsis

[source,shell]
----
elastic-agent diagnostics [--help] [--output <string>] [global-flags]
elastic-agent diagnostics collect [--output <string>]
[--file <string>]
[--help]
[global-flags]
----

[discrete]
=== Options

`--output <string>`::
Output format. Specify `human`, `json`, or `yaml`. The default is `human`.
Output format. If using `collect`, specify `json` or `yaml` (the default).
Otherwise specify `json`, `yaml`, or `human` (the default).

`--file`::
Output archive name for the `collect` option.
Defaults to `elastic-agent-diagnostics-<timestamp>.zip` where the timestamp is the current time in UTC.

`--help`::
Show help for the `diagnostics` command.

0 comments on commit d913b55

Please sign in to comment.