-
Couldn't load subscription status.
- Fork 205
[8.16] Adds entity store docs #6053
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 all commits
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 |
|---|---|---|
| @@ -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 <<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**. | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,18 +8,17 @@ The Entity Analytics dashboard provides a centralized view of emerging insider t | |
| [sidebar] | ||
| -- | ||
|
|
||
| * A https://www.elastic.co/pricing/[Platinum subscription] or higher is required. | ||
| * To display host and user risk scores, you must <<turn-on-risk-engine, turn on the risk scoring engine>>. | ||
| A https://www.elastic.co/pricing/[Platinum subscription] or higher is required. | ||
|
|
||
| -- | ||
|
|
||
| The dashboard includes the following sections: | ||
|
|
||
| * <<entity-kpis>> | ||
| * <<entity-host-risk-scores>> | ||
| * <<entity-user-risk-scores>> | ||
| * <<entity-anomalies>> | ||
|
|
||
| * <<entity-host-risk-scores>> | ||
| * <<entity-entities>> | ||
| * <<entity-anomalies>> | ||
|
|
||
| [role="screenshot"] | ||
| image::images/entity-dashboard.png[Entity dashboard] | ||
|
|
@@ -28,12 +27,43 @@ image::images/entity-dashboard.png[Entity dashboard] | |
| [float] | ||
| == Entity KPIs (key performance indicators) | ||
|
|
||
| Displays the total number of critical hosts, critical users, and anomalies. Select a link to jump to the Host risk table, User risk table, or Anomalies table. | ||
| Displays the total number of critical hosts, critical users, and anomalies. Select a link to jump to the **Hosts** page, **Users** page, or **Anomalies** table. | ||
|
|
||
| [[entity-user-risk-scores]] | ||
| [float] | ||
| == User Risk Scores | ||
|
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. The diff shows the User Risk Scores section as added, but it's only been reordered (User Risk Scores and Host Risk Scores have swapped places in the UI, so I moved this section up) without any content changes, so no need to review it. |
||
|
|
||
| .Requirements | ||
| [sidebar] | ||
| -- | ||
| To display user risk scores, you must <<turn-on-risk-engine, turn on the risk scoring engine>>. | ||
| -- | ||
|
|
||
| Displays user risk score data for your environment, including the total number of users, and the five most recently recorded user risk scores, with their associated user names, risk data, and number of detection alerts. Like host risk scores, user risk scores are calculated using a weighted sum on a scale of 0 (lowest) to 100 (highest). | ||
|
|
||
| [role="screenshot"] | ||
| image::images/user-score-data.png[User risk table] | ||
|
|
||
| Interact with the table to filter data, view more details, and take action: | ||
|
|
||
| * Select the *User risk level* menu to filter the chart by the selected level. | ||
| * Click a user name link to open the user details flyout. | ||
| * Hover over a user name link to display inline actions: *Add to timeline*, which adds the selected value to Timeline, and *Copy to Clipboard*, which copies the user name value for you to paste later. | ||
| * Click *View all* in the upper-right to display all user risk information on the Users page. | ||
| * Click the number link in the *Alerts* column to view the alerts on the Alerts page. Hover over the number and select *Investigate in timeline* (image:images/timeline-button-osquery.png[Investigate in timeline icon,20,20]) to launch Timeline with a query that includes the associated user name value. | ||
|
|
||
| For more information about user risk scores, refer to <<entity-risk-scoring>>. | ||
|
|
||
| [[entity-host-risk-scores]] | ||
| [float] | ||
| == Host Risk Scores | ||
|
|
||
| .Requirements | ||
| [sidebar] | ||
| -- | ||
| To display host risk scores, you must <<turn-on-risk-engine, turn on the risk scoring engine>>. | ||
| -- | ||
|
|
||
| Displays host risk score data for your environment, including the total number of hosts, and the five most recently recorded host risk scores, with their associated host names, risk data, and number of detection alerts. Host risk scores are calculated using a weighted sum on a scale of 0 (lowest) to 100 (highest). | ||
|
|
||
| [role="screenshot"] | ||
|
|
@@ -50,24 +80,42 @@ Interact with the table to filter data, view more details, and take action: | |
|
|
||
| For more information about host risk scores, refer to <<entity-risk-scoring>>. | ||
|
|
||
| [[entity-user-risk-scores]] | ||
| [[entity-entities]] | ||
| [float] | ||
| == User Risk Scores | ||
| == Entities | ||
|
|
||
| Displays user risk score data for your environment, including the total number of users, and the five most recently recorded user risk scores, with their associated user names, risk data, and number of detection alerts. Like host risk scores, user risk scores are calculated using a weighted sum on a scale of 0 (lowest) to 100 (highest). | ||
| preview::[] | ||
|
|
||
| .Requirements | ||
| [sidebar] | ||
| -- | ||
| To display the **Entities** section, you must <<enable-entity-store,enable the entity store>>. | ||
| -- | ||
|
|
||
| The **Entities** section provides a centralized view of all hosts and users in your environment. It displays entities from the <<entity-store, entity store>>, which meet any of the following criteria: | ||
|
|
||
| * Have been observed by {elastic-sec} | ||
| * Have an asset criticality assignment | ||
| * Have been added to {elastic-sec} through an integration, such Active Directory or Okta | ||
|
|
||
| NOTE: The **Entities** table only shows a subset of the data available for each entity. You can query the `.entities.v1.latest.security_user_<space-id>` and `.entities.v1.latest.security_host_<space-id>` indices to see all the fields for each entity in the entity store. | ||
|
|
||
| [role="screenshot"] | ||
| image::images/user-score-data.png[User risk table] | ||
| image::images/entities-section.png[Entities section] | ||
|
|
||
| Interact with the table to filter data, view more details, and take action: | ||
| Entity data from different sources appears in the **Entities** section based on the following timelines: | ||
|
|
||
| * Select the *User risk level* menu to filter the chart by the selected level. | ||
| * Click a user name link to open the user details flyout. | ||
| * Hover over a user name link to display inline actions: *Add to timeline*, which adds the selected value to Timeline, and *Copy to Clipboard*, which copies the user name value for you to paste later. | ||
| * Click *View all* in the upper-right to display all user risk information on the Users page. | ||
| * Click the number link in the *Alerts* column to view the alerts on the Alerts page. Hover over the number and select *Investigate in timeline* (image:images/timeline-button-osquery.png[Investigate in timeline icon,20,20]) to launch Timeline with a query that includes the associated user name value. | ||
| * When you first enable the entity store, only data stored in the last 24 hours is processed. After that, data is processed continuously. | ||
| * Observed events from the {elastic-sec} default data view are processed in near real-time. | ||
natasha-moore-elastic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * Entity Analytics data, such as entity risk scores and asset criticality (including bulk asset criticality upload), is also processed in near real-time. | ||
| * The availability of entities extracted from Entity Analytics integrations depends on the specific integration. Refer to {integrations-docs}/entityanalytics_ad[Active Directory Entity Analytics], {integrations-docs}/entityanalytics_entra_id[Microsoft Entra ID Entity Analytics], and {integrations-docs}/entityanalytics_okta[Okta Entity Analytics] for more details. | ||
|
|
||
| For more information about user risk scores, refer to <<entity-risk-scoring>>. | ||
| Interact with the table to filter data and view more details: | ||
|
|
||
| * Select the **Risk level** dropdown to filter the table by the selected user or host risk level. | ||
| * Select the **Criticality** dropdown to filter the table by the selected asset criticality level. | ||
| * Select the **Source** dropdown to filter the table by the data source. | ||
| * Click the **View details** icon (image:detections/images/view-details-icon.png[View details icon,16,15]) to open the entity details flyout. | ||
|
|
||
| [[entity-anomalies]] | ||
| [float] | ||
|
|
||
Uh oh!
There was an error while loading. Please reload this page.