Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[8.7] Document the behavior of IM rules and multi-value indicator documents (backport #4326) #4400

Merged
merged 1 commit into from
Dec 6, 2023
Merged

[8.7] Document the behavior of IM rules and multi-value indicator documents (backport #4326) #4400

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 7 additions & 2 deletions docs/detections/rules-ui-create.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,7 @@ NOTE: For sequence events, the {security-app} generates a single alert when all
NOTE: {elastic-sec} provides limited support for indicator match rules. See <<support-indicator-rules>> for more information.

. To create a rule that searches for events whose specified field value matches the specified indicator field value in the indicator index patterns, select *Indicator Match*, then fill in the following fields:

.. *Source*: The individual index patterns or data view that specifies what data to search.
.. *Custom query*: The query and filters used to retrieve the required results from
the {elastic-sec} event indices. For example, if you want to match documents that only contain a `destination.ip` address field, add `destination.ip : *`.
Expand All @@ -265,9 +266,13 @@ IMPORTANT: Data in indicator indices must be <<ecs-compliant-reqs, ECS compatibl
+
.. *Indicator index query*: The query and filters used to filter the fields from
the indicator index patterns. The default query `@timestamp > "now-30d/d"` searches specified indicator indices for indicators ingested during the past 30 days and rounds the start time down to the nearest day (resolves to UTC `00:00:00`).
.. *Indicator mapping*: Compares the values of the specified event and indicator field
values. When the field values are identical, an alert is generated. To define
.. *Indicator mapping*: Compares the values of the specified event and indicator fields, and generates an alert if the values are identical.
+
NOTE: Only single-value fields are supported.
+
To define
which field values are compared from the indices add the following:

** *Field*: The field used for comparing values in the {elastic-sec} event
indices.
** *Indicator index field*: The field used for comparing values in the indicator
Expand Down