Skip to content

Commit 17e8d18

Browse files
authored
[APM] docs: Update machine learning integration (#73597)
1 parent 357139d commit 17e8d18

File tree

2 files changed

+37
-12
lines changed

2 files changed

+37
-12
lines changed
61.1 KB
Loading

docs/apm/machine-learning.asciidoc

Lines changed: 37 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,61 @@
11
[role="xpack"]
22
[[machine-learning-integration]]
3-
=== integration
3+
=== Machine learning integration
44

55
++++
66
<titleabbrev>Integrate with machine learning</titleabbrev>
77
++++
88

9-
The Machine Learning integration initiates a new job predefined to calculate anomaly scores on APM transaction durations.
10-
Jobs can be created per transaction type, and are based on the service's average response time.
9+
The Machine learning integration initiates a new job predefined to calculate anomaly scores on APM transaction durations.
10+
With this integration, you can quickly pinpoint anomalous transactions and see the health of
11+
any upstream and downstream services.
1112

12-
After a machine learning job is created, results are shown in two places:
13+
Machine learning jobs are created per environment, and are based on a service's average response time.
14+
Because jobs are created at the environment level,
15+
you can add new services to your existing environments without the need for additional machine learning jobs.
1316

14-
The transaction duration graph will show the expected bounds and add an annotation when the anomaly score is 75 or above.
17+
After a machine learning job is created, results are shown in two places:
1518

19+
* The transaction duration chart will show the expected bounds and add an annotation when the anomaly score is 75 or above.
20+
+
1621
[role="screenshot"]
1722
image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in the APM app]
1823

19-
Service maps will display a color-coded anomaly indicator based on the detected anomaly score.
20-
24+
* Service maps will display a color-coded anomaly indicator based on the detected anomaly score.
25+
+
2126
[role="screenshot"]
2227
image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app]
2328

2429
[float]
2530
[[create-ml-integration]]
26-
=== Create a new machine learning job
31+
=== Enable anomaly detection
32+
33+
To enable machine learning anomaly detection:
34+
35+
. From the Services overview, Traces overview, or Service Map tab,
36+
select **Anomaly detection**.
37+
38+
. Click **Create ML Job**.
2739

28-
To enable machine learning anomaly detection, first choose a service to monitor.
29-
Then, select **Integrations** > **Enable ML anomaly detection** and click **Create job**.
40+
. Machine learning jobs are created at the environment level.
41+
Select all of the service environments that you want to enable anomaly detection in.
42+
Anomalies will surface for all services and transaction types within the selected environments.
43+
44+
. Click **Create Jobs**.
3045

3146
That's it! After a few minutes, the job will begin calculating results;
32-
it might take additional time for results to appear on your graph.
33-
Jobs can be managed in *Machine Learning jobs management*.
47+
it might take additional time for results to appear on your service maps.
48+
Existing jobs can be managed in *Machine Learning jobs management*.
3449

3550
APM specific anomaly detection wizards are also available for certain Agents.
3651
See the machine learning {ml-docs}/ootb-ml-jobs-apm.html[APM anomaly detection configurations] for more information.
52+
53+
[float]
54+
[[warning-ml-integration]]
55+
=== Anomaly detection warning
56+
57+
To make machine learning as easy as possible to set up,
58+
the APM app will warn you when filtered to an environment without a machine learning job.
59+
60+
[role="screenshot"]
61+
image::apm/images/apm-anomaly-alert.png[Example view of anomaly alert in the APM app]

0 commit comments

Comments
 (0)