Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 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
13 changes: 12 additions & 1 deletion explore-analyze/alerts-cases/alerts/rule-type-es-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@ When you create an {{es}} query rule, your choice of query type affects the info
| LIMIT 10
```

2. If you use query DSL, KQL, or Lucene, set the group and theshold.
2. Specify details for grouping alerts.

If you use query DSL, KQL, or Lucene, set the group and theshold.

When
: Specify how to calculate the value that is compared to the threshold. The value is calculated by aggregating a numeric field within the time window. The aggregation options are: `count`, `average`, `sum`, `min`, and `max`. When using `count` the document count is used and an aggregation field is not necessary.
Expand All @@ -65,6 +67,15 @@ When you create an {{es}} query rule, your choice of query type affects the info
Threshold
: Defines a threshold value and a comparison operator (`is above`, `is above or equals`, `is below`, `is below or equals`, or `is between`). The value calculated by the aggregation is compared to this threshold.

{applies_to}`stack: ga 9.2` If you use {{esql}}, specify a time field and how to group alerts.

Time field
: Choose the time field to use when filtering query results by the time window that you later specify for the rule. You can choose any time field that's availble on the index you're querying, for example, the `@timestamp` field.

Alert group
: Select **Create an alert if matches are found** to create a single alert for multiple events matching the {{esql}} query. Select **Create an alert for each row** to create a separate alert for each event that matches the {{esql}} query. Whenever possible, each alert will have a unique ID.


3. Set the time window, which defines how far back to search for documents.
4. If you use query DSL, KQL, or Lucene, set the number of documents to send to the configured actions when the threshold condition is met.
5. If you use query DSL, KQL, or Lucene, choose whether to avoid alert duplication by excluding matches from the previous run. This option is not available when you use a grouping field.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,9 @@ When you create an {{es}} query rule, your choice of query type affects the info
| LIMIT 10
```

2. If you use query DSL, KQL, or Lucene, set the group and theshold.
2. Specify details for grouping alerts.

If you use query DSL, KQL, or Lucene, set the group and theshold.

When
: Specify how to calculate the value that is compared to the threshold. The value is calculated by aggregating a numeric field within the time window. The aggregation options are: `count`, `average`, `sum`, `min`, and `max`. When using `count` the document count is used and an aggregation field is not necessary.
Expand All @@ -71,6 +73,14 @@ When you create an {{es}} query rule, your choice of query type affects the info
Threshold
: Defines a threshold value and a comparison operator (`is above`, `is above or equals`, `is below`, `is below or equals`, or `is between`). The value calculated by the aggregation is compared to this threshold.

{applies_to}`stack: ga 9.2` If you use {{esql}}, specify a time field and how to group alerts.

Time field
: Choose the time field to use when filtering query results by the time window that you later specify for the rule. You can choose any time field that's availble on the index you're querying, for example, the `@timestamp` field.

Alert group
: Select **Create an alert if matches are found** to create a single alert for multiple events matching the {{esql}} query. Select **Create an alert for each row** to create a separate alert for each event that matches the {{esql}} query. Whenever possible, each alert will have a unique ID.

3. Set the time window, which defines how far back to search for documents.
4. If you use query DSL, KQL, or Lucene, set the number of documents to send to the configured actions when the threshold condition is met.
5. If you use query DSL, KQL, or Lucene, choose whether to avoid alert duplication by excluding matches from the previous run. This option is not available when you use a grouping field.
Expand Down
Loading