Skip to content

Commit 23e7cc7

Browse files
authored
[apm] Update machine learning flyout and service maps docs (#65517)
1 parent 8ba44eb commit 23e7cc7

File tree

10 files changed

+56
-15
lines changed

10 files changed

+56
-15
lines changed
477 KB
Loading

docs/apm/images/green-service.png

4.36 KB
Loading

docs/apm/images/red-service.png

5.24 KB
Loading

docs/apm/images/service-maps.png

222 KB
Loading

docs/apm/images/yellow-service.png

4.32 KB
Loading

docs/apm/machine-learning.asciidoc

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,31 @@
66
<titleabbrev>Integrate with machine learning</titleabbrev>
77
++++
88

9-
The Machine Learning integration will initiate a new job predefined to calculate anomaly scores on transaction response times.
10-
The response time graph will show the expected bounds and add an annotation when the anomaly score is 75 or above.
11-
Jobs can be created per transaction type, and based on the average response time.
12-
Manage jobs in the *Machine Learning jobs management*.
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.
11+
12+
After a machine learning job is created, results are shown in two places:
13+
14+
The transaction duration graph will show the expected bounds and add an annotation when the anomaly score is 75 or above.
15+
16+
[role="screenshot"]
17+
image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in the APM app]
18+
19+
Service maps will display a color-coded anomaly indicator based on the detected anomaly score.
1320

1421
[role="screenshot"]
15-
image::apm/images/apm-ml-integration.png[Example view of anomaly scores on response times in APM app in Kibana]
22+
image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app]
1623

1724
[float]
1825
[[create-ml-integration]]
1926
=== Create a new machine learning job
2027

2128
To enable machine learning anomaly detection, first choose a service to monitor.
2229
Then, select **Integrations** > **Enable ML anomaly detection** and click **Create job**.
30+
2331
That's it! After a few minutes, the job will begin calculating results;
2432
it might take additional time for results to appear on your graph.
33+
Jobs can be managed in *Machine Learning jobs management*.
2534

2635
APM specific anomaly detection wizards are also available for certain Agents.
2736
See the machine learning {ml-docs}/ootb-ml-jobs-apm.html[APM anomaly detection configurations] for more information.

docs/apm/service-maps.asciidoc

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ Please use Chrome or Firefox if available.
99

1010
A service map is a real-time visual representation of the instrumented services in your application's architecture.
1111
It shows you how these services are connected, along with high-level metrics like average transaction duration,
12-
requests per minute, and errors per minute, that allow you to quickly assess the status of your services.
12+
requests per minute, and errors per minute.
13+
If enabled, service maps also integrate with machine learning--for real time health indicators based on anomaly detection scores.
14+
All of these features can help you to quickly and visually assess the status and health of your services.
1315

1416
We currently surface two types of service maps:
1517

@@ -52,6 +54,26 @@ Additional filters are not currently available for service maps.
5254
[role="screenshot"]
5355
image::apm/images/service-maps-java.png[Example view of service maps with Java highlighted in the APM app in Kibana]
5456

57+
[float]
58+
[[service-map-anomaly-detection]]
59+
=== Anomaly detection with machine learning
60+
61+
Machine learning jobs can be created to calculate anomaly scores on APM transaction durations within the selected service.
62+
When these jobs are active, service maps will display a color-coded anomaly indicator based on the detected anomaly score:
63+
64+
[horizontal]
65+
image:apm/images/green-service.png[APM green service]:: Max anomaly score **<=25**. Service is healthy.
66+
image:apm/images/yellow-service.png[APM yellow service]:: Max anomaly score **26-74**. Anomalous activity detected. Service may be degraded.
67+
image:apm/images/red-service.png[APM red service]:: Max anomaly score **>=75**. Anomalous activity detected. Service is unhealthy.
68+
69+
[role="screenshot"]
70+
image::apm/images/apm-service-map-anomaly.png[Example view of anomaly scores on service maps in the APM app]
71+
72+
If an anomaly has been detected, click *view anomalies* to view the anomaly detection metric viewier in the Machine learning app.
73+
This time series analysis will display additional details on the severity and time of the detected anomalies.
74+
75+
To learn how to create a machine learning job, see <<machine-learning-integration,machine learning integration>>.
76+
5577
[float]
5678
[[service-maps-legend]]
5779
=== Legend

x-pack/plugins/apm/public/components/app/ServiceDetails/ServiceIntegrations/MachineLearningFlyout/view.tsx

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -134,17 +134,29 @@ export function MachineLearningFlyoutView({
134134
<p>
135135
<FormattedMessage
136136
id="xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription"
137-
defaultMessage="Here you can create a machine learning job to calculate anomaly scores on durations for APM transactions
138-
within the {serviceName} service. Once enabled, {transactionDurationGraphText} will show the expected bounds and annotate
139-
the graph once the anomaly score is &gt;=75."
137+
defaultMessage="Create a machine learning job to calculate anomaly scores on APM transaction durations
138+
within the {serviceName} service. When enabled, anomalies are show in two places:
139+
The {transactionDurationGraphText} graph will show the expected bounds and annotate
140+
the graph if the anomaly score is &gt;=75, and {serviceMapAnnotationText} will display color
141+
coded service indicators based on the active anomaly score."
140142
values={{
141143
serviceName,
142144
transactionDurationGraphText: (
143145
<b>
144146
{i18n.translate(
145147
'xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription.transactionDurationGraphText',
146148
{
147-
defaultMessage: 'the transaction duration graph'
149+
defaultMessage: 'transaction duration'
150+
}
151+
)}
152+
</b>
153+
),
154+
serviceMapAnnotationText: (
155+
<b>
156+
{i18n.translate(
157+
'xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription.serviceMapAnnotationText',
158+
{
159+
defaultMessage: 'service maps'
148160
}
149161
)}
150162
</b>
@@ -155,15 +167,15 @@ export function MachineLearningFlyoutView({
155167
<p>
156168
<FormattedMessage
157169
id="xpack.apm.serviceDetails.enableAnomalyDetectionPanel.manageMLJobDescription"
158-
defaultMessage="Jobs can be created for each service + transaction type combination.
159-
Once a job is created, you can manage it and see more details in the {mlJobsPageLink}."
170+
defaultMessage="Jobs can be created for each service and transaction type.
171+
Once a job is created, you can manage it and see more details on the {mlJobsPageLink}."
160172
values={{
161173
mlJobsPageLink: (
162174
<MLLink>
163175
{i18n.translate(
164176
'xpack.apm.serviceDetails.enableAnomalyDetectionPanel.manageMLJobDescription.mlJobsPageLinkText',
165177
{
166-
defaultMessage: 'Machine Learning jobs management page'
178+
defaultMessage: 'Machine Learning Job Management page'
167179
}
168180
)}
169181
</MLLink>

x-pack/plugins/translations/translations/ja-JP.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4314,7 +4314,6 @@
43144314
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.callout.jobExistsDescription": "現在 {serviceName} ({transactionType}) の実行中のジョブがあります。",
43154315
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.callout.jobExistsDescription.viewJobLinkText": "既存のジョブを表示",
43164316
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.callout.jobExistsTitle": "ジョブが既に存在します",
4317-
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription": "ここでは、{serviceName} 数列内の APM トランザクションの期間の異常スコアを計算する機械学習ジョブを作成できます。有効にすると、{transactionDurationGraphText} が予測バウンドを表示し、異常スコアが >=75 の場合グラフに注釈が追加されます。",
43184317
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription.transactionDurationGraphText": "トランザクション時間のグラフ",
43194318
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createNewJobButtonLabel": "ジョブを作成",
43204319
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.enableAnomalyDetectionTitle": "異常検知を有効にする",

x-pack/plugins/translations/translations/zh-CN.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4315,7 +4315,6 @@
43154315
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.callout.jobExistsDescription": "当前有 {serviceName}({transactionType})的作业正在运行。",
43164316
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.callout.jobExistsDescription.viewJobLinkText": "查看现有作业",
43174317
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.callout.jobExistsTitle": "作业已存在",
4318-
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription": "在这里可以创建 Machine Learning 作业以基于 {serviceName} 服务内 APM 事务的持续时间计算异常分数。启用后,一旦异常分数 >=75,{transactionDurationGraphText}将显示预期边界并标注图表。",
43194318
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createMLJobDescription.transactionDurationGraphText": "事务持续时间图表",
43204319
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.createNewJobButtonLabel": "创建作业",
43214320
"xpack.apm.serviceDetails.enableAnomalyDetectionPanel.enableAnomalyDetectionTitle": "启用异常检测",

0 commit comments

Comments
 (0)