-
Notifications
You must be signed in to change notification settings - Fork 206
[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
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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,52 @@ | ||
| [[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 prerequisites>>. | ||
| -- | ||
|
|
||
| The entity store allows you to query, reconcile, maintain, and persist entity metadata from various sources such as: | ||
|
|
||
| * Ingested log sources | ||
| * Integrated identity providers (such as Active Directory, EntraID, and Okta) | ||
| * Internal and external alerts | ||
| * External asset repositories | ||
| * Asset criticality submissions | ||
|
|
||
| The entity store can store any entity type observed by {elastic-sec}. This allows you to store, view, and query select entities directly from an index 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>>. | ||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| When the entity store is enabled, the following resources are generated: | ||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| * {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 start fresh and clear the extracted entity data. For example, if you have refined your data by normalizing the `user.name` or `host.name` fields, clearing the entity store data allows 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. | ||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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. | ||
natasha-moore-elastic marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| 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 hidden or 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 hidden or 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 |
|---|---|---|
|
|
@@ -8,32 +8,63 @@ 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>> | ||
|
|
||
| // screenshot to be updated | ||
| [role="screenshot"] | ||
| image::images/entity-dashboard.png[Entity dashboard] | ||
|
|
||
| [[entity-kpis]] | ||
| [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 the **Anomalies** table. | ||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| [[entity-user-risk-scores]] | ||
| [float] | ||
| == User Risk Scores | ||
|
Contributor
Author
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 +81,38 @@ 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::[] | ||
|
|
||
| [role="screenshot"] | ||
| image::images/user-score-data.png[User risk table] | ||
| .Requirements | ||
| [sidebar] | ||
| -- | ||
| To display the **Entities** section, you must <<enable-entity-store,enable the entity store>>. | ||
| -- | ||
|
|
||
| Interact with the table to filter data, view more details, and take action: | ||
| The **Entities** section provides a centralized view of all hosts and users in your environment. It displays entities stored in the <<entity-store, entity store>>, which: | ||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| * 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. | ||
| * 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 | ||
|
|
||
| For more information about user risk scores, refer to <<entity-risk-scoring>>. | ||
| The stored entity data appears in the **Entities** section based on the following timelines: | ||
natasha-moore-elastic marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| * 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. | ||
|
|
||
| NOTE: The **Entities** table only shows a subset of the attributes stored in the entity store. You can query the `.entities.v1.latest.security_user_<space-id>` and `.entities.v1.latest.security_host_<space-id>` indices to see all the attributes stored in the entity store. | ||
|
|
||
| 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 to open the entity details flyout. | ||
|
|
||
| [[entity-anomalies]] | ||
| [float] | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.