Skip to content

Commit e32e680

Browse files
Add known issue for APM Server version 8.6 and older with ES 8.15 (#4844) (#4846)
(cherry picked from commit f7156d6) Co-authored-by: Vishal Raj <[email protected]>
1 parent 4a72fba commit e32e680

File tree

1 file changed

+38
-0
lines changed

1 file changed

+38
-0
lines changed

docs/en/observability/apm/known-issues.asciidoc

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,44 @@ _Versions: XX.XX.XX, YY.YY.YY, ZZ.ZZ.ZZ_
2121
// If applicable, link to fix
2222
////
2323

24+
[discrete]
25+
== APM Server v8.6.x and prior with Elasticsearch v8.15.x and later has broken APM UI
26+
27+
_Elastic Stack versions: 8.15.0+_
28+
29+
// The conditions in which this issue occurs
30+
The issue occurs when using APM Server versions <= 8.6.x with {stack} versions 8.15.x and later.
31+
32+
// Describe why it happens
33+
In APM Server versions prior to 8.7.0, the aggregated metrics were indexed in APM's internal data stream. The aggregated metrics require some additional mappings to properly index the data and allow the APM UI to be able to use the data to populate service inventory page properly. From APM Server version 8.7.0, aggregated metrics were moved to their dedicated datastreams (https://github.com/elastic/apm-server/issues/9703[ref]), however, the internal mappings were kept to support backward compatibility. In APM Server version 8.15.0 we migrated to the https://github.com/elastic/elasticsearch/tree/main/x-pack/plugin/apm-data[apm-data plugin] and the internal mappings required to make aggregated metrics work were dropped.
34+
35+
// How to fix it
36+
If the deployment is running 8.15.0 and APM Server versions are still at 8.6.x or older then the recommendation would be to upgrade the APM Server to the same version as the stack version. If upgrade is not possible then the custom component template should be updated to include custom mappings for making internal datastreams support aggregated metrics:
37+
38+
[source,txt]
39+
----
40+
PUT _component_template/metrics-apm.internal@custom
41+
{
42+
"template": {
43+
"mappings": {
44+
"dynamic_templates": [],
45+
"properties": {
46+
"transaction.duration.histogram": {
47+
"type": "histogram"
48+
}
49+
}
50+
}
51+
},
52+
"_meta": {
53+
"package": {
54+
"name": "apm"
55+
},
56+
"managed_by": "fleet",
57+
"managed": true
58+
}
59+
}
60+
----
61+
2462
[discrete]
2563
== `prefer_ilm` required in component templates to create custom lifecycle policies
2664

0 commit comments

Comments
 (0)