Skip to content

Commit

Permalink
[DOCS] Add information on KQL filtering in APM rules (#170257)
Browse files Browse the repository at this point in the history
Closes elastic/observability-docs#3160

## Summary

Adds information on KQL filtering in APM rules.

### Checklist

- [x] @colleenmcginnis initial draft
- [x] @benakansara review
    * In what version was this initially added? 8.10.0?
- [ ] @colleenmcginnis address feedback, merge
  • Loading branch information
colleenmcginnis authored Nov 2, 2023
1 parent f1fa4b0 commit e5bb85b
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/apm/apm-alerts.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,22 @@ Based on the criteria above, define the following rule details:
* **Group alerts by** - `service.name` `service.environment`
* **Check every** - `1 minute`

[NOTE]
====
Alternatively, you can use a KQL filter to limit the scope of the alert:
. Toggle on *Use KQL Filter*.
. Add a filter, for example to achieve the same effect as the example above:
+
[source,txt]
------
service.name:"{your_service.name}" and service.environment:"{your_service.environment}" and error.grouping_key:"{your_error.ID}"
------
Using a KQL Filter to limit the scope is available for _Latency threshold_, _Failed transaction rate threshold_, and
_Error count threshold_ rules.
====

Select the **Email** connector and click **Create a connector**.
Fill out the required details: sender, host, port, etc., and click **save**.

Expand Down
Binary file modified docs/apm/images/apm-alert.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e5bb85b

Please sign in to comment.