Skip to content

Commit e4f412b

Browse files
committed
add APM integrate with ML
1 parent 6cbbbb6 commit e4f412b

File tree

3 files changed

+44
-10
lines changed

3 files changed

+44
-10
lines changed

raw-migrated-files/observability-docs/observability/apm-anomaly-rule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ navigation_title: "APM Anomaly"
66

77

88
::::{important}
9-
To use the APM Anomaly rule, you have to enable [machine learning](../../../solutions/observability/apps/integrate-with-machine-learning.md#create-ml-integration), which requires an [appropriate license](https://www.elastic.co/subscriptions).
9+
To use the APM Anomaly rule, you have to enable [machine learning](../../../solutions/observability/apps/integrate-with-machine-learning.md#observability-apm-integrate-with-machine-learning-enable-anomaly-detection), which requires an [appropriate license](https://www.elastic.co/subscriptions).
1010

1111
::::
1212

raw-migrated-files/observability-docs/observability/apm-machine-learning-integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,6 @@ To make machine learning as easy as possible to set up, the Applications UI will
6666

6767
After enabling anomaly detection, service health may display as "Unknown". Here are some reasons why this can occur:
6868

69-
1. No machine learning job exists. See [Enable anomaly detection](../../../solutions/observability/apps/integrate-with-machine-learning.md#create-ml-integration) to enable anomaly detection and create a machine learning job.
69+
1. No machine learning job exists. See [Enable anomaly detection](../../../solutions/observability/apps/integrate-with-machine-learning.md#observability-apm-integrate-with-machine-learning-enable-anomaly-detection) to enable anomaly detection and create a machine learning job.
7070
2. There is no machine learning data for the job. If you just created the machine learning job you’ll need to wait a few minutes for data to be available. Alternatively, if the service or its enviroment are new, you’ll need to wait for more trace data.
7171
3. No "request" or "page-load" transaction type exists for this service; service health is only available for these transaction types.

solutions/observability/apps/integrate-with-machine-learning.md

Lines changed: 42 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,51 @@ mapped_urls:
44
- https://www.elastic.co/guide/en/serverless/current/observability-apm-integrate-with-machine-learning.html
55
---
66

7-
# Integrate with machine learning
7+
# Integrate with machine learning [observability-apm-integrate-with-machine-learning]
88

9-
% What needs to be done: Align serverless/stateful
9+
::::{important}
10+
Using machine learning requires an [appropriate license](https://www.elastic.co/subscriptions).
1011

11-
% Use migrated content from existing pages that map to this page:
12+
::::
1213

13-
% - [ ] ./raw-migrated-files/observability-docs/observability/apm-machine-learning-integration.md
14-
% - [ ] ./raw-migrated-files/docs-content/serverless/observability-apm-integrate-with-machine-learning.md
14+
The Machine learning integration initiates a new job predefined to calculate anomaly scores on APM transaction durations. With this integration, you can quickly pinpoint anomalous transactions and see the health of any upstream and downstream services.
1515

16-
% Internal links rely on the following IDs being on this page (e.g. as a heading ID, paragraph ID, etc):
16+
Machine learning jobs are created per environment and are based on a service’s average response time. Because jobs are created at the environment level, you can add new services to your existing environments without the need for additional machine learning jobs.
1717

18-
$$$create-ml-integration$$$
18+
Results from machine learning jobs are shown in multiple places throughout the Applications UI:
1919

20-
$$$observability-apm-integrate-with-machine-learning-enable-anomaly-detection$$$
20+
* The **Services overview** provides a quick-glance view of the general health of all of your services.
21+
* The transaction duration chart will show the expected bounds and add an annotation when the anomaly score is 75 or above.
22+
* Service Maps will display a color-coded anomaly indicator based on the detected anomaly score.
23+
24+
:::{image} ../../../images/observability-apm-service-map-anomaly.png
25+
:alt: Example view of anomaly scores on service maps in the Applications UI
26+
:class: screenshot
27+
:::
28+
29+
30+
## Enable anomaly detection [observability-apm-integrate-with-machine-learning-enable-anomaly-detection]
31+
32+
To enable machine learning anomaly detection:
33+
34+
1. In your {{obs-serverless}} project or {{kib}}, go to any **Applications** page.
35+
2. Click **Anomaly detection**.
36+
3. Click **Create Job**.
37+
4. Machine learning jobs are created at the environment level. Select all of the service environments that you want to enable anomaly detection in. Anomalies will surface for all services and transaction types within the selected environments.
38+
5. Click **Create Jobs**.
39+
40+
That’s it! After a few minutes, the job will begin calculating results; it might take additional time for results to appear on your service maps. To manage existing jobs, click **Manage jobs** (or go to **Machine learning****Jobs**).
41+
42+
43+
## Anomaly detection warning [observability-apm-integrate-with-machine-learning-anomaly-detection-warning]
44+
45+
To make machine learning as easy as possible to set up, Elastic will warn you when filtered to an environment without a machine learning job.
46+
47+
48+
## Unknown service health [observability-apm-integrate-with-machine-learning-unknown-service-health]
49+
50+
After enabling anomaly detection, service health may display as "Unknown". Here are some reasons why this can occur:
51+
52+
1. No machine learning job exists. See [Enable anomaly detection](../../../solutions/observability/apps/integrate-with-machine-learning.md#observability-apm-integrate-with-machine-learning-enable-anomaly-detection) to enable anomaly detection and create a machine learning job.
53+
2. There is no machine learning data for the job. If you just created the machine learning job you’ll need to wait a few minutes for data to be available. Alternatively, if the service or its environment are new, you’ll need to wait for more trace data.
54+
3. No "request" or "page-load" transaction type exists for this service; service health is only available for these transaction types.

0 commit comments

Comments
 (0)