forked from elastic/observability-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Describe how to view Elastic Agent status (elastic#884) (elastic#936)
* Document Elastic Agent statuses * Add missing images * Remove redundant logging info and crop images * Fix minor typo in comment * Apply review suggestions from mostlyjason
- Loading branch information
1 parent
6ae461d
commit a5c9b05
Showing
5 changed files
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
68 changes: 68 additions & 0 deletions
68
docs/en/ingest-management/elastic-agent/view-elastic-agent-status.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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: | ||
|
||
* <<elastic-agent-logging>> | ||
* {observability-guide}/tail-logs.html[Tail log files] |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.