-
Notifications
You must be signed in to change notification settings - Fork 209
[DOCS] Updating "Manage detection alerts" topic #666
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
Changes from 15 commits
7b6e59d
8def142
6a1ff99
530e739
a329e56
ad0df32
a67798e
f758ba0
88a8b2c
89b32c6
c86ec95
902064f
4d82784
dffc4bf
9c07fb6
5e526a9
2a428d4
508b8fd
0a695f8
359914e
5cb41c3
4094b03
e57a028
1033b26
49027c8
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,77 @@ | ||
| [[alerts-ui-manage]] | ||
| [role="xpack"] | ||
| == Managing detection alerts | ||
| == Manage detection alerts | ||
|
|
||
| The Detections page displays all <<detection-alert-def, detection alerts>>. | ||
| From the Alerts table, you can change an alert's status, and start | ||
| From the Alerts table, you can filter alerts, change an alert's status, and start | ||
| investigating and analyzing alerts in Timeline. | ||
|
|
||
| TIP: From Timeline, you can <<cases-ui-open, create cases>> to track issues and | ||
| share information with colleagues. | ||
|
|
||
| To view detection alerts created by a specific rule, you can: | ||
| [float] | ||
| [[detection-view-and-filter-alerts]] | ||
| === View and filter detection alerts | ||
| The Detections page offers a variety of ways for you to organize and triage detection alerts as you investigate suspicious events. You can: | ||
|
|
||
| * Filter for a specific rule in the KQL bar (for example, | ||
| `signal.rule.name :"SSH (Secure Shell) from the Internet"`). | ||
| * View detection alerts in the *Rule details* page (click | ||
| *Manage detection rules* -> rule name in the *All rules* table). | ||
|
|
||
| NOTE: KQL autocomplete for `.siem-signals-*` indices is available on the | ||
| *Detections* and *Rule details* pages, and in Timeline when either `All` or | ||
| `Detection alerts` is selected. | ||
|
|
||
| TIP: Use the icons in the upper left corner of the Alerts table to customize | ||
| displayed columns and row renderers, and view the table in full screen mode. | ||
| * Use the date and time filter to select a time range that you’re interested in exploring. By default, this filter is set to search through the last 24 hours. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
| * View detection alerts generated by a specific rule. To do this, click | ||
| *Manage detection rules* and then click on a rule name in the All rules table. A new page showing the detailed view of the rule displays and alert details are stored in the Alerts table beneath the Detection alert trend histogram. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
| * Use the *Stack by* dropdown in the Detection alert trend histogram to select specific parameters for which to visualize the individual counts. For example, if you choose to stack by `signal.rule.name`, the histogram will display the total counts by alert name. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
| * Augment the results shown in the Alerts table to include alerts from building blocks or only show alerts from indicator match rules. By default, building block alerts are excluded from the Alerts table. Opting to include them expands the results and displays building block alerts alongside regular detection alerts. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @rylnd @shimonmodi this is an interesting one. So we are filtering the alerts on signal.rule.threat_mapping - which I believe exists in all indicator match rules. Are we anticipating a future scenario in which threat match rules is a sub-category of indicator match rules, where
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
|
|
||
| NOTE: When updating alert results to also include building block alerts, the Security app searches the `.siem-signals-<Kibana space>` index for the `signal.rule.building_block_type` field. When looking for alerts created from indicator match rules, the app searches the same index for the `signal.rule.threat_mapping` field. | ||
|
|
||
| [role="screenshot"] | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So, IMO, we don't need this many arrows. I think we should just draw a box around the additional filter options and maybe the stack by drop-down. WDYT?
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Agree that we don't need as many arrows. Initially, I figured it'd be useful to include a screenshot that highlighted all the components listed. However, because of where the image is placed (after the last bullet), it might make more sense to only highlight the Additional Filters dropdown. That said, if we want to emphasize that the Trend histogram can be filtered too, it'd make sense to draw a box around the Stack by dropdown as well.
Member
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removing the arrows and only highlighting the Additional Filters dropdown to resolve this comment. |
||
| image::images/additional-filters.png[Shows multiple ways to filter information] | ||
|
|
||
| [float] | ||
| [[customize-the-alerts-table]] | ||
| === Customize the Alerts table | ||
| Use the icons in the upper left corner of the Alerts table to customize the columns you want displayed and to view the table in full screen mode. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
|
|
||
| [role="screenshot"] | ||
| image::images/alert-table-columns-and-size.gif[width=100%][height=100%][Demo that shows how to select the customize display icon and full screen icon] | ||
|
|
||
| Click the *Customize Event Renderers* icon to enable event renderers within the Alerts table. When enabled, event renderers show relevant details that provide more context to the event. For example, if you enable the *Flow* Event Renderer, the Alerts table shows relevant details describing the flow of the data between a source and destination. These details could include hosts, ports, protocol, direction, duration, amount transferred, process, and geographic location. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
|
|
||
| [role="screenshot"] | ||
| image::images/customize-event-renderer.png[Shows the Event Renderer icon, 200] | ||
|
|
||
| All event renderers are disabled by default. To switch between event views in the Alerts table, you can enable individual event renderers or click *Enable all*. Closing *Customize Event Renderers* page saves your configurations. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
|
|
||
| [role="screenshot"] | ||
| image::images/customize-event-renderer-page.png[Shows the Event Renderer page] | ||
|
|
||
| [float] | ||
| [[view-alert-details]] | ||
| === View alert details | ||
| To further inspect an alert, click the *View details* icon from the Alerts table. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
|
|
||
| [role="screenshot"] | ||
| image::images/view-alert-details.png[Shows the Event Renderer icon, 200] | ||
|
|
||
| The Alert details flyout appears and offers several options for viewing alert details: | ||
|
|
||
| * *Summary*: Offers an aggregated view of alert details. Alerts that have been enriched with `threat.indicator` data also display the *threat summary* section, which is an additional section located beneath the alert summary. In the *threat summary* section, you can view mapped data for the following `threat.indicator` subfields: | ||
| ** `matched.field` | ||
| ** `matched.type` | ||
| ** `source (threat.indicator.provider)` | ||
| ** `first_seen` | ||
| ** `last_seen` | ||
|
|
||
| NOTE: If an alert has more than one threat, `threat.indicator` data is still aggregated under the *threat summary* section, but parsed out in the *Threat Intel* tab. | ||
|
|
||
| * *Threat Intel*: Shows the number of matched intelligence sources and displays threats individually. Threats are organized by timestamp (the most recent threat alert is shown at the top and the oldest is at the bottom) and the available `threat.indicator` and `source.event` data is portrayed for each threat. If the alert has not been enriched with threat data the *Threat Intel* tab displays the message `No Threat Intel Enrichment Found` and provides a link to Threat Intel module documentation. | ||
|
nastasha-solomon marked this conversation as resolved.
Outdated
|
||
| * *Table*: Shows the alert details in table format. Alert details are organized into field value pairs. | ||
| * *JSON View*: Shows the alert details in JSON format. | ||
|
|
||
| [float] | ||
| [[detection-alert-status]] | ||
|
|
@@ -100,4 +150,4 @@ For information about exceptions and how to use them, see | |
| === Visually analyze process relationships | ||
|
|
||
| For process events received from the Elastic Endpoint agent, you can open a | ||
| visual mapping of the relationships and hierarchy connecting related processes. For more information see, <<visual-event-analyzer>>. | ||
| visual mapping of the relationships and hierarchy connecting related processes. For more information see, <<visual-event-analyzer>>. | ||
Uh oh!
There was an error while loading. Please reload this page.