Skip to content

Commit 10fbdd2

Browse files
nastasha-solomonmarshallmainjoepeeples
authored
[DOCS] Advanced rule query preview option available (#2251)
Co-authored-by: Marshall Main <55718608+marshallmain@users.noreply.github.com> Co-authored-by: Joe Peeples <joe.peeples@elastic.co>
1 parent 7df91b6 commit 10fbdd2

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed
13.1 KB
Loading

docs/detections/rules-ui-create.asciidoc

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -266,9 +266,13 @@ NOTE: To preview rules, you need the `read` privilege to the `.preview.alerts-se
266266
To preview a rule:
267267

268268
. Write the rule query.
269+
. Choose how you want to preview the query results:
270+
271+
** *Quick query preview*: Select from pre-defined time frames -- *Last hour*, *Last day*, or *Last month* -- when previewing rule results. Note that threshold and event correlation rules have limited time frame options. The rule interval and look-back time are also pre-defined for the preview and differ by rule type. These settings cannot be modified.
272+
** *Advanced query preview*: Choose a custom time frame for the rule preview, schedule how often the rule should run, and specify a look-back time.
269273
+
270-
. Select a timeframe of data to preview query results -- *Last hour*, *Last day*, or *Last month* -- from the *Quick query preview* drop-down.
271-
+
274+
TIP: Avoid setting long time frames with short rule intervals. This might cause the rule preview to timeout.
275+
272276
. Click *Preview results*. The rule preview shows a histogram and alerts table with the alerts you can expect, based on the defined rule parameters and historical events in your indices. You can view the details of a particular alert by clicking the *View details* button in the alerts table.
273277
+
274278
NOTE: The preview excludes the effects of rule exceptions and timestamp overrides. In the preview histogram, alerts are stacked by `event.category` (or `host.name` for machine learning rules), and events with multiple values are counted more than once.

0 commit comments

Comments
 (0)