From 8daab7ebc5f54907c4460f3fbda26ad983970564 Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Wed, 19 Mar 2025 14:01:35 -0500 Subject: [PATCH 1/2] [DOCS] Cleans up release notes --- docs/release-notes/breaking-changes.md | 14 ++++----- docs/release-notes/deprecations.md | 29 ------------------- docs/release-notes/known-issues.md | 7 ++--- .../{index.md => release-notes.md} | 12 +++----- docs/release-notes/toc.yml | 2 +- 5 files changed, 13 insertions(+), 51 deletions(-) delete mode 100644 docs/release-notes/deprecations.md rename docs/release-notes/{index.md => release-notes.md} (87%) diff --git a/docs/release-notes/breaking-changes.md b/docs/release-notes/breaking-changes.md index b22c573b469..a05ee072b05 100644 --- a/docs/release-notes/breaking-changes.md +++ b/docs/release-notes/breaking-changes.md @@ -1,12 +1,9 @@ --- -navigation_title: "Elastic APM" +navigation_title: "Breaking changes" --- -# Elastic APM breaking changes - -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 out . +# Elastic APM breaking changes [elastic-apm-breaking-changes] +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 out [Upgrade](docs-content://solutions/observability/apps/upgrade.md). % ## Next version @@ -19,9 +16,8 @@ Before you upgrade, carefully review the Elastic APM breaking changes and take t % **Action**
Steps for mitigating deprecation impact. % :::: -## 9.0.0 [9-0-0] - -**Release date:** March 25, 2025 +## 9.0.0 [elastic-apm-900-breaking-changes] +**Release date:** April 2, 2025 ::::{dropdown} Change server information endpoint "/" to only accept GET and HEAD requests This will surface any agent misconfiguration causing data to be sent to `/` instead of the correct endpoint (for example, `/v1/traces` for OTLP/HTTP). diff --git a/docs/release-notes/deprecations.md b/docs/release-notes/deprecations.md deleted file mode 100644 index 3adc48a0080..00000000000 --- a/docs/release-notes/deprecations.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -navigation_title: "Elastic APM" ---- - -# Elastic APM deprecations - -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. - -% To learn how to upgrade, check out . - -% ## Next version -% **Release date:** Month day, year - -% ::::{dropdown} Deprecation title -% Description of the deprecation. -% For more information, check [PR #](PR link). -% **Impact**
Impact of deprecation. -% **Action**
Steps for mitigating deprecation impact. -% :::: - -% ## 9.0.0 [9-0-0] -% **Release date:** March 25, 2025 - -% ::::{dropdown} Deprecation title -% Description of the deprecation. -% For more information, check [PR #](PR link). -% **Impact**
Impact of deprecation. -% **Action**
Steps for mitigating deprecation impact. -% :::: \ No newline at end of file diff --git a/docs/release-notes/known-issues.md b/docs/release-notes/known-issues.md index 5d5e105fd67..c9a1c412909 100644 --- a/docs/release-notes/known-issues.md +++ b/docs/release-notes/known-issues.md @@ -2,10 +2,11 @@ mapped_pages: - https://www.elastic.co/guide/en/observability/current/apm-known-issues.html -navigation_title: "Elastic APM" +navigation_title: "Known issues" --- -# Elastic APM known issues +# Elastic APM known issues [elastic-apm-known-issues] +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. % Use the following template to add entries to this page. @@ -21,8 +22,6 @@ navigation_title: "Elastic APM" ::: -APM has the following known issues: - :::{dropdown} prefer_ilm required in component templates to create custom lifecycle policies *Elastic Stack versions: 8.15.1+* diff --git a/docs/release-notes/index.md b/docs/release-notes/release-notes.md similarity index 87% rename from docs/release-notes/index.md rename to docs/release-notes/release-notes.md index 101bc2c265b..0d0d02bdfe0 100644 --- a/docs/release-notes/index.md +++ b/docs/release-notes/release-notes.md @@ -5,8 +5,7 @@ mapped_pages: - https://www.elastic.co/guide/en/observability/master/release-notes-head.html --- -# Elastic APM release notes - +# Elastic APM release notes [elastic-apm-release-notes] Review the changes, fixes, and more in each version of Elastic APM. To check for security updates, go to [Security announcements for the Elastic stack](https://discuss.elastic.co/c/announcements/security-announcements/31). @@ -21,15 +20,12 @@ To check for security updates, go to [Security announcements for the Elastic sta % ### Fixes [elastic-apm-next-fixes] -## 9.0.0 [9-0-0] - +## 9.0.0 [elastic-apm-nodejs-agent-900-release-notes] **Release date:** March 25, 2025 -### Features and enhancements [9-0-0-features-enhancements] - +### Features and enhancements [elastic-apm-nodejs-agent-900-features-enhancements] * **Tail-based sampling**: Storage layer is rewritten to use Pebble database instead of BadgerDB. The new implementation offers a substantial throughput increase while consuming significantly less memory. Disk usage is significantly lower and more stable. See APM [Transaction sampling](docs-content://solutions/observability/apps/transaction-sampling.md) docs for benchmark details. ([#15235](https://github.com/elastic/apm-server/pull/15235)) -### Fixes [9-0-0-fixes] - +### Fixes [elastic-apm-nodejs-agent-900-fixes] * Fix overflow in validation of `apm-server.agent.config.cache.expiration` on 32-bit architectures. ([#15216](https://github.com/elastic/apm-server/pull/15216)) * Change permissions of `apm-server.yml` in `tar.gz` artifacts to `0600`. ([#15627](https://github.com/elastic/apm-server/pull/15627)) diff --git a/docs/release-notes/toc.yml b/docs/release-notes/toc.yml index a4100679473..3a5aab41ba2 100644 --- a/docs/release-notes/toc.yml +++ b/docs/release-notes/toc.yml @@ -1,5 +1,5 @@ toc: - - file: index.md + - file: release-notes.md - file: known-issues.md - file: breaking-changes.md - file: deprecations.md \ No newline at end of file From 0e78b45402fe0c1edd0e6cfca4e7126d12b77788 Mon Sep 17 00:00:00 2001 From: Kaarina Tungseth Date: Wed, 19 Mar 2025 14:03:59 -0500 Subject: [PATCH 2/2] Updates toc.yml --- docs/release-notes/toc.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/release-notes/toc.yml b/docs/release-notes/toc.yml index 3a5aab41ba2..bd9a7d2b88a 100644 --- a/docs/release-notes/toc.yml +++ b/docs/release-notes/toc.yml @@ -1,5 +1,4 @@ toc: - file: release-notes.md - file: known-issues.md - - file: breaking-changes.md - - file: deprecations.md \ No newline at end of file + - file: breaking-changes.md \ No newline at end of file