-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4d1c727
commit a2d498e
Showing
8 changed files
with
157 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
53 changes: 53 additions & 0 deletions
53
docs/serverless/advanced-entity-analytics/entity-store.asciidoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
[[entity-store]] | ||
= Entity store | ||
|
||
preview::[] | ||
|
||
.Requirements | ||
[sidebar] | ||
-- | ||
To use the entity store, you must have the appropriate privileges. For more information, refer to <<security-ers-requirements, Entity risk scoring requirements>>. | ||
-- | ||
|
||
The entity store allows you to query, reconcile, maintain, and persist entity metadata such as: | ||
|
||
* Ingested log data | ||
* Data from integrated identity providers (such as Active Directory, EntraID, and Okta) | ||
* Data from internal and external alerts | ||
* External asset repository data | ||
* Asset criticality data | ||
* Entity risk score data | ||
|
||
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>>. | ||
|
||
When the entity store is enabled, the following resources are generated for each entity type (hosts and users): | ||
|
||
* {es} resources, such as transforms, ingest pipelines, and enrich policies. | ||
* Data and fields for each entity. | ||
* 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. | ||
|
||
[discrete] | ||
[[enable-entity-store]] | ||
== Enable entity store | ||
|
||
To enable the entity store: | ||
|
||
. Find **Entity Store** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. | ||
. On the **Entity Store** page, turn the toggle on. | ||
|
||
Once you enable the entity store, the Entity Analytics dashboard displays the <<entity-entities, **Entities**>> section. | ||
|
||
[discrete] | ||
[[clear-entity-store]] | ||
== Clear entity store data | ||
|
||
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. | ||
|
||
Clearing entity store data does not delete your source data, assigned entity risk scores, or asset criticality assignments. | ||
|
||
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. | ||
|
||
To clear entity data: | ||
|
||
. Find **Entity Store** in the navigation menu or by using the {kibana-ref}/introduction.html#kibana-navigation-search[global search field]. | ||
. On the **Entity Store** page, select **Clear**. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
+71.2 KB
(130%)
docs/serverless/images/detection-entity-dashboard/-dashboards-entity-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+95.4 KB
docs/serverless/images/detection-entity-dashboard/-entities-section.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters