From c9ba9e26b4c4e1149a53db294c40c01a21084538 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Tue, 4 Mar 2025 12:36:22 +0000 Subject: [PATCH 1/8] apm-server: Remove POST from server information API docs --- .../observability/apps/apm-server-information-api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/solutions/observability/apps/apm-server-information-api.md b/solutions/observability/apps/apm-server-information-api.md index 8e496fa15d..8987bdb800 100644 --- a/solutions/observability/apps/apm-server-information-api.md +++ b/solutions/observability/apps/apm-server-information-api.md @@ -16,11 +16,11 @@ This is the server information endpoint: http(s)://{hostname}:{port}/ ``` -Sending an `HTTP GET` or `HTTP POST` request to the server information endpoint will return an HTTP 200, indicating that the server is up. +Sending an `HTTP GET` request to the server information endpoint will return an HTTP 200, indicating that the server is up. To configure authenticated access to the APM server, the instructions at [APM API key](api-keys.md) or [APM Secret Token](secret-token.md), must be followed to configure the correct permissions for APM access. -If an [API keys](api-keys.md) or a [Secret token](secret-token.md) is passed along with the `HTTP GET` or `HTTP POST` request, in addition to an HTTP 200, the response payload will include some information about the APM server. +If an [API keys](api-keys.md) or a [Secret token](secret-token.md) is passed along with the `HTTP GET` request, in addition to an HTTP 200, the response payload will include some information about the APM server. ### Example: GET, without credentials [apm-api-info-example-get-without-credentials] @@ -48,12 +48,12 @@ curl --verbose -X GET http://127.0.0.1:8200 ``` -### Example: POST, with secret token [apm-api-info-example-post-with-secret-token] +### Example: GET, with secret token [apm-api-info-example-get-with-secret-token] -Example APM Server information request with POST, with a [Secret token](secret-token.md): +Example APM Server information request with GET, with a [Secret token](secret-token.md): ```sh -curl -X POST http://127.0.0.1:8200/ \ +curl -X GET http://127.0.0.1:8200/ \ -H "Authorization: Bearer secret_token" { From ef93d1462ecb112d01ad9943811345e87fdfff7c Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Tue, 4 Mar 2025 12:51:59 +0000 Subject: [PATCH 2/8] Add changelog to breaking change --- release-notes/breaking-changes/elastic-apm.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index ffb5c9bc88..e62e96c6e3 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -25,4 +25,11 @@ To learn how to upgrade, check out . % For more information, check [PR #](PR link). % **Impact**
Impact of the breaking change. % **Action**
Steps for mitigating deprecation impact. -% :::: \ No newline at end of file +% :::: + +% ::::{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, e.g. `/v1/traces` for OTLP/HTTP. +% For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). +% **Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. +% **Action**
Update any existing usage of e.g. `POST /` to `GET /`. +% :::: From 76c9c1561539521511d74e0e06f939912cef4b7c Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Wed, 5 Mar 2025 13:45:48 +0000 Subject: [PATCH 3/8] Uncomment breaking change --- release-notes/breaking-changes/elastic-apm.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index e62e96c6e3..10e508a66d 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -17,8 +17,8 @@ To learn how to upgrade, check out . % **Action**
Steps for mitigating deprecation impact. % :::: -% ## 9.0.0 [elastic-apm-900-breaking-changes] -% **Release date:** March 25, 2025 +## 9.0.0 [elastic-apm-900-breaking-changes] +**Release date:** March 25, 2025 % ::::{dropdown} Title of breaking change % Description of the breaking change. @@ -27,9 +27,9 @@ To learn how to upgrade, check out . % **Action**
Steps for mitigating deprecation impact. % :::: -% ::::{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, e.g. `/v1/traces` for OTLP/HTTP. -% For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). -% **Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. -% **Action**
Update any existing usage of e.g. `POST /` to `GET /`. -% :::: +::::{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, e.g. `/v1/traces` for OTLP/HTTP. +For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). +**Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. +**Action**
Update any existing usage of e.g. `POST /` to `GET /`. +:::: From de167ef5dccd9be3bd42c0d2d86b007103826caf Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Wed, 5 Mar 2025 13:50:24 +0000 Subject: [PATCH 4/8] Remove backticks as they are not supported in dropdown subject --- release-notes/breaking-changes/elastic-apm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index 10e508a66d..05b7b9d93b 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -27,7 +27,7 @@ To learn how to upgrade, check out . % **Action**
Steps for mitigating deprecation impact. % :::: -::::{dropdown} Change server information endpoint `/` to only accept GET and HEAD requests +::::{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, e.g. `/v1/traces` for OTLP/HTTP. For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). **Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. From b6e1c34ee5332f2d085778e41e5380c8307e1d77 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Mon, 10 Mar 2025 12:23:35 +0000 Subject: [PATCH 5/8] Update release-notes/breaking-changes/elastic-apm.md Co-authored-by: Colleen McGinnis --- release-notes/breaking-changes/elastic-apm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index 05b7b9d93b..ac4c164876 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -27,7 +27,7 @@ To learn how to upgrade, check out . % **Action**
Steps for mitigating deprecation impact. % :::: -::::{dropdown} Change server information endpoint / to only accept GET and HEAD requests +::::{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, e.g. `/v1/traces` for OTLP/HTTP. For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). **Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. From cb952360774b9a3da574fa9cbacbb0a893bb63dc Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Mon, 10 Mar 2025 12:25:00 +0000 Subject: [PATCH 6/8] Update release-notes/breaking-changes/elastic-apm.md Co-authored-by: Colleen McGinnis --- release-notes/breaking-changes/elastic-apm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index ac4c164876..5fcf29a305 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -28,7 +28,7 @@ To learn how to upgrade, check out . % :::: ::::{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, e.g. `/v1/traces` for OTLP/HTTP. +This will surface any agent misconfiguration causing data to be sent to `/` instead of the correct endpoint (for example, `/v1/traces` for OTLP/HTTP). For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). **Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. **Action**
Update any existing usage of e.g. `POST /` to `GET /`. From ecf3e36eeb4cdbdc4de67bb5aeeaab16adc9d370 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Mon, 10 Mar 2025 12:25:09 +0000 Subject: [PATCH 7/8] Update release-notes/breaking-changes/elastic-apm.md Co-authored-by: Colleen McGinnis --- release-notes/breaking-changes/elastic-apm.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index 5fcf29a305..10d250c00a 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -30,6 +30,6 @@ To learn how to upgrade, check out . ::::{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). For more information, check [PR #15976](https://github.com/elastic/apm-server/pull/15976). -**Impact**
Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed. -**Action**
Update any existing usage of e.g. `POST /` to `GET /`. +**Impact**
Any methods other than `GET` and `HEAD` to `/` will return HTTP 405 Method Not Allowed. +**Action**
Update any existing usage, for example, update `POST /` to `GET /`. :::: From 346af47538541d86fd8374f8e61f9b86ad4414a0 Mon Sep 17 00:00:00 2001 From: Carson Ip Date: Mon, 10 Mar 2025 12:25:18 +0000 Subject: [PATCH 8/8] Update release-notes/breaking-changes/elastic-apm.md Co-authored-by: Colleen McGinnis --- release-notes/breaking-changes/elastic-apm.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/release-notes/breaking-changes/elastic-apm.md b/release-notes/breaking-changes/elastic-apm.md index 10d250c00a..5fd06672ad 100644 --- a/release-notes/breaking-changes/elastic-apm.md +++ b/release-notes/breaking-changes/elastic-apm.md @@ -17,7 +17,7 @@ To learn how to upgrade, check out . % **Action**
Steps for mitigating deprecation impact. % :::: -## 9.0.0 [elastic-apm-900-breaking-changes] +## 9.0.0 [elastic-apm-9-0-0-breaking-changes] **Release date:** March 25, 2025 % ::::{dropdown} Title of breaking change