Skip to content

Commit c966b11

Browse files
jmcarlockbmorelli25natasha-moore-elastic
authored
Security machine learning rule documentation improvements (#2240)
## Related issue elastic/security-ml#776 --------- Co-authored-by: Brandon Morelli <[email protected]> Co-authored-by: natasha-moore-elastic <[email protected]> Co-authored-by: natasha-moore-elastic <[email protected]>
1 parent b7a1c39 commit c966b11

File tree

8 files changed

+52
-6
lines changed

8 files changed

+52
-6
lines changed
107 KB
Loading
307 KB
Loading
49.7 KB
Loading
423 KB
Loading

solutions/security/advanced-entity-analytics/anomaly-detection.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,16 @@ products:
1414
# Anomaly detection
1515

1616

17+
::::{note}
1718
[{{ml-cap}}](/explore-analyze/machine-learning/anomaly-detection.md) functionality is available when you have the appropriate role, subscription, are using a [cloud deployment](https://cloud.elastic.co/registration?page=docs&placement=docs-body), or are testing out a **Free Trial**. Refer to [Machine learning job and rule requirements](/solutions/security/advanced-entity-analytics/machine-learning-job-rule-requirements.md) for more information.
19+
::::
1820

19-
You can view the details of detected anomalies within the `Anomalies` table widget shown on the Hosts, Network, and associated details pages, or even narrow to the specific date range of an anomaly from the `Max anomaly score by job` field in the overview of the details pages for hosts and IPs. These interfaces also offer the ability to drag and drop details of the anomaly to Timeline, such as the `Entity` itself, or any of the associated `Influencers`.
21+
Anomaly detection jobs identify anomalous events or patterns in your data. In a security context, they’re typically used with detection rules to trigger alerts when behavior deviates from baseline activity.
22+
23+
24+
::::{tip}
25+
Refer to [{{ml-cap}}: Anomaly detection](/explore-analyze/machine-learning/anomaly-detection.md) and [About detection rules](/solutions/security/detect-and-alert/about-detection-rules.md) for more background.
26+
::::
2027

2128

2229
## Manage {{ml}} jobs [manage-jobs]
@@ -47,6 +54,10 @@ You can also check the status of {{ml}} detection rules, and start or stop their
4754
:screenshot:
4855
:::
4956

57+
::::{tip}
58+
* For instructions on creating {{ml}} rules, refer to [Create a machine learning rule](/solutions/security/detect-and-alert/create-detection-rule.md#create-ml-rule).
59+
* Alerts generated by {{ml}} rules are displayed on the **Alerts** page. For more information, refer to [Manage detection alerts](/solutions/security/detect-and-alert/manage-detection-alerts.md).
60+
::::
5061

5162

5263
### Prebuilt jobs [included-jobs]
@@ -63,18 +74,47 @@ Or
6374

6475
* You install one or more of the [Advanced Analytics integrations](/solutions/security/advanced-entity-analytics/behavioral-detection-use-cases.md#ml-integrations).
6576

66-
[](/reference/data-analysis/machine-learning/ootb-ml-jobs-siem.md) describes all available {{ml}} jobs and lists which ECS fields are required on your hosts when you are not using {{beats}} or the {{agent}} to ship your data. For information on tuning anomaly results to reduce the number of false positives, see [Optimizing anomaly results](/solutions/security/advanced-entity-analytics/optimizing-anomaly-results.md).
77+
[](/reference/data-analysis/machine-learning/ootb-ml-jobs-siem.md) describes all available {{ml}} jobs and lists their requirements. For information on tuning anomaly results to reduce the number of false positives, see [Optimizing anomaly results](/solutions/security/advanced-entity-analytics/optimizing-anomaly-results.md).
6778

6879
::::{note}
6980
Machine learning jobs look back and analyze two weeks of historical data prior to the time they are enabled. After jobs are enabled, they continuously analyze incoming data. When jobs are stopped and restarted within the two-week time frame, previously analyzed data is not processed again.
7081
::::
7182

7283

73-
7484
## View detected anomalies [view-anomalies]
7585

76-
To view the `Anomalies` table widget and `Max Anomaly Score By Job` details, the user must have the `machine_learning_admin` or `machine_learning_user` role.
86+
View details of detected anomalies in the **Anomalies** data tables, available on the **Hosts**, **Network**, or **Users** pages. You can access these pages from the navigation menu or with the [global search field](/explore-analyze/find-and-organize/find-apps-and-objects.md).
87+
88+
::::{note}
89+
To view the **Anomalies** table and **Max Anomaly Score By Job** details, the user must have the `machine_learning_admin` or `machine_learning_user` role.
90+
::::
91+
92+
:::{image} /solutions/images/security-host-anomalies.png
93+
:alt: Host anomalies
94+
:screenshot:
95+
:::
7796

7897
::::{note}
7998
To adjust the `score` threshold that determines which anomalies are shown, you can modify the `securitySolution:defaultAnomalyScore` [advanced setting](/solutions/security/get-started/configure-advanced-settings.md).
8099
::::
100+
101+
In the **Anomalies** table, you can add entity details, like the entity or any associated influencers, into Timeline.
102+
103+
:::{image} /solutions/images/security-host-anomaly-add-to-timeline.png
104+
:alt: Host anomalies
105+
:screenshot:
106+
:::
107+
108+
When you click into a specific host, IP, or user name (depending on the page), you can narrow the time range to a specific anomaly. To do this, click the info icon next to a maximum anomaly score and select **Narrow to this date range**.
109+
110+
:::{image} /solutions/images/security-host-max-anomaly-score-by-job.png
111+
:alt: Filter by Max anomaly score by job
112+
:screenshot:
113+
:::
114+
115+
On this page, you can also add fields to Timeline by hovering over a field name and selecting the Add to timeline icon.
116+
117+
:::{image} /solutions/images/security-host-add-to-timeline.png
118+
:alt: Filter by Max anomaly score by job
119+
:screenshot:
120+
:::

solutions/security/detect-and-alert/create-detection-rule.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,10 @@ To create or edit {{ml}} rules, you need:
9292
* The appropriate [{{stack}} subscription](https://www.elastic.co/pricing) or [{{serverless-short}} project tier](../../../deploy-manage/deploy/elastic-cloud/project-settings.md).
9393
* The [`machine_learning_admin`](/deploy-manage/users-roles/cluster-or-deployment-auth/built-in-roles.md) in {{stack}} or the appropriate [user role](/deploy-manage/users-roles/cloud-organization/user-roles.md) in {{serverless-short}}.
9494
* The selected {{ml}} job to be running for the rule to function correctly.
95+
::::
9596

97+
::::{tip}
98+
For an overview of using {{ml}} with {{elastic-sec}}, refer to [Anomaly detection](/solutions/security/advanced-entity-analytics/anomaly-detection.md).
9699
::::
97100

98101

@@ -120,6 +123,9 @@ To create or edit {{ml}} rules, you need:
120123

121124
5. Click **Continue** to [configure basic rule settings](/solutions/security/detect-and-alert/create-detection-rule.md#rule-ui-basic-params).
122125

126+
::::{tip}
127+
To filter noisy {{ml}} rules, use [rule exceptions](/solutions/security/detect-and-alert/rule-exceptions.md).
128+
::::
123129

124130
## Create a threshold rule [create-threshold-rule]
125131

solutions/security/explore/hosts-page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Beneath the KPI charts are data tables, categorized by individual tabs, which ar
4040
* **Events**: All host events. To display alerts received from external monitoring tools, scroll down to the Events table and select **Show only external alerts** on the right.
4141
* **All hosts**: High-level host details.
4242
* **Uncommon processes**: Uncommon processes running on hosts.
43-
* **Anomalies**: Anomalies discovered by machine learning jobs.
43+
* **Anomalies**: Anomalies discovered by [{{ml}} jobs](/solutions/security/advanced-entity-analytics/anomaly-detection.md).
4444
* **Host risk**: The latest recorded host risk score for each host, and its host risk classification. In {{stack}}, this feature requires a [Platinum subscription](https://www.elastic.co/pricing) or higher. In serverless, this feature requires the Security Analytics Complete [project feature](/deploy-manage/deploy/elastic-cloud/project-settings.md). Click **Enable** on the **Host risk** tab to get started. To learn more, refer to our [entity risk scoring documentation](/solutions/security/advanced-entity-analytics/entity-risk-scoring.md).
4545
* **Sessions**: Linux process events that you can open in [Session View](/solutions/security/investigate/session-view.md), an investigation tool that allows you to examine Linux process data at a hierarchal level.
4646

solutions/security/explore/users-page.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Beneath the KPI charts are data tables, which are useful for viewing and investi
4040
* **Events**: Ingested events that contain the `user.name` field. You can stack by the `event.action`, `event.dataset`, or `event.module` field. To display alerts received from external monitoring tools, scroll down to the Events table and select **Show only external alerts** on the right.
4141
* **All users**: A chronological list of unique user names, when they were last active, and the associated domains.
4242
* **Authentications**: A chronological list of user authentication events and associated details, such as the number of successes and failures, and the host name of the last successful destination.
43-
* **Anomalies**: Unusual activity discovered by machine learning jobs that contain user data.
43+
* **Anomalies**: Unusual activity discovered by [{{ml}} jobs](/solutions/security/advanced-entity-analytics/anomaly-detection.md) that contain user data.
4444
* **User risk**: The latest recorded user risk score for each user, and its user risk classification. In {{stack}}, this feature requires a [Platinum subscription](https://www.elastic.co/pricing) or higher. In serverless, this feature requires the Security Analytics Complete [project feature](/deploy-manage/deploy/elastic-cloud/project-settings.md). Click **Enable** on the **User risk** tab to get started. To learn more, refer to our [entity risk scoring documentation](/solutions/security/advanced-entity-analytics/entity-risk-scoring.md).
4545

4646
The Events table includes inline actions and several customization options. To learn more about what you can do with the data in these tables, refer to [*Manage detection alerts*](/solutions/security/detect-and-alert/manage-detection-alerts.md).

0 commit comments

Comments
 (0)