Skip to content
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

[DOCS] Entity dashboard #2565

Merged
merged 5 commits into from
Oct 20, 2022
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/dashboards/dashboards-overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,5 @@ include::detection-response-dashboard.asciidoc[leveloffset=+1]
include::kubernetes-dashboard.asciidoc[leveloffset=+1]

include::cloud-posture.asciidoc[leveloffset=+1]

include::entity-dashboard.asciidoc[leveloffset=+1]
57 changes: 57 additions & 0 deletions docs/dashboards/entity-dashboard.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
[[detection-entity-dashboard]]
= Entity dashboard
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

The Entity Analytics dashboard provides a centralized view of critical entity metrics, which include hosts, users, and anomalies. Use this information to determine which emerging threats pose a higher risk to your environment so you can respond quickly.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved


.Requirements
[sidebar]
--
The following is required to display the Entity Analytics dashboard:

* A https://www.elastic.co/pricing/[Platinum subscription] or higher.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved
* To display host and user risk scores, the host risk score and user risk score features must be enabled. For more information, refer to Enable host risk score and <<deploy-user-risk-score, Enable user risk score>>.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved
* To display notable anomalies, the following machine learning jobs need to be installed and run. You can do this directly from the dashboard's Notable anomalies table:
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved
** `auth_rare_source_ip_for_a_user`
** `suspicious_login_activity`
** `packetbeat_dns_tunneling`
** `packetbeat_rare_server_domain`
** `packetbeat_rare_dns_question`
** `v3_windows_anomalous_script`
--


[insert screenshot, waiting for a good one]


The dashboard includes the following sections:

* Entity KPIs
* Host risk scores
* User risk scores
* Notable anomalies
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

*Entity KPIs (key performance indicators)*
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

Displays the total number of critical hosts, critical users, and anomalies. Select a link to go to the Host risk table, User risk table, or Anomaly Detection Jobs page.

*Host risk scores*
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

Displays host risk score metrics in your environment, including the total number of hosts, the five most recently recorded host risk scores, their host name, and host risk classification. Host risk scores are calculated using a weighted sum and are on a scale of 0 to 100. Select the *Host risk classification* menu to filter the chart by the selected classification. Click a host name link to go to the Host details page, or *View all* in the upper-right to display all host risk information on the Hosts page.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved


For more information about host risk scores, click the *Learn more* link in the table, or refer to <<host-risk-score>>.

*User risk scores*
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

Displays user risk score metrics in your environment, including the total number of users, the five most recently recorded user risk scores, their user name, and user risk classification. Like host risk scores, user risk scores are also calculated using a weighted sum and are on a scale of 0 to 100. Select the *User risk classification* menu to filter the chart by the selected classification. Click a user name link to go to the User details page, or *View all* in the upper-right to display all user risk information on the Users page.

NOTE: The host risk and user risk score tables are not affected by the date and time range.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved

*Notable anomalies*

Anomalies identify suspicious or irregular behavior patterns. This section displays the total number of host and user anomalies identified by six predefined machine learning jobs (anomaly name). If no counts are displayed next to a machine learning job, it is uninstalled or needs to run. Click *Run job* to run the job, or *uninstalled* to find out how to install and run the job.
jmikell821 marked this conversation as resolved.
Show resolved Hide resolved


Click *View all host anomalies* to go to the Anomalies table on the Hosts page, *View all users anomalies* to go to the Anomalies table on the Users page, or *View all* to display and manage all machine learning jobs on the Anomaly Detection Jobs page. To learn more about machine learning, refer to {ml-app}/machine-learning-intro.html[What is Elastic machine learning?].