Skip to content

Commit a15fff0

Browse files
authored
Add list of agent OOB alert rules with descriptions (#3608)
1 parent e333fd2 commit a15fff0

File tree

2 files changed

+20
-11
lines changed

2 files changed

+20
-11
lines changed

reference/fleet/alert-templates.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
---
2-
mapped_pages:
3-
- https://www.elastic.co/guide/en/fleet/current/data-streams.html
42
applies_to:
53
stack: ga 9.2
64
serverless: ga
@@ -17,23 +15,34 @@ navigation_title: Built-in alerts and templates
1715
When you install or upgrade {{agent}}, new alert rules are created automatically. You can configure and customize out-of-the-box alerts to get them up and running quickly.
1816

1917
::::{note}
20-
The built-in alerts feature for {{agent}} is available only for some subscription levels. The license (or a trial license) must be in place before you install or upgrade {{agent}} before this feature is available.
18+
The built-in alerts feature for {{agent}} is available only for some subscription levels. The license (or a trial license) must be in place _before_ you install or upgrade {{agent}} for the alert rules to be available.
2119

22-
Refer [Elastic subscriptions](https://www.elastic.co/subscriptions) for more information.
20+
Refer to [Elastic subscriptions](https://www.elastic.co/subscriptions) for more information.
2321
::::
2422

2523
In {{kib}}, you can enable out-of-the-box rules pre-configured with reasonable defaults to provide immediate value for managing agents.
26-
You can use [ES|QL](/explore-analyze/discover/try-esql.md) to author conditions for each rule.
27-
28-
Connectors are not added to rules automatically, but you can attach a connector to route alerts to your platform of choice -- Slack or email, for example.
29-
In addition, you can add filters for policies, tags, or hostnames to scope alerts to specific sets of agents
24+
You can use [{{esql}}](/explore-analyze/discover/try-esql.md) to author conditions for each rule.
3025

3126
You can find these rules in **Stack Management** > **Alerts and Insights** > **Rules**.
3227

28+
### Available alert rules [available-alert-rules]
29+
30+
| Alert | Description |
31+
| -------- | -------- |
32+
| [Elastic Agent] CPU usage spike| Checks if {{agent}} or any of its processes were pegged at a high CPU for a specified window of time. This could signal a bug in an application and warrant further investigation.<br> - Condition: Alert on `system.process.cpu.total.time.ms` over 80% for 5 minutes<br>- Default: Enabled |
33+
| [Elastic Agent] Dropped events | Checks ratio of dropped events to acknowledged events. Rows are distinguished by agent ID and component ID. <br> - Condition: Alert on ratio of dropped events to acked events of 5% or more<br>- Default: Enabled|
34+
| [Elastic Agent] Excessive memory usage| Checks if {{agent}} or any of its processes have a high memory usage or memory usage that is trending up. This could signal a memory leak in an application and warrant further investigation.<br>- Condition: Alert on `system.process.memory.rss.pct` more than 50%<br>- Default: Enabled |
35+
| [Elastic Agent] Excessive restarts| Checks for excessive restarts on a host. Some restarts can have a business impact, and getting alerts for them can enable timely mitigation.<br>- Condition: Alert on 11 or more restarts in a 5-minute window<br>- Default: Enabled |
36+
| [Elastic Agent] High pipeline queue | Checks percentage of pipeline queue. Rows are distinguished by agent ID and component ID. <br> - Condition: Alert on max of `beat.stats.libbeat.pipeline.queue.filled.pct` exceeding 90% <br>- Default: Enabled|
37+
| [Elastic Agent] Output errors | Checks errors per minute from an agent component. Rows are distinguished by agent ID and component ID. <br> - Condition: Alert on 6 or more errors per minute <br>- Default: Enabled|
38+
| [Elastic Agent] Unhealthy status | Checks agent status. An `unhealthy` status can indicate errors or degraded functionality of the agent. <br> - Condition: Alert on `unhealthy` status <br>- Default: Enabled|
39+
40+
**Connectors** are not added to rules automatically, but you can attach a connector to route alerts to your Slack, email, or other notification platforms.
41+
In addition, you can add filters for policies, tags, or hostnames to scope alerts to specific sets of agents.
3342

34-
## Alert templates assets for integrations [alert-templates]
43+
## Alert template assets for integrations [alert-templates]
3544

36-
Some integration packages include alerting rule template assets that provide pre-made definitions of alerting rules. You can use the templates to create your own custom alerting rules that you can enable and fine tune.
45+
Some integration packages include alerting rule template assets that provide pre-made definitions of alerting rules. You can use the templates to create your own custom alerting rules that you can enable and fine-tune.
3746

3847
When you click a template, you get a pre-filled rule creation form. You can define and adjust values, set up connectors, and define rule actions to create your custom alerting rule.
3948

reference/fleet/manage-integrations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ You can perform a variety of actions in the **Integrations** app in {{kib}}. Som
4747

4848
## Customize integrations [customize-integrations]
4949

50-
After you've started using integrations to ingest data, you can customize how the data is managed over time. Refer to [Index lifecycle management](/reference/fleet/data-streams.md#data-streams-ilm) to learn more.
50+
After you've started using integrations to ingest data, you can customize how the data is managed over time. Refer to [{{ilm-cap}}](/reference/fleet/data-streams.md#data-streams-ilm) to learn more.

0 commit comments

Comments
 (0)