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.

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

Describe how to view Elastic Agent status #884

Merged
merged 6 commits into from
Jul 31, 2021
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,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-configuration.asciidoc[leveloffset=+1]

include::elastic-agent-dynamic-inputs.asciidoc[leveloffset=+1]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
[[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 pending, but there might be
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
manual agent binary updates available.
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

| *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 inactive.
dedemorton marked this conversation as resolved.
Show resolved Hide resolved

|===

//QUESTION: What elase can we say about the offline status? That the agent
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
//might be stopped or no longer able to connect to Fleet? What else?

//QUESTION: What does inactive mean? It shows up in the dropdown.

//QUESTION: Can users set alerts on these statuses yet? If so, we should mention
//that here.

[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.
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
+
[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:

//TODO: uncomment after logging topic is merged.
//* <<elastic-agent-logging>>
dedemorton marked this conversation as resolved.
Show resolved Hide resolved
* {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.
Binary file added docs/en/ingest-management/images/agent-status.png
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.