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 elastic-agent diagnostics documentation #1164

Merged
merged 4 commits into from
Oct 15, 2021
Merged

Add elastic-agent diagnostics documentation #1164

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f601f9
Add elastic-agent diagnostics documentation
michel-laterman Oct 13, 2021
b7cfa57
Fix typo
michel-laterman Oct 14, 2021
fc0c9a6
Apply suggestions from code review
michel-laterman Oct 15, 2021
49a3d78
Move diagnostics command to top
michel-laterman Oct 15, 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
48 changes: 44 additions & 4 deletions docs/en/ingest-management/commands.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
{agent} provides commands for running {agent}, managing {fleet-server}, and
doing common tasks:

* <<elastic-agent-diagnostics-command,diagnostics>>
* <<elastic-agent-enroll-command,enroll>>
* <<elastic-agent-help-command,help>>
* <<elastic-agent-inspect-command,inspect>>
Expand All @@ -24,6 +25,45 @@ run these commands.
<hr>
++++

[discrete]
[[elastic-agent-diagnostics-command]]
== elastic-agent diagnostics

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

This command displays version numbers and application metadata.

[discrete]
=== Synopsis

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

[discrete]
=== Options

`--output <string>`::
Output format. Specify `human`, `json`, or `yaml`. The default is `human`.

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

{global-flags-link}

[discrete]
=== Example

[source,shell]
----
elastic-agent diagnostics
----

++++
<hr>
++++

[discrete]
[[elastic-agent-enroll-command]]
== elastic-agent enroll
Expand All @@ -39,7 +79,7 @@ the {agent} from a DEB or RPM package and plan to use systemd commands to
start and manage the service. This command is also useful for testing
{agent} prior to installing it.

If you've already installed {agent}, use this command to modify the settings that {agent} runs with.
If you've already installed {agent}, use this command to modify the settings that {agent} runs with.

TIP: To enroll an {agent} _and_ install it as a service, use the
<<elastic-agent-install-command,`install` command>> instead. Installing as a service is the most common scenario.
Expand Down Expand Up @@ -128,7 +168,7 @@ Private key to use for exposed {fleet-server} HTTPS endpoint.

`--fleet-server-es <string>`::
Start a {fleet-server} process when {agent} is started, and connect to the
specified {es} URL.
specified {es} URL.

`--fleet-server-es-ca <string>`::
Path to certificate authority to use to communicate with {es}.
Expand All @@ -150,7 +190,7 @@ instead of the Default Fleet Server policy.
{fleet-server} HTTP binding port (overrides the policy).

`--fleet-server-service-token <string>`::
Service token to use for communication with {es}.
Service token to use for communication with {es}.

`--force`::
Force overwrite of current configuration without prompting for confirmation.
Expand Down Expand Up @@ -558,7 +598,7 @@ elastic-agent run -c myagentconfig.yml
Permanently uninstall {agent} from the system.

You must run this command as the root user (or Administrator on Windows)
to remove files.
to remove files.

[discrete]
=== Synopsis
Expand Down