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.13] [Redo][8.6-8.13] Highlight that rule exceptions are case-sensitive (backport #4805) #4825

Merged
merged 2 commits into from
Feb 19, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e8a4f1d
[Redo][8.6-8.13] Highlight that rule exceptions are case-sensitive (#…
nastasha-solomon Feb 16, 2024
384bb14
Fixed ordering
nastasha-solomon Feb 19, 2024
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
6 changes: 5 additions & 1 deletion docs/detections/add-exceptions.asciidoc
View file
Open in desktop
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.
+
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 @@ -178,6 +180,8 @@ 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]
======
* 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>>.
Expand Down