You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
See <<lists-api-overview>> for information about creating exception items from
7
+
Refer to <<lists-api-overview>> for information about creating exception items from
8
8
lists, such as a list of IP addresses or host names.
9
9
10
10
NOTE: Before creating exception items, you must create an exception container.
@@ -98,10 +98,11 @@ Can be:
98
98
99
99
* `match`: Must be an exact match of the defined value.
100
100
* `match_any`: Matches any of the defined values.
101
-
* `exists`: The `field` exists.
101
+
* `exists`: The field exists.
102
102
* `list`: The field matches values in a list container.
103
+
* `wildcard`: Matches `value` using wildcards, such as `C:\path\*\app.exe`. Use `?` to match one character and `*` to match zero or more characters. The `field` data type must be {ref}/keyword.html#keyword-field-type[keyword], {ref}/text.html#text-field-type[text], or {ref}/keyword.html#wildcard-field-type[wildcard].
103
104
* `nested`: Array of `entries` objects. Nested conditions are required for
104
-
excluding some Endpoint fields (<<nested-field-ex-api, see example below>>).
105
+
excluding some Endpoint fields (<<nested-field-ex-api, refer to example below>>).
105
106
<<ex-nested-conditions>> lists all Endpoint fields that require the `nested`
106
107
type.
107
108
@@ -114,7 +115,7 @@ String[]
114
115
115
116
a|Field value or values:
116
117
117
-
* String: When the `type` is `match`.
118
+
* String: When the `type` is `match` or `wildcard`.
Copy file name to clipboardExpand all lines: docs/detections/detections-ui-exceptions.asciidoc
+32-25Lines changed: 32 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -67,7 +67,7 @@ To view, delete, or export existing value lists:
67
67
[role="screenshot"]
68
68
image::images/manage-value-list.png[]
69
69
70
-
TIP: You can also use value lists as the indicator match index when creating an indicator match rule. See <<indicator-value-lists>> for more information.
70
+
TIP: You can also use a value list as the indicator match index when creating an indicator match rule. Refer to <<indicator-value-lists>> for more information.
71
71
72
72
[float]
73
73
[[detection-rule-exceptions]]
@@ -77,15 +77,15 @@ You can add exceptions to a rule from the rule details page or the Alerts table.
77
77
When you add an exception, you can also close all alerts that meet the
78
78
exception's criteria.
79
79
80
-
IMPORTANT: To ensure an exception is successfully applied, make sure that the fields you've defined for the exception query are correctly and consistently mapped in their respective indices. Refer to {ecs-ref}[ECS] to learn more about supported mappings.
81
-
82
80
[IMPORTANT]
83
81
==============
84
-
Be careful when adding exceptions to event correlation rules. Exceptions are evaluated against every event in the sequence, and when the exception matches _all_ event(s) in the sequence, alerts _are not_ generated. If the exception only matches _some_ of the events in the sequence, alerts _are_ generated.
82
+
* To ensure an exception is successfully applied, make sure that the fields you've defined for the exception query are correctly and consistently mapped in their respective indices. Refer to {ecs-ref}[ECS] to learn more about supported mappings.
85
83
84
+
* Be careful when adding exceptions to <<create-eql-rule,event correlation>> rules. Exceptions are evaluated against every event in the sequence, and when the exception matches _all_ event(s) in the sequence, alerts _are not_ generated. If the exception only matches _some_ of the events in the sequence, alerts _are_ generated.
85
+
+
86
86
To exclude values from a
87
87
specific event in the sequence, update the rule's EQL statement. For example:
88
-
88
+
+
89
89
[source,eql]
90
90
----
91
91
`sequence
@@ -117,27 +117,34 @@ The *Add Rule Exception* flyout opens (the example below was opened from the Ale
117
117
+
118
118
[role="screenshot"]
119
119
image::images/add-exception-ui.png[]
120
-
. Add conditions that define when the exception prevents alerts. You can define
121
-
multiple conditions with `OR` and `AND` relationships. In the example above,
122
-
the exception prevents the rule from generating alerts when the
120
+
. Use the following settings to add conditions that define when the exception prevents alerts. In the example above, the exception prevents the rule from generating alerts when the
123
121
`svchost.exe` process runs on agent hostname `siem-kibana`.
124
-
+
125
-
[IMPORTANT]
126
-
============
127
-
* You can use nested conditions. However, this is only required for
128
-
<<nested-field-list, these fields>>. For all other fields, nested conditions
129
-
should not be used.
130
122
131
-
* Wildcards are not supported in rule exceptions or value lists. Values must be literal values.
132
-
============
123
+
.. *Field*: Select a field to identify the event being filtered.
124
+
125
+
.. *Operator*: Select an operator to define the condition:
126
+
* `is` | `is not` — Must be an exact match of the defined value.
127
+
* `is one of` | `is not one of` — Matches any of the defined values.
128
+
* `exists` | `does not exist` — The field exists.
129
+
* `is in list` | `is not in list` — Matches values in a value list.
133
130
+
134
-
If you have created value lists, you can use them to exclude or include all
135
-
values in a list with `is in list` and `is not in list` operators:
131
+
[NOTE]
132
+
=======
133
+
* An exception defined by a value list must use `is in list` or `is not in list` in all conditions.
134
+
* Wildcards are not supported in value lists.
135
+
=======
136
+
* `matches` | `does not match` — Allows you to use wildcards in *Value*, such as `C:\path\*\app.exe`. Available wildcards are `?` (match one character) and `*` (match zero or more characters). The selected *Field* data type must be {ref}/keyword.html#keyword-field-type[keyword], {ref}/text.html#text-field-type[text], or {ref}/keyword.html#wildcard-field-type[wildcard].
136
137
+
137
-
[role="screenshot"]
138
-
image::images/exceptions-ui-list.png[]
139
-
NOTE: When using a list, all exception statements must use `is in list` and
140
-
`is not in list` operators.
138
+
IMPORTANT: Using wildcards can impact performance. To create a more efficient exception using wildcards, use multiple conditions and make them as specific as possible. For example, adding conditions using `process.name` or `file.name` can help limit the scope of wildcard matching.
139
+
140
+
.. *Value*: Enter the value associated with the *Field*. To enter multiple values (when using `is one of` or `is not one of`), enter each value, then press **Return**.
141
+
142
+
. Click *AND* or *OR* to create multiple conditions and define their relationships.
143
+
144
+
. Click *Add nested condition* to create conditions using nested fields. This is only required for
145
+
<<nested-field-list, these nested fields>>. For all other fields, nested conditions should not be used.
146
+
147
+
. (Optional) Enter a comment describing the exception.
141
148
142
149
. Select one of the following alert actions:
143
150
@@ -197,7 +204,7 @@ The *Add Endpoint Exception* flyout opens, from either the rule details page or
197
204
image::images/endpoint-add-exp.png[]
198
205
. If required, modify the conditions.
199
206
+
200
-
NOTE: See <<ex-nested-conditions>> for more information on when nested conditions are required.
207
+
NOTE: Refer to <<ex-nested-conditions>> for more information on when nested conditions are required.
201
208
202
209
. You can select any of the following:
203
210
@@ -297,8 +304,8 @@ If no attribute is selected, the app searches the list name by default.
297
304
To export or delete an exception list, select the required action button on the appropriate list. Note that:
298
305
299
306
* Exception lists are exported to `.ndjson` files.
300
-
* Exception lists are also exported as part of any exported detection rules configured with exceptions. See <<import-export-rules-ui>>.
301
-
* If a list is linked to any rules, you'll see a warning appear that asks you to confirm the deletion. If no rules are linked to a list, it is deleted without confirmation.
307
+
* Exception lists are also exported as part of any exported detection rules configured with exceptions. Refer to <<import-export-rules-ui>>.
308
+
* If an exception list is linked to any rules, you'll get a warning asking you to confirm the deletion. If no rules are linked, the list is deleted without confirmation.
302
309
303
310
[role="screenshot"]
304
311
image::images/actions-exception-list.png[Detail of Exception lists table with export and delete buttons highlighted,400]
0 commit comments