Skip to content

Commit

Permalink
[8.9] [Redo][8.6-8.13] Highlight that rule exceptions are case-sensit…
Browse files Browse the repository at this point in the history
…ive (backport #4805) (#4829)

* [Redo][8.6-8.13] Highlight that rule exceptions are case-sensitive (#4805)

(cherry picked from commit 99658d9)

# Conflicts:
#	docs/detections/add-exceptions.asciidoc

* Fixed conflict

* Removed extra content

* note formatting

---------

Co-authored-by: Nastasha Solomon <[email protected]>
Co-authored-by: nastasha.solomon <[email protected]>
  • Loading branch information
3 people authored Feb 19, 2024
1 parent 888cd44 commit bc1e8af
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/detections/add-exceptions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,12 @@ image::images/rule-exception-tab.png[Detail of rule exceptions tab]
. In the *Add rule exception* flyout, name the exception.
. Add conditions that define the exception. When the exception's query evaluates to `true`, rules don't generate alerts even when their criteria are met.
+
NOTE: When you create a new exception from an alert, exception conditions are auto-populated with relevant alert data. A comment describing this action is also automatically added to the **Add comments** section.
IMPORTANT: Rule exceptions are case-sensitive, which means that any character that's entered as an uppercase or lowercase letter will be treated as such. In the event you _don't_ want a field evaluated as case-sensitive, some ECS fields have a `.caseless` version that you can use.
+
NOTE: When you create a new exception from an alert, exception conditions are auto-populated with relevant alert data. Data from custom highlighted fields is listed first. A comment that describes the auto-generated exception conditions is also added to the **Add comments** section.

.. *Field*: Select a field to identify the event being filtered.
+
+
[NOTE]
=======
A warning displays for fields with conflicts. Using these fields might cause unexpected exceptions behavior. Refer to <<rule-exceptions-field-conflicts,Troubleshooting type conflicts and unmapped fields>> for more information.
Expand Down Expand Up @@ -177,10 +179,15 @@ The *Add Endpoint Exception* flyout opens.
image::images/endpoint-add-exp.png[]

. If required, modify the conditions.
+
IMPORTANT: Rule exceptions are case-sensitive, which means that any character that's entered as an uppercase or lowercase letter will be treated as such. In the event you _don't_ want a field evaluated as case-sensitive, some ECS fields have a `.caseless` version that you can use.
+
NOTE: Refer to <<ex-nested-conditions>> for more information on when nested conditions are required.
+
NOTE: Fields with conflicts are marked with a warning icon (image:images/field-warning-icon.png[Field conflict warning icon,13,13]). Using these fields might cause unexpected exceptions behavior. For more information, refer to <<rule-exceptions-field-conflicts, Troubleshooting type conflicts and unmapped fields>>.
[NOTE]
=======
* Refer to <<ex-nested-conditions>> for more information on when nested conditions are required.
* Fields with conflicts are marked with a warning icon (image:images/field-warning-icon.png[Field conflict warning icon,13,13]). Using these fields might cause unexpected exceptions behavior. For more information, refer to <<rule-exceptions-field-conflicts, Troubleshooting type conflicts and unmapped fields>>.
=======

. You can select any of the following:

Expand Down

0 comments on commit bc1e8af

Please sign in to comment.