Skip to content

Commit bfa632b

Browse files
New entity store features (#6634) (#6657)
* New entity store features * Moves flyout docs to new page * fix formatting (cherry picked from commit 2dcbce3) Co-authored-by: natasha-moore-elastic <137783811+natasha-moore-elastic@users.noreply.github.com>
1 parent 2b59967 commit bfa632b

22 files changed

+153
-201
lines changed

docs/AI-for-security/attack-discovery.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ image::images/attck-disc-example-disc.png[Attack Discovery detail view]
8888

8989
There are several ways you can incorporate discoveries into your {elastic-sec} workflows:
9090

91-
* Click an entity's name to open the user or host details flyout and view more details that may be relevant to your investigation.
91+
* Click an entity's name to open the entity details flyout and view more details that may be relevant to your investigation.
9292
* Hover over an entity's name to either add the entity to Timeline (image:images/icon-add-to-timeline.png[Add to timeline icon,17,18]) or copy its field name and value to the clipboard (image:images/icon-copy.png[Copy to clipboard icon,17,18]).
9393
* Click **Take action**, then select **Add to new case** or **Add to existing case** to add a discovery to a <<cases-overview, case>>. This makes it easy to share the information with your team and other stakeholders.
9494
* Click **Investigate in timeline** to explore the discovery in <<timelines-ui, Timeline>>.

docs/advanced-entity-analytics/advanced-entity-analytics-overview.asciidoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[advanced-entity-analytics-overview]]
22
= Advanced Entity Analytics
33

4-
Advanced Entity Analytics generates a set of threat detection and risk analytics that allows you to expedite alert triage and hunt for new threats from within an entity's environment. This feature combines the power of the SIEM detection engine and Elastic's {ml} capabilities to identify unusual user behaviors and generate comprehensive risk analytics for hosts and users.
4+
Advanced Entity Analytics generates a set of threat detection and risk analytics that allows you to expedite alert triage and hunt for new threats from within an entity's environment. This feature combines the power of the SIEM detection engine and Elastic's {ml} capabilities to identify unusual user behaviors and generate comprehensive risk analytics for hosts, users, and services.
55

66
Advanced Entity Analytics provides two key capabilities:
77

@@ -11,6 +11,7 @@ Advanced Entity Analytics provides two key capabilities:
1111
include::entity-risk-scoring.asciidoc[leveloffset=+1]
1212
include::ers-req.asciidoc[leveloffset=+2]
1313
include::turn-on-risk-engine.asciidoc[leveloffset=+2]
14+
include::view-entity-details.asciidoc[leveloffset=+2]
1415
include::asset-criticality.asciidoc[leveloffset=+2]
1516
include::entity-store.asciidoc[leveloffset=+2]
1617
include::analyze-risk-score-data.asciidoc[leveloffset=+2]

docs/advanced-entity-analytics/analyze-risk-score-data.asciidoc

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The {security-app} provides several options to monitor the change in the risk po
88
* <<alert-details-flyout, Alert details flyout>>
99
* <<hosts-users-pages, Hosts and Users pages>>
1010
* <<host-user-details-pages, Host and user details pages>>
11-
* <<host-and-user-details-flyouts, Host and user details flyouts>>
11+
* <<entity-details-flyouts, Entity details flyouts>>
1212

1313
TIP: We recommend that you prioritize <<alert-triaging, alert triaging>> to identify anomalies or abnormal behavior patterns.
1414

@@ -18,10 +18,7 @@ TIP: We recommend that you prioritize <<alert-triaging, alert triaging>> to iden
1818

1919
From the Entity Analytics dashboard, you can access entity key performance indicators (KPIs), risk scores, and levels. You can also click the number link in the **Alerts** column to investigate and analyze the alerts on the Alerts page.
2020

21-
If you have enabled the <<entity-store, entity store>>, the dashboard also displays the <<entity-entities, **Entities** section>>, where you can view all hosts and users along with their risk and asset criticality data.
22-
23-
[role="screenshot"]
24-
image::dashboards/images/entity-dashboard.png[Entity Analytics dashboard]
21+
If you have enabled the <<entity-store, entity store>>, the dashboard also displays the <<entity-entities, **Entities** section>>, where you can view all hosts, users, and services along with their risk and asset criticality data.
2522

2623
[discrete]
2724
[[alert-triaging]]
@@ -34,15 +31,15 @@ You can prioritize alert triaging to analyze alerts associated with risky or bus
3431

3532
Use the Alerts table to investigate and analyze:
3633

37-
* Host and user risk levels
38-
* Host and user risk scores
34+
* Host, user, and service risk levels
35+
* Host, user, and service risk scores
3936
* Asset criticality
4037

4138
To display entity risk score and asset criticality data in the Alerts table, select **Fields**, and add the following:
4239

43-
* `user.risk.calculated_level` or `host.risk.calculated_level`
44-
* `user.risk.calculated_score_norm` or `host.risk.calculated_score_norm`
45-
* `user.asset.criticality` or `host.asset.criticality`
40+
* `user.risk.calculated_level`, `host.risk.calculated_level`, or `service.risk.calculated_level`
41+
* `user.risk.calculated_score_norm`, `host.risk.calculated_score_norm`, or `service.risk.calculated_score_norm`
42+
* `user.asset.criticality`, `host.asset.criticality`, or `service.asset.criticality`
4643

4744
Learn more about <<customize-the-alerts-table, customizing the Alerts table>>.
4845

@@ -59,24 +56,24 @@ NOTE: If you change the entity's criticality level after an alert is generated,
5956

6057
* Use the drop-down filter controls to filter alerts by entity risk level or asset criticality level. To do this, <<drop-down-filter-controls, edit the default controls>> to filter by:
6158

62-
** `user.risk.calculated_level` or `host.risk.calculated_level` for entity risk level:
59+
** `user.risk.calculated_level`, `host.risk.calculated_level`, or `service.risk.calculated_level` for entity risk level:
6360
+
6461
[role="screenshot"]
6562
image::images/filter-by-host-risk-level.png[Alerts filtered by high host risk level]
6663

67-
** `user.asset.criticality` or `host.asset.criticality` for asset criticality level:
64+
** `user.asset.criticality`, `host.asset.criticality`, or `service.asset.criticality` for asset criticality level:
6865
+
6966
[role="screenshot"]
7067
image::images/filter-by-asset-criticality.png[Filter alerts by asset criticality level]
7168

7269
* To group alerts by entity risk level or asset criticality level, select **Group alerts by**, then select **Custom field** and search for:
7370

74-
** `host.risk.calculated_level` or `user.risk.calculated_level` for entity risk level:
71+
** `host.risk.calculated_level`, `user.risk.calculated_level`, or `service.risk.calculated_level` for entity risk level:
7572
+
7673
[role="screenshot"]
7774
image::images/group-by-host-risk-level.png[Alerts grouped by host risk levels]
7875

79-
** `host.asset.criticality` or `user.asset.criticality` for asset criticality level:
76+
** `host.asset.criticality`, `user.asset.criticality`, or `service.asset.criticality` for asset criticality level:
8077
+
8178
[role="screenshot"]
8279
image::images/group-by-asset-criticality.png[Alerts grouped by entity asset criticality levels]
@@ -87,7 +84,7 @@ image::images/group-by-asset-criticality.png[Alerts grouped by entity asset crit
8784
... Expand a risk level group (for example, **High**) or an asset criticality group (for example, **high_impact**).
8885
... Select **Sort fields** → **Pick fields to sort by**.
8986
... Select fields in the following order:
90-
.... `host.risk.calculated_score_norm` or `user.risk.calculated_score_norm`: **High-Low**
87+
.... `host.risk.calculated_score_norm`, `user.risk.calculated_score_norm` or `service.risk.calculated_score_norm`: **High-Low**
9188
.... `Risk score`: **High-Low**
9289
.... `@timestamp`: **New-Old**
9390
--
@@ -137,10 +134,10 @@ image::images/host-details-overview.png[Host risk data in the Overview section o
137134
image::images/host-details-hr-tab.png[Host risk data on the Host risk tab of the host details page]
138135

139136
[discrete]
140-
[[host-and-user-details-flyouts]]
141-
=== Host and user details flyouts
137+
[[entity-details-flyouts]]
138+
=== Entity details flyouts
142139

143-
In the host details and user details flyouts, you can access the risk score data in the risk summary section:
140+
In the entity details flyouts, you can access the risk score data in the risk summary section:
144141

145142
[role="screenshot"]
146143
image::images/risk-summary.png[Host risk data in the Host risk summary section]

docs/advanced-entity-analytics/asset-criticality.asciidoc

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,12 +34,12 @@ You can view, assign, change, or unassign asset criticality from the following p
3434
[role="screenshot"]
3535
image::images/assign-asset-criticality-host-details.png[Assign asset criticality from the host details page]
3636

37-
* The <<host-details-flyout, host details flyout>> and <<user-details-flyout, user details flyout>>:
37+
* The <<entity-details-flyout, entity details flyout>>:
3838
+
3939
[role="screenshot"]
4040
image::images/assign-asset-criticality-host-flyout.png[Assign asset criticality from the host details flyout]
4141

42-
* The host details flyout and user details flyout in <<timelines-ui, Timeline>>:
42+
* The entity details flyout in <<timelines-ui, Timeline>>:
4343
+
4444
[role="screenshot"]
4545
image::images/assign-asset-criticality-timeline.png[Assign asset criticality from the host details flyout in Timeline]
@@ -57,8 +57,8 @@ You can bulk assign asset criticality to multiple entities by importing a CSV, T
5757

5858
The file must contain three columns, with each entity record listed on a separate row:
5959

60-
. The first column should indicate whether the entity is a `host` or a `user`.
61-
. The second column should specify the entity's `host.name` or `user.name`.
60+
. The first column should indicate whether the entity is a `host`, `user`, or `service`.
61+
. The second column should specify the entity's `host.name`, `user.name`, or `service.name`.
6262
. The third column should specify one of the following asset criticality levels:
6363
** `extreme_impact`
6464
** `high_impact`
@@ -74,6 +74,7 @@ File structure example:
7474
user,user-001,low_impact
7575
user,user-002,medium_impact
7676
host,host-001,extreme_impact
77+
service,service-001,extreme_impact
7778
--------------------------------------------------
7879

7980
To import a file:
@@ -112,7 +113,7 @@ The risk scoring engine dynamically factors in an entity's asset criticality, al
112113

113114
To view the impact of asset criticality on an entity's risk score, follow these steps:
114115

115-
. Open the <<host-details-flyout, host details flyout>> or <<user-details-flyout, user details flyout>>. The risk summary section shows asset criticality's contribution to the overall risk score.
116+
. Open the <<entity-details-flyout, entity details flyout>>. The risk summary section shows asset criticality's contribution to the overall risk score.
116117
. Click **View risk contributions** to open the flyout's left panel.
117118
. In the **Risk contributions** section, verify the entity's criticality level from the time the alert was generated.
118119

docs/advanced-entity-analytics/entity-risk-scoring.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ If you’ve installed the original user and host risk score modules, refer to {s
88

99
Entity risk scoring is an advanced {elastic-sec} analytics feature that helps security analysts detect changes in an entity's risk posture, hunt for new threats, and prioritize incident response.
1010

11-
Entity risk scoring allows you to monitor risk score changes of hosts and users in your environment. When generating advanced scoring analytics, the risk scoring engine utilizes threats from its end-to-end XDR use cases, such as SIEM, cloud, and endpoint. It leverages the Elastic SIEM detection engine to generate host and user risk scores from the last 30 days.
11+
Entity risk scoring allows you to monitor risk score changes of hosts, users, and services in your environment. When generating advanced scoring analytics, the risk scoring engine utilizes threats from its end-to-end XDR use cases, such as SIEM, cloud, and endpoint. It leverages the Elastic SIEM detection engine to generate host, user, and service risk scores from the last 30 days.
1212

1313
It also generates risk scores on a recurring interval, and allows for easy onboarding and management. The engine is built to factor in risks from all {elastic-sec} use cases, and allows you to customize and control how and when risk is calculated.
1414

@@ -38,7 +38,7 @@ NOTE: Entities without any alerts, or with only `Closed` alerts, are not assigne
3838
+
3939
NOTE: When <<turn-on-risk-engine, turning on the risk engine>>, you can choose to also include `Closed` alerts in risk scoring calculations.
4040

41-
. The engine groups alerts by `host.name` or `user.name`, and aggregates the individual alert risk scores (`kibana.alert.risk_score`) such that alerts with higher risk scores contribute more than alerts with lower risk scores. The resulting aggregated risk score is assigned to the **Alerts** category in the entity's <<host-risk-summary, risk summary>>.
41+
. The engine groups alerts by `host.name`, `user.name`, or `service.name`, and aggregates the individual alert risk scores (`kibana.alert.risk_score`) such that alerts with higher risk scores contribute more than alerts with lower risk scores. The resulting aggregated risk score is assigned to the **Alerts** category in the entity's <<entity-risk-summary, risk summary>>.
4242

4343
. The engine then verifies the entity's <<asset-criticality, asset criticality level>>. If there is no asset criticality assigned, the entity risk score remains equal to the aggregated score from the **Alerts** category. If a criticality level is assigned, the engine updates the risk score based on the default risk weight for each criticality level. The asset criticality risk input is assigned to the **Asset Criticality** category in the entity's risk summary.
4444
+

docs/advanced-entity-analytics/entity-store.asciidoc

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ The entity store allows you to query, reconcile, maintain, and persist entity me
1818

1919
The entity store can hold any entity type observed by {elastic-sec}. It allows you to view and query select entities represented in your indices without needing to perform real-time searches of observable data. The entity store extracts entities from all indices in the {elastic-sec} <<default-data-view-security, default data view>>.
2020

21-
When the entity store is enabled, the following resources are generated for each entity type (hosts and users):
21+
When the entity store is enabled, the following resources are generated for each entity type (hosts, users, and services):
2222

2323
* {es} resources, such as transforms, ingest pipelines, and enrich policies.
2424
* Data and fields for each entity.
25-
* The `.entities.v1.latest.security_user_<space-id>` and `.entities.v1.latest.security_host_<space-id>` indices, which contain field mappings for hosts and users respectively. You can query these indices to see a list of fields that are mapped in the entity store.
25+
* The `.entities.v1.latest.security_user_<space-id>`, `.entities.v1.latest.security_host_<space-id>`, and `.entities.v1.latest.security_services_<space-id>` indices, which contain field mappings for hosts, users, and services respectively. You can query these indices to see a list of fields that are mapped in the entity store.
2626

2727
[discrete]
2828
[[enable-entity-store]]
@@ -39,13 +39,19 @@ Once you enable the entity store, the Entity Analytics dashboard displays the <<
3939
[[clear-entity-store]]
4040
== Clear entity store data
4141

42-
Once the entity store is enabled, you may want to clear the stored data and start fresh. For example, if you normalized the `user.name` or `host.name` fields, clearing the entity store data would allow you to repopulate the entity store with the updated, normalized values. This action removes all previously extracted entity information, enabling new data extraction and analysis.
42+
Once the entity store is enabled, you may want to clear the stored data and start fresh. For example, if you normalized the `user.name`, `host.name`, or `service.name` fields, clearing the entity store data would allow you to repopulate the entity store with the updated, normalized values. This action removes all previously extracted entity information, enabling new data extraction and analysis.
4343

4444
Clearing entity store data does not delete your source data, assigned entity risk scores, or asset criticality assignments.
4545

46-
CAUTION: Clearing entity store data permanently deletes persisted user and host records, and data is no longer available for analysis. Proceed with caution, as this cannot be undone.
46+
CAUTION: Clearing entity store data permanently deletes persisted user, host, and service records, and data is no longer available for analysis. Proceed with caution, as this cannot be undone.
4747

4848
To clear entity data:
4949

5050
. Find **Entity Store** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
51-
. On the **Entity Store** page, select **Clear**.
51+
. On the **Entity Store** page, select **Clear**.
52+
53+
[discrete]
54+
[[verify-engine-status]]
55+
== Verify engine status
56+
57+
Once the entity store is enabled, the **Entity Store** page displays the **Engine Status** tab, where you can verify which engines are installed and their statuses. This tab shows a list of installed resources for each installed entity. Click the resource link to navigate to the resource page and view more information.

docs/advanced-entity-analytics/ers-req.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Follow these guidelines to ensure clusters have adequate memory to handle data v
4040
[discrete]
4141
=== Known limitations
4242

43-
The risk scoring engine uses an internal user role to score all hosts and users, and doesn't respect privileges applied to custom users or roles. After you turn on the risk scoring engine for a {kib} space, all alerts in the space will contribute to host and user risk scores.
43+
The risk scoring engine uses an internal user role to score all hosts, users, and services, and doesn't respect privileges applied to custom users or roles. After you turn on the risk scoring engine for a {kib} space, all alerts in the space will contribute to host, user, and service risk scores.
4444

4545
[discrete]
4646
== Asset criticality
Binary file not shown.

docs/advanced-entity-analytics/turn-on-risk-engine.asciidoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,12 @@ IMPORTANT: To use entity risk scoring, your role must have the appropriate privi
66
[discrete]
77
== Preview risky entities
88

9-
You can preview risky entities before installing the latest risk engine. The preview shows the riskiest hosts and users found in the 1000 sampled entities during the time frame selected in the date picker.
9+
You can preview risky entities before installing the latest risk engine. The preview shows the riskiest hosts, users, and services found in the 1000 sampled entities during the time frame selected in the date picker.
1010

1111
NOTE: The preview is limited to two risk scores per {kib} instance.
1212

1313
To preview risky entities, find **Entity Risk Score** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field].
1414

15-
[role="screenshot"]
16-
image::images/preview-risky-entities.png[Preview of risky entities]
17-
1815
[discrete]
1916
== Turn on the latest risk engine
2017

0 commit comments

Comments
 (0)