Skip to content

Commit 3021ebb

Browse files
narcher7jmikell821
andauthored
Issue #408: Event analyzer updates (#466)
* Issue 408: Event analyzer updates * Add Butter's feedback. * Fix Butnner's KQL query. * Fix typo * Update docs/detections/visual-event-analyzer.asciidoc Co-authored-by: Janeen Mikell-Straughn <[email protected]> * Update docs/detections/visual-event-analyzer.asciidoc Co-authored-by: Janeen Mikell-Straughn <[email protected]> * Update docs/detections/visual-event-analyzer.asciidoc Co-authored-by: Janeen Mikell-Straughn <[email protected]> * Address remaining feedback * Make field mappings picture even smaller * Update docs/detections/visual-event-analyzer.asciidoc Co-authored-by: Janeen Mikell-Straughn <[email protected]> * Update docs/detections/visual-event-analyzer.asciidoc Co-authored-by: Janeen Mikell-Straughn <[email protected]> * Fix process details section * Last pieces of feedback. Co-authored-by: Janeen Mikell-Straughn <[email protected]>
1 parent fe30d93 commit 3021ebb

File tree

5 files changed

+40
-16
lines changed

5 files changed

+40
-16
lines changed
-461 KB
Loading
Loading
173 KB
Loading
193 KB
Loading

docs/detections/visual-event-analyzer.asciidoc

+40-16
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,18 @@ Elastic Security allows any event detected by Elastic Endpoint to be analyzed us
88
[[find-events-analyze]]
99
=== Find events to analyze
1010

11-
You can only visualize events triggered by hosts configured with the Elastic Endpoint Security Integration. In KQL, this translates to any event with the `agent.type` set to `endpoint`.
11+
You can only visualize events triggered by hosts configured with the Elastic Endpoint Security Integration or any sysmon data from `winlogbeat`.
12+
13+
In KQL, this translates to any event with the `agent.type` set to either:
14+
15+
* `endpoint`.
16+
* `winlogbeat` with `event.module` set to `sysmon`.
1217

1318
To access events that can be visually analyzed:
1419

1520
1. In Elastic Security, select **Hosts** > **Events**. A list of all your host's events appears in the bottom panel of the host's view.
1621

17-
2. Create a KQL query that filters all `endpoint` detected events by entering `agent.type: endpoint and process.entity_id : *` into the KQL search bar, and then select **Update**.
22+
2. Create a KQL query that filters all `endpoint` detected events by entering `agent.type:"endpoint" and process.entity_id : *` or `agent.type:"winlogbeat" and event.module: "sysmon" and process.entity_id : *` into the KQL search bar, and then select **Update**.
1823
+
1924
[role="screenshot"]
2025
image::images/kql-agent-type.png[]
@@ -25,22 +30,40 @@ A list of all `endpoint` related events appears.
2530
+
2631
[role="screenshot"]
2732
image::images/analyze-event.png[]
33+
+
34+
Any events that cannot be analyzed will contain the warning "This event cannot be analyzed since it has incompatible field mappings."
35+
[role="screenshot"]
36+
image::images/incompatible-field-mappings.png[]
2837

2938
The visual **Analyzer** view appears.
3039

3140
[role="screenshot"]
3241
image::images/analyze-event-view.png[]
3342

34-
You can also analyze events from <<timelines-ui,Timelines>>
43+
TIP: You can also analyze events from <<timelines-ui,Timelines>>.
3544

3645

3746
[discrete]
3847
[[visual-analyzer-ui]]
3948
=== Visual event analyzer UI
4049

41-
Inside the visual analyzer, each cube represents a process (i.e. an executable file or network event). Click and drag in timeline view to see all process relationships.
50+
Inside the visual analyzer, each cube represents a process (e.g. an executable file or network event). Click and drag in timeline view to see all process relationships.
51+
52+
To help understand what fields were used to create the process, select the **Process Tree** to view the schema that created the graphical view. The fields included are:
53+
54+
* `SOURCE`: Can be either `endpoint` or `winlogbeat`.
55+
* `ID`: Event field that uniquely identifies a node.
56+
* `EDGE`: Event field which indicates the relationship between two nodes.
57+
58+
[role="screenshot"]
59+
image::images/process-schema.png[]
60+
61+
View the **Legend** to understand the state of each process node.
62+
63+
[role="screenshot"]
64+
image::images/node-legend.png[]
4265

43-
To make the analyzer full screen, select the **Full Screen** icon above the left-panel.
66+
To expand the analyzer to a full screen, select the **Full Screen** icon above the left panel.
4467

4568
[role="screenshot"]
4669
image::images/full-screen-analyzer.png[]
@@ -65,29 +88,30 @@ image::images/graphical-view.png[]
6588
[[process-and-event-details]]
6689
=== Process and event details
6790

68-
To see more details about each related process, select the process either in the left panel or the graphical view. The information on the process appears in the left panel, which typically includes but isn't limited to:
91+
To see more details about each related process, select the process either in the left panel or the graphical view. The left panel displays process details such as:
6992

70-
- The number of events associated with the process.
71-
- The timestamp when the process was executed.
72-
- The file path of the process within the host.
73-
- The `process-pid`.
74-
- The user name and domain that ran the process.
75-
- Any other relevant process information.
93+
* The number of events associated with the process.
94+
* The timestamp when the process was executed.
95+
* The file path of the process within the host.
96+
* The `process-pid`.
97+
* The user name and domain that ran the process.
98+
* Any other relevant process information.
7699

77100
[role="screenshot"]
78101
image::images/process-details.png[]
79102

80-
See event details by selecting the **# events** URL at the top of the process details view or choosing one of the event pills in the graphical view.
103+
When you first select a process, it appears in a loading state. If loading data for a given process fails, click **Reload `{process-name}`** beneath the process to reload the data.
81104

105+
See event details by selecting that event's URL at the top of the process details view or choosing one of the event pills in the graphical view.
82106

83-
Events are categorized based on their `event.category`.
107+
Events are categorized based on their `event.category`.
84108

85109
[role="screenshot"]
86110
image::event-type.png[]
87111

88-
When selecting an `event.type`, a list of all those types of events appears in the left panel. If you want further details on the event, choose the event from the list. Event details appear in the left panel.
112+
When you select an `event.category`, pill, all the events within that category are listed in the left panel. To view more details about a specific event, select it from the list.
89113

90114
[role="screenshot"]
91115
image::event-details.png[]
92116

93-
In Elastic Security 7.10 and later, there is no limit to the number of events that can be associated with a process. However, in 7.9, each process is limited to only 100 events.
117+
NOTE: In {stack} version >= 7.10.0, there is no limit to the number of events that can be associated with a process. However, in {stack} minor versions < = 7.9.0, each process is limited to only 100 events.

0 commit comments

Comments
 (0)