Skip to content

Commit e3de80c

Browse files
colleenmcginnisendorama
authored andcommitted
1 parent c1be1da commit e3de80c

File tree

4 files changed

+23
-34
lines changed

4 files changed

+23
-34
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,33 @@
11
---
2-
navigation_title: "Elastic APM"
2+
navigation_title: "Breaking changes"
33
---
44

55
# Elastic APM breaking changes
66

7-
Before you upgrade, carefully review the Elastic APM breaking changes and take the necessary steps to mitigate any issues.
8-
9-
% To learn how to upgrade, check out <uprade docs>.
10-
11-
% ## Next version
7+
Breaking changes can impact your Elastic applications, potentially disrupting normal operations. Before you upgrade, carefully review the Elastic APM breaking changes and take the necessary steps to mitigate any issues. To learn how to upgrade, check [Upgrade](docs-content://deploy-manage/upgrade.md).
128

9+
% ## Next version [next-version]
1310
% **Release date:** Month day, year
1411

1512
% ::::{dropdown} Title of breaking change
1613
% Description of the breaking change.
1714
% For more information, check [PR #](PR link).
15+
1816
% **Impact**<br> Impact of the breaking change.
17+
1918
% **Action**<br> Steps for mitigating deprecation impact.
2019
% ::::
2120

2221
## 9.0.0 [9-0-0]
23-
24-
**Release date:** March 25, 2025
22+
**Release date:** April 2, 2025
2523

2624
::::{dropdown} Change server information endpoint "/" to only accept GET and HEAD requests
2725
This will surface any agent misconfiguration causing data to be sent to `/` instead of the correct endpoint (for example, `/v1/traces` for OTLP/HTTP).
28-
For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976).
26+
For more information, check [#15976]({{apm-pull}}15976).
2927

30-
**Impact**<br>Any methods other than `GET` and `HEAD` to `/` will return HTTP 405 Method Not Allowed.
28+
**Impact**<br> Any methods other than `GET` and `HEAD` to `/` will return HTTP 405 Method Not Allowed.
3129

32-
**Action**<br>Update any existing usage, for example, update `POST /` to `GET /`.
30+
**Action**<br> Update any existing usage, for example, update `POST /` to `GET /`.
3331
::::
3432

3533
::::{dropdown} The Elasticsearch apm_user role has been removed

docs/release-notes/deprecations.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
---
2-
navigation_title: "Elastic APM"
2+
navigation_title: "Deprecations"
33
---
44

55
# Elastic APM deprecations
6+
Over time, certain Elastic functionality becomes outdated and is replaced or removed. To help with the transition, Elastic deprecates functionality for a period before removal, giving you time to update your applications.
67

7-
Review the deprecated functionality for your Elastic APM version. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade.
8+
Review the deprecated functionality for Elastic APM. While deprecations have no immediate impact, we strongly encourage you update your implementation after you upgrade. To learn how to upgrade, check out [Upgrade](docs-content://deploy-manage/upgrade.md).
89

9-
% To learn how to upgrade, check out <uprade docs>.
10-
11-
% ## Next version
10+
% ## Next version [next-version]
1211
% **Release date:** Month day, year
1312

1413
% ::::{dropdown} Deprecation title
@@ -19,7 +18,7 @@ Review the deprecated functionality for your Elastic APM version. While deprecat
1918
% ::::
2019

2120
% ## 9.0.0 [9-0-0]
22-
% **Release date:** March 25, 2025
21+
% **Release date:** April 2, 2025
2322

2423
% ::::{dropdown} Deprecation title
2524
% Description of the deprecation.

docs/release-notes/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,7 @@ To check for security updates, go to [Security announcements for the Elastic sta
2222
% ### Fixes [elastic-apm-next-fixes]
2323

2424
## 9.0.0 [9-0-0]
25-
26-
**Release date:** March 25, 2025
25+
**Release date:** April 2, 2025
2726

2827
### Features and enhancements [9-0-0-features-enhancements]
2928

docs/release-notes/known-issues.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,24 @@
22
mapped_pages:
33
- https://www.elastic.co/guide/en/observability/current/apm-known-issues.html
44

5-
navigation_title: "Elastic APM"
5+
navigation_title: "Known issues"
66
---
77

88
# Elastic APM known issues
9+
Known issues are significant defects or limitations that may impact your implementation. These issues are actively being worked on and will be addressed in a future release. Review the Elastic APM known issues to help you make informed decisions, such as upgrading to a new version.
910

1011
% Use the following template to add entries to this page.
1112

1213
% :::{dropdown} Title of known issue
13-
% **Details**
14-
% On [Month/Day/Year], a known issue was discovered that [description of known issue].
14+
% **Applicable versions for the known issue and the version for when the known issue was fixed**
15+
% On [Month Day, Year], a known issue was discovered that [description of known issue].
16+
% For more information, check [Issue #](Issue link).
1517

1618
% **Workaround**
1719
% Workaround description.
1820

19-
% **Resolved**
20-
% On [Month/Day/Year], this issue was resolved.
21-
2221
:::
2322

24-
APM has the following known issues:
25-
2623
:::{dropdown} prefer_ilm required in component templates to create custom lifecycle policies
2724

2825
*Elastic Stack versions: 8.15.1+*
@@ -65,6 +62,7 @@ POST /metrics-apm.transaction.1m-default/_rollover
6562
POST /metrics-apm.transaction.10m-default/_rollover
6663
POST /metrics-apm.transaction.60m-default/_rollover
6764
```
65+
6866
:::
6967

7068
:::{dropdown} Upgrading to v8.15.0 may cause APM indices to lose their lifecycle policy
@@ -91,10 +89,10 @@ Upgrading to 8.15.1 resolves the lifecycle issue for any new indices created for
9189
Default `<data_retention_period>` for each data stream is available in [this guide](docs-content://solutions/observability/apps/index-lifecycle-management.md).
9290
9391
This issue is fixed in 8.15.1 ([elastic/elasticsearch#112432](https://github.com/elastic/elasticsearch/pull/112432)).
92+
9493
:::
9594
9695
:::{dropdown} Upgrading to v8.13.0 to v8.13.2 breaks APM anomaly rules [broken-apm-anomaly-rule]
97-
9896
*Elastic Stack versions: 8.13.0, 8.13.1, 8.13.2*<br> *Fixed in Elastic Stack version 8.13.3*
9997
10098
This issue occurs when upgrading the Elastic Stack to version 8.13.0, 8.13.1, or 8.13.2. This issue may go unnoticed unless you actively monitor your {{kib}} logs. The following log indicates the presence of this issue:
@@ -217,7 +215,6 @@ There are three ways to fix this error:
217215
:::
218216

219217
:::{dropdown} Upgrading APM Server to 8.11+ might break event intake from older APM Java agents
220-
221218
*APM Server versions: >=8.11.0*<br> *Elastic APM Java agent versions: < 1.43.0*
222219

223220
If you are using APM Server (> v8.11.0) and the Elastic APM Java agent (< v1.43.0), the agent may be sending empty histogram metricsets.
@@ -231,7 +228,6 @@ The fix is to upgrade the Elastic APM Java agent to a version >= 1.43.0. Find de
231228
:::
232229

233230
:::{dropdown} traces-apm@custom ingest pipeline applied to certain data streams unintentionally
234-
235231
*APM Server versions: 8.12.0*<br>
236232

237233
If you’re using the Elastic APM Server v8.12.0, the `traces-apm@custom` ingest pipeline is now additionally applied to data streams `traces-apm.sampled-*` and `traces-apm.rum-*`, and applied twice for `traces-apm-*`. This bug impacts users with a non-empty `traces-apm@custom` ingest pipeline.
@@ -243,7 +239,6 @@ A fix was released in 8.12.1: [elastic/kibana#175448](https://github.com/elastic
243239
:::
244240

245241
:::{dropdown} Ingesting new JVM metrics in 8.9 and 8.10 breaks upgrade to 8.11 and stops ingestion
246-
247242
*APM Server versions: 8.11.0, 8.11.1*<br> *Elastic APM Java agent versions: 1.39.0+*
248243

249244
If you’re using the Elastic APM Java agent v1.39.0+ to send new JVM metrics to APM Server v8.9.x and v8.10.x, upgrading to 8.11.0 or 8.11.1 will silently fail and stop ingesting APM metrics.
@@ -270,7 +265,6 @@ A fix was released in 8.11.2: [elastic/kibana#171712](https://github.com/elastic
270265
:::
271266

272267
:::{dropdown} APM integration package upgrade through Fleet causes excessive data stream rollovers
273-
274268
*APM Server versions: <= 8.12.1 +*
275269

276270
If you’re upgrading APM integration package to any versions <= 8.12.1, in some rare cases, the upgrade fails with a mapping conflict error. The upgrade process keeps rolling over the data stream in an unsuccessful attempt to work around the error. As a result, many empty backing indices for APM data streams are created.
@@ -292,8 +286,7 @@ A fix was released in 8.12.2: [elastic/apm-server#12219](https://github.com/elas
292286
:::
293287

294288
:::{dropdown} Performance regression: APM issues too many small bulk requests for Elasticsearch output
295-
296-
*APM Server versions: >=8.13.0, <= 8.14.2*
289+
*APM Server versions: >=8.13.0, <= 8.14.2*<br>
297290

298291
If you’re on APM server version >=8.13.0, <= 8.14.2_, using Elasticsearch output, do not specify any `output.elasticsearch.flush_bytes`, and do not disable compression explicitly by setting `output.elasticsearch.compression_level` to `0`, APM server will issue smaller bulk requests of 24KB size, and more bulk requests will need to be made to maintain the original throughput. This causes Elasticsearch to experience higher load, and APM server may exhibit Elasticsearch backpressure symptoms.
299292

0 commit comments

Comments
 (0)