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

[8.10] Custom highlighted fields (backport #3852) #3913

Merged
merged 1 commit into from
Sep 11, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/detections/add-exceptions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ 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.
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.
+
Expand Down
4 changes: 4 additions & 0 deletions docs/detections/api/rules/rules-api-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,10 @@ Required when `actions` are used to send notifications.

|version |Integer |The rule's version number. Defaults to `1`.

|investigation_fields |Object a| Specify highlighted fields for personalized alert investigation flows:

* `field_names`: String, required

|==============================================

[[opt-fields-query-eql]]
Expand Down
3 changes: 3 additions & 0 deletions docs/detections/rules-ui-create.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,9 @@ the rule. For example, links to background information.
.. *False positive examples* (optional): List of common scenarios that may produce
false-positive alerts.
.. *MITRE ATT&CK^TM^ threats* (optional): Add relevant https://attack.mitre.org/[MITRE] framework tactics, techniques, and subtechniques.
.. *Custom highlighted fields* (optional): Specify highlighted fields for personalized alert investigation flows. Fields with values are added to the <<investigation-section,Highlighted fields>> section within the alert details flyout. Fields without values aren't added. After you create the rule, you can find all custom highlighted fields in the About section of the rule details page.
+
NOTE: There's no limit to the number of custom highlighted fields you can add.
.. *Investigation guide* (optional): Information for analysts investigating
alerts created by the rule. You can also add action buttons to <<invest-guide-run-osquery, run Osquery>> or <<interactive-investigation-guides, launch Timeline investigations>> using alert data.
.. *Author* (optional): The rule's authors.
Expand Down