Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for elastic-agent diagnostics collect #1176

Merged
merged 2 commits into from
Oct 25, 2021
Merged

Add docs for elastic-agent diagnostics collect #1176

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c48eebb
Add docs for elastic-agent diagnostics collect
michel-laterman Oct 18, 2021
e516887
Apply suggestions from code review
michel-laterman Oct 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions docs/en/ingest-management/commands.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down