Skip to content

Commit f400faa

Browse files
[8.19][Security]: Edit highlighted fields in alert flyout (#6924)
* first draft * Removes images * Removes files
1 parent 16be7ba commit f400faa

21 files changed

+1
-65
lines changed

docs/detections/alerts-view-details.asciidoc

Lines changed: 1 addition & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88

99
To learn more about an alert, click the *View details* button from the Alerts table. This opens the alert details flyout, which helps you understand and manage the alert.
1010

11-
[role="screenshot"]
12-
image::images/open-alert-details-flyout.gif[Expandable flyout, 90%]
13-
1411
Use the alert details flyout to begin an investigation, open a case, or plan a response. Click **Take action** at the bottom of the flyout to find more options for interacting with the alert.
1512

1613
[discrete]
@@ -25,9 +22,6 @@ The alert details flyout has a right panel, a preview panel, and a left panel. E
2522

2623
The right panel provides an overview of the alert. Expand any of the collapsed sections to learn more about the alert. You can also hover over fields on the *Overview* and *Table* tabs to display available <<inline-actions, inline actions>>.
2724

28-
[role="screenshot"]
29-
image::images/alert-details-flyout-right-panel.png[Right panel of the alert details flyout, 65%]
30-
3125
From the right panel, you can also:
3226

3327
* Click **Expand details** to open the <<left-panel,left panel>>, which shows more information about sections in the right panel.
@@ -57,36 +51,21 @@ IMPORTANT: If you've enabled grouping on the Alerts page, the alert details flyo
5751

5852
Some areas in the flyout provide previews when you click on them. For example, clicking **Show rule summary** in the rule description displays a preview of the rule's details. To close the preview, click **Back** or **x**.
5953

60-
[role="screenshot"]
61-
image::images/alert-details-flyout-preview-panel.gif[Preview panel of the alert details flyout, 65%]
62-
6354
[discrete]
6455
[[left-panel]]
6556
=== Left panel
6657

6758
The left panel provides an expanded view of what's shown in the right panel. To open the left panel, do one of the following:
6859

6960
* Click **Expand details** at the top of the right panel.
70-
+
71-
72-
[role="screenshot"]
73-
image::images/expand-details-button.png[Expand details button at the top of the alert details flyout, 65%]
74-
7561
* Click one of the section titles on the **Overview** tab within the right panel.
76-
+
77-
78-
[role="screenshot"]
79-
image::images/alert-details-flyout-left-panel.png[Left panel of the alert details flyout, 65%]
8062

8163
[discrete]
8264
[[about-section]]
8365
== About
8466

8567
The About section is located on the **Overview** tab in the right panel. It provides a brief description of the rule that's related to the alert and an explanation of what generated the alert.
8668

87-
[role="screenshot"]
88-
image::images/about-section-rp.png[About section of the Overview tab, 65%]
89-
9069
The About section has the following information:
9170

9271
* **Rule description**: Describes the rule's purpose or detection goals. Click **Show rule summary** to display a preview of the rule's details. From the preview, click **Show rule details** to view the rule's details page.
@@ -103,26 +82,20 @@ NOTE: The event renderer only displays if an event renderer exists for the alert
10382

10483
The Investigation section is located on the **Overview** tab in the right panel. It offers a couple of ways to begin investigating the alert.
10584

106-
[role="screenshot"]
107-
image::images/investigation-section-rp.png[Investigation section of the Overview tab, 65%]
108-
10985
The Investigation section provides the following information:
11086

11187
* **Investigation guide**: The **Show investigation guide** button displays if the rule associated with the alert has an investigation guide. Click the button to open the expanded Investigation view in the left panel.
11288
+
11389
TIP: Add an <<add-ig-actions-rule,investigation guide>> to a rule when creating a new custom rule or modifying an existing custom rule's settings.
11490

115-
* **Highlighted fields**: Shows relevant fields for the alert and any <<rule-ui-advanced-params,custom highlighted fields>> you added to the rule. Custom highlighted fields with values are added to this section. Those without values aren't added.
91+
* **Highlighted fields**: Shows relevant fields for the alert and any <<rule-ui-advanced-params,custom highlighted fields>> you added to the rule. Custom highlighted fields with values are added to this section. Those without values aren't added. To quickly add or remove custom highlighted fields from the rule, click the **Add field** in the Highlighted fields table.
11692

11793
[discrete]
11894
[[visualizations-section]]
11995
== Visualizations
12096

12197
The Visualizations section is located on the **Overview** tab in the right panel. It offers a glimpse of the processes that led up to the alert and occurred after it.
12298

123-
[role="screenshot"]
124-
image::images/visualizations-section-rp.png[Visualizations section of the Overview tab, 65%]
125-
12699
Click **Visualizations** to display the following previews:
127100

128101
* **Session viewer preview**: Shows a preview of <<session-view,Session View>> data. Click **Session viewer preview** to open the **Session View** tab in Timeline.
@@ -135,50 +108,32 @@ Click **Visualizations** to display the following previews:
135108

136109
The **Visualize** tab allows you to maintain the context of the Alerts table, while providing a more detailed view of alerts that you're investigating in the event analyzer or Session View. To open the tab, click **Session viewer preview** or **Analyzer preview** from the right panel.
137110

138-
[role="screenshot"]
139-
image::images/visualize-tab-lp.png[Expanded view of visualization details, 80%]
140-
141111
As you examine the alert's related processes, you can also preview the alerts and events which are associated with those processes. Then, if you want to learn more about a particular alert or event, you can click **Show full alert details** to open the full details flyout.
142112

143-
[role="screenshot"]
144-
image::images/visualize-tab-lp-alert-details.gif[Examine alert details from event analyzer, 80%]
145-
146113
[discrete]
147114
[[insights-section]]
148115
== Insights
149116

150117
The Insights section is located on the **Overview** tab in the right panel. It offers different perspectives from which you can assess the alert. Click **Insights** to display overviews for <<entities-overview,related entities>>, <<threat-intelligence-overview,threat intelligence>>, <<correlations-overview,correlated data>>, and <<prevalence-overview,host and user prevalence>>.
151118

152-
[role="screenshot"]
153-
image::images/insights-section-rp.png[Insights section of the Overview tab, 65%]
154-
155119
[discrete]
156120
[[entities-overview]]
157121
=== Entities
158122

159123
The Entities overview provides high-level details about the user and host that are related to the alert. Host and user risk classifications are also available with a https://www.elastic.co/pricing[Platinum subscription] or higher.
160124

161-
[role="screenshot"]
162-
image::images/entities-overview.png[Overview of the entity details section in the right panel, 60%]
163-
164125
[discrete]
165126
[[expanded-entities-view]]
166127
==== Expanded entities view
167128

168129
From the right panel, click **Entities** to open a detailed view of the host and user associated with the alert. The expanded view also includes risk scores and classifications (if you have a Platinum subscription or higher) and activity on related hosts and users.
169130

170-
[role="screenshot"]
171-
image::images/expanded-entities-view.png[Expanded view of entity details, 70%]
172-
173131
[discrete]
174132
[[threat-intelligence-overview]]
175133
=== Threat intelligence
176134

177135
The Threat intelligence overview shows matched indicators, which provide threat intelligence relevant to the alert.
178136

179-
[role="screenshot"]
180-
image::images/threat-intelligence-overview.png[Overview of threat intelligence on the alert, 70%]
181-
182137
The Threat intelligence overview provides the following information:
183138

184139
* **Threat match detected**: Only available when examining an alert generated from an <<create-indicator-rule,indicator match>> rule. Shows the number of matched indicators that are present in the alert document. Shows zero if there are no matched indicators or you're examining an alert generated by another type of rule.
@@ -193,9 +148,6 @@ From the right panel, click **Threat intelligence** to open the expanded Threat
193148

194149
NOTE: The expanded threat intelligence view queries indices specified in the `securitySolution:defaultThreatIndex` advanced setting. Refer to <<update-threat-intel-indices, Update default Elastic Security threat intelligence indices>> to learn more about threat intelligence indices.
195150

196-
[role="screenshot"]
197-
image::images/expanded-threat-intelligence-view.png[Expanded view of threat intelligence on the alert, 80%]
198-
199151
The expanded Threat intelligence view shows individual indicators within the alert document. You can expand and collapse indicator details by clicking the arrow button at the end of the indicator label. Each indicator is labeled with values from the `matched.field` and `matched.atomic` fields and displays the threat intelligence provider.
200152

201153
Matched threats are organized into two sections, described below. Within each section, matched threats are shown in reverse chronological order, with the most recent at the top. All mapped fields are displayed for each matched threat.
@@ -229,9 +181,6 @@ When searching for threat intelligence, {elastic-sec} queries the alert document
229181

230182
The Correlations overview shows how an alert is related to other alerts and offers ways to investigate related alerts. Use this information to quickly find patterns between alerts and then take action.
231183

232-
[role="screenshot"]
233-
image::images/correlations-overview.png[Overview of available correlation data, 60%]
234-
235184
The Correlations overview provides the following information:
236185

237186
* **Suppressed alerts**: Indicates that the alert was created with alert suppression, and shows how many duplicate alerts were suppressed. This information only appears if alert suppression is enabled for the rule.
@@ -248,9 +197,6 @@ NOTE: To access data about alerts related by process ancestry, you must have a h
248197

249198
From the right panel, click **Correlations** to open the expanded Correlations view within the left panel.
250199

251-
[role="screenshot"]
252-
image::images/expanded-correlations-view.png[Expanded view of correlation data, 75%]
253-
254200
In the expanded view, corelation data is organized into several tables:
255201

256202
* **Suppressed alerts**: Shows how many duplicate alerts were suppressed. This information only appears if alert suppression is enabled for the rule.
@@ -276,9 +222,6 @@ From the right panel, click **Prevalence** to open the expanded Prevalence view
276222

277223
TIP: Update the date time picker for the table to show data from a different time range.
278224

279-
[role="screenshot"]
280-
image::images/expanded-prevalence-view.png[Expanded view of prevalence data]
281-
282225
The expanded Prevalence view provides the following details:
283226

284227
* **Field**: Shows <<investigation-section,highlighted fields>> for the alert and any custom highlighted fields that were added to the alert's rule.
@@ -301,17 +244,10 @@ The following features require a https://www.elastic.co/pricing[Platinum subscri
301244

302245
The **Response** section is located on the **Overview** tab in the right panel. It shows <<rules-ui-create,response actions>> that were added to the rule associated with the alert. Click **Response** to display the response action's results in the left panel.
303246

304-
[role="screenshot"]
305-
image::images/response-action-rp.png[Response section of the Overview tab, 50%]
306-
307-
308247
[discrete]
309248
[[expanded-notes-view]]
310249
== Notes
311250

312251
The **Notes** tab (located in the left panel) shows all notes attached to the alert, in addition to the user who created them and when they were created. When you add a new note, the alert's summary also updates and shows how many notes are attached to the alert.
313252

314253
TIP: Go to the **Notes** <<manage-notes,page>> to find notes that were added to other alerts.
315-
316-
[role="screenshot"]
317-
image::images/notes-tab-lp.png[Notes tab in the left panel, 70%]
-135 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
-35.5 KB
Binary file not shown.
-35.4 KB
Binary file not shown.
-67.4 KB
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 commit comments

Comments
 (0)