diff --git a/docs/en/ingest-management/elastic-agent/elastic-agent.asciidoc b/docs/en/ingest-management/elastic-agent/elastic-agent.asciidoc index 128f13cb54..0afa14b7f6 100644 --- a/docs/en/ingest-management/elastic-agent/elastic-agent.asciidoc +++ b/docs/en/ingest-management/elastic-agent/elastic-agent.asciidoc @@ -48,6 +48,8 @@ include::stop-elastic-agent.asciidoc[leveloffset=+1] include::unenroll-elastic-agent.asciidoc[leveloffset=+1] +include::view-elastic-agent-status.asciidoc[leveloffset=+1] + include::elastic-agent-dynamic-inputs.asciidoc[leveloffset=+1] include::elastic-agent-capabilities.asciidoc[leveloffset=+1] diff --git a/docs/en/ingest-management/elastic-agent/view-elastic-agent-status.asciidoc b/docs/en/ingest-management/elastic-agent/view-elastic-agent-status.asciidoc new file mode 100644 index 0000000000..35d82a4d8a --- /dev/null +++ b/docs/en/ingest-management/elastic-agent/view-elastic-agent-status.asciidoc @@ -0,0 +1,68 @@ +[[view-elastic-agent-status]] +[role="xpack"] += View status of {agent}s + +To view the status of your {fleet}-managed agents, go to +*Management > Fleet > Agents*. + +[role="screenshot"] +image::images/agent-status.png[Agents tab showing status of each {agent}] + +{fleet} reports these statuses: + +|=== + +| *Healthy* | The {agent} is online and running as expected. There are no agent +policy updates or automatic agent binary updates in progress, but the +agent binary may still be out of date. + +| *Unhealthy* | The {agent} is online, but requires attention because it's +reporting either agent or integration-level errors. + +| *Updating* | The {agent} is online and updating the agent policy, updating the +binary, or enrolling or unenrolling from {fleet}. + +| *Offline* | The {agent} has not checked in during the expected time period. + +| *Inactive* | The {agent} is no longer enrolled in {fleet}. The agent must reenroll to connect to {fleet} again. + +|=== + +[discrete] +[[view-agent-list]] +== Filter the list of agents + +To filter the list of agents by status, click the *Status* dropdown and select +one or more statuses. + +[role="screenshot"] +image::images/agent-status-filter.png[Agent Status dropdown with mutliple statuses selected] + +For advanced filtering, use the search bar to create structured queries +using {kibana-ref}/kuery-query.html[Kibana Query Language]. For example, enter +`local_metadata.os.family : "darwin"` to see only agents running on macOS. + +[discrete] +[[view-agent-logs]] +== View agent logs + +When {fleet} reports a status like `Offline` or `Unhealthy`, you might want to +view the agent logs to diagnose potential causes. If logging is configured for +the agent: + +. Under *Agents*, click the agent name listed in the *Host* column. + +. Click the *Logs* tab. ++ +On the *Logs* tab you can filter, search, and explore the agent logs. +You can also remotely turn on debug logging by changing the log level. ++ +[role="screenshot"] +image::images/view-agent-logs.png[View agent logs under agent details] ++ +To tail the agent log files in real time, click *Open in Logs*. + +For more information about logging, refer to: + +* <> +* {observability-guide}/tail-logs.html[Tail log files] diff --git a/docs/en/ingest-management/images/agent-status-filter.png b/docs/en/ingest-management/images/agent-status-filter.png new file mode 100644 index 0000000000..da7ba774b7 Binary files /dev/null and b/docs/en/ingest-management/images/agent-status-filter.png differ diff --git a/docs/en/ingest-management/images/agent-status.png b/docs/en/ingest-management/images/agent-status.png new file mode 100644 index 0000000000..96525b84ac Binary files /dev/null and b/docs/en/ingest-management/images/agent-status.png differ diff --git a/docs/en/ingest-management/images/view-agent-logs.png b/docs/en/ingest-management/images/view-agent-logs.png new file mode 100644 index 0000000000..206afd1635 Binary files /dev/null and b/docs/en/ingest-management/images/view-agent-logs.png differ