Skip to content

Commit

Permalink
Add enhanced alerting details to host monitoring docs (#3879)
Browse files Browse the repository at this point in the history
* Add enhanced alerting details to host monitoring docs

* Clarify config required to show alerts on Hosts page

* Change the note to an informational box

* Fix sentence

(cherry picked from commit 625d303)
  • Loading branch information
dedemorton authored and mergify[bot] committed May 20, 2024
1 parent 46682fa commit 4f6f165
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 3 deletions.
Binary file modified docs/en/observability/images/hosts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/en/observability/images/metrics-overlay.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 17 additions & 3 deletions docs/en/observability/monitor-infra/analyze-hosts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,9 +35,9 @@ averages of key metrics, including CPU usage, memory usage, and throughput.
default is 50, which means the page shows data for the top 50 hosts based on the
most recent timestamps. You can increase the host limit to see data for more
hosts, but doing so may impact query performance.
* The Hosts table shows a breakdown of metrics for each host. You may need to
page through the list or change the number of rows displayed on each page to see
all of your hosts.
* The Hosts table shows a breakdown of metrics for each host along with an alert count
for any hosts with active alerts. You may need to page through the list
or change the number of rows displayed on each page to see all of your hosts.
* Each host name is an active link to a <<view-host-details, host details>> page,
which includes metrics, host metadata, alerts, processes, logs, and anomalies.
You can optionally open the host details in an overlay.
Expand All @@ -46,6 +46,8 @@ the already returned data set.
* The tabs at the bottom of the page show an overview of the metrics, logs,
and alerts for all hosts returned by your search.

TIP: For more information about creating and viewing alerts, refer to <<create-alerts>>.

[discrete]
[[analyze-hosts-filter-view]]
== Filter the Hosts view
Expand Down Expand Up @@ -170,6 +172,18 @@ image::images/hosts-view-alerts.png[Screenshot showing Alerts view]

To see alerts for a specific host, refer to <<view-host-details>>.

*****
**Why are alerts missing from the Hosts page?**
If your rules are triggering alerts that don't appear on the **Hosts** page,
edit the rules and make sure they are correctly configured to associate the host name with the alert:
* For Metric threshold or Custom threshold rules, select `host.name` in the **Group alerts by** field.
* For Inventory rules, select **Host** for the node type under **Conditions**.
To learn more about creating and managing rules, refer to <<create-alerts>>.
*****

[discrete]
[[view-host-details]]
== View host details
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Change the time range to view metrics over a specific period of time.

Hover over a specific time period on a chart to compare the various metrics at that given time.

Expand the **Alerts** section to see alerts related to the selected host.

====
[%collapsible]
Expand Down

0 comments on commit 4f6f165

Please sign in to comment.