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.

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

Adding warning to exceptions that describes field conflicts and mapping issues #3025

Merged
merged 36 commits into from
Mar 28, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
f400ecf
First draft
nastasha-solomon Feb 27, 2023
5ee8f83
Revisions
nastasha-solomon Feb 27, 2023
2c3072b
New section
nastasha-solomon Feb 28, 2023
02f8d01
Adding images
nastasha-solomon Feb 28, 2023
79b401e
New images
nastasha-solomon Feb 28, 2023
0f9bdd0
Fixed formatting and images issues
nastasha-solomon Feb 28, 2023
b631296
Adding more examples
nastasha-solomon Feb 28, 2023
b4f9448
Resize icon
nastasha-solomon Feb 28, 2023
9634648
Fixed anchors
nastasha-solomon Feb 28, 2023
e9c2136
Merge branch 'main' into issue-2957-excep-mapping-conflicts
nastasha-solomon Mar 6, 2023
adb3f7b
Revisions
nastasha-solomon Mar 7, 2023
c30d761
Merge branch 'main' into issue-2957-excep-mapping-conflicts
nastasha-solomon Mar 7, 2023
e754de2
Small revisions
nastasha-solomon Mar 7, 2023
d02d4fc
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 7, 2023
ff181b4
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 7, 2023
5e0ef66
Update docs/detections/add-exceptions.asciidoc
nastasha-solomon Mar 7, 2023
72ef8d4
Update docs/detections/add-exceptions.asciidoc
nastasha-solomon Mar 8, 2023
00946a2
Update docs/detections/add-exceptions.asciidoc
nastasha-solomon Mar 8, 2023
48c42d1
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 8, 2023
1589c8e
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 8, 2023
0bcac39
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 8, 2023
03ae98d
Minor edits and resizing
nastasha-solomon Mar 8, 2023
80d16ab
Merge branch 'main' into issue-2957-excep-mapping-conflicts
nastasha-solomon Mar 19, 2023
73940bd
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 21, 2023
90d28c0
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 21, 2023
83794f6
sum deets
nastasha-solomon Mar 21, 2023
78a4200
Screenshot refresh
nastasha-solomon Mar 21, 2023
6073f81
re-adding image
nastasha-solomon Mar 21, 2023
44d5af5
Update docs/detections/add-exceptions.asciidoc
nastasha-solomon Mar 27, 2023
dcce54e
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 27, 2023
4416a83
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 27, 2023
c43ad01
Merge branch 'main' into issue-2957-excep-mapping-conflicts
nastasha-solomon Mar 27, 2023
03f63b4
Update docs/detections/add-exceptions.asciidoc
nastasha-solomon Mar 27, 2023
f25535a
Merge branch 'main' into issue-2957-excep-mapping-conflicts
nastasha-solomon Mar 28, 2023
3722e96
Update docs/troubleshooting/detections/detection-rules.asciidoc
nastasha-solomon Mar 28, 2023
38c34bb
Merge branch 'main' into issue-2957-excep-mapping-conflicts
nastasha-solomon Mar 28, 2023
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
11 changes: 8 additions & 3 deletions docs/detections/add-exceptions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,11 @@ image::images/add-exception-ui.png[]
Add conditions that define when the exception prevents alerts:

.. *Field*: Select a field to identify the event being filtered.
+
[TIP]
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
=======
Fields with conflicts are marked with a warning icon (image:images/field-warning-icon.png[Field conflict warning icon,20,20]). Using these fields and might cause unexpected exceptions behavior. For more information, refer to <<rule-exceptions-field-conflicts>>.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved
=======

.. *Operator*: Select an operator to define the condition:
* `is` | `is not` — Must be an exact match of the defined value.
Expand All @@ -72,9 +77,7 @@ Add conditions that define when the exception prevents alerts:
* Wildcards are not supported in value lists.
* If a value list can't be used due to <<manage-value-lists,size or data type>>, it'll be unavailable in the *Value* menu.
=======
* `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].
+
NOTE: Some characters must be escaped with a backslash, such as `\\` for a literal backslash, `\*` for an asterisk, and `\?` for a question mark. Windows paths must be divided with double backslashes (for example, `C:\\Windows\\explorer.exe`), and paths that already include double backslashes might require four backslashes for each divider.
* `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].
+
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.

Expand Down Expand Up @@ -158,6 +161,8 @@ image::images/endpoint-add-exp.png[]
. If required, modify the conditions.
+
NOTE: Refer to <<ex-nested-conditions>> for more information on when nested conditions are required.
+
TIP: Fields with conflicts are marked with a warning icon (image:images/field-warning-icon.png[Field conflict warning icon,20,20]). Using these fields and might cause unexpected exceptions behavior. For more information, refer to <<understanding-field-conflicts>>.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

. You can select any of the following:

Expand Down
37 changes: 37 additions & 0 deletions docs/troubleshooting/detections/detection-rules.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,40 @@ You can resolve this by expanding the time range, or by configuring {kib}'s auto

CAUTION: Turning off `autocomplete:useTimeRange` could cause performance issues if the data set is especially large.
====

[discrete]
[[rule-exceptions-field-conflicts]]
.Warning about type conflicts and unmapped fields
[%collapsible]
====

A warning icon (image:images/field-warning-icon.png[Field conflict warning icon,15,15]) and message appears for fields that have <<fields-with-conflicting-types,conflicting types>> or are <<unmapped-field-conflict,unmapped>> across specified indices. You can learn more about the conflict by hovering over the field. After you select it, the warning message is displayed beneath the field.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

NOTE: A field can have conflicting types _and_ be unmapped in specified indices.
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

[role="screenshot"]
image::images/warning-icon-message.png[Shows the warning icon and message,80%]

[float]
[[fields-with-conflicting-types]]
==== Fields with conflicting types

Type conflicts occur when a field is mapped to different types across multiple indices. Use the information about a field's type mapping to ensure you're entering correct field values when defining exception conditions.

In the following example, the selected field has been defined as different types across five indices.

[role="screenshot"]
image::images/warning-type-conflicts.png[Warning for unmapped fields,80%]
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

[float]
[[unmapped-field-conflict]]
==== Unmapped fields

Unmapped fields are undefined within an index's mapping definition. Selecting an unmapped field could stop the exception from being applied to the rule's indices. This could lead to false positives or unexpected alerts being created.

In the following example, the selected field has type conflicts and is unmapped across two indices. It also has type conflicts in three indices.

[role="screenshot"]
image::images/warning-unmapped-fields.png[Warning for unmapped fields,80%]
nastasha-solomon marked this conversation as resolved.
Show resolved Hide resolved

====
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.