Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

apm-server: Remove server information endpoint POST / support #647

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

carsonip
Copy link
Member

@carsonip carsonip commented Mar 4, 2025

Corresponding code change: elastic/apm-server#15976
Issue elastic/apm-server#15965

Copy link
Member Author

@carsonip carsonip left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hold off from merging

kruskall
kruskall previously approved these changes Mar 4, 2025
% ::::

::::{dropdown} Change server information endpoint / to only accept GET and HEAD requests
Copy link
Member Author

@carsonip carsonip Mar 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In release-notes markdown, there's a comment

% Release notes include only features, enhancements, and fixes. Add breaking changes, deprecations, and known issues to the applicable release notes sections.
% For each new version section, include the Elastic APM and Kibana changes.

[to reviewer] so we're not supposed to mention breaking changes in release notes changelog, but only in this breaking changes section from now on? Asking as this is kind of different from what we did in <9.0. Also, there's no links to breaking changes from 9.0 release notes. I wonder if users would miss any breaking changes.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From @KOTungseth:

Correct—the new structure separates breaking changes from the release notes changelog. Moving forward, breaking changes should only be documented in the "Breaking Changes" section, not in the general release notes. Since breaking changes appear in the left nav in the release notes section of our new IA [this is just a subset of release-note-related content as we wait for the dev work to be done related to assembling docs from all repos together], users can easily navigate and view these pages.

@KOTungseth can you share a link to more details about the release note strategy with @carsonip when it's ready? 🙏

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@colleenmcginnis sgtm. I believe this PR aligns with the strategy. Feel free to review and merge it.

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions below.

@@ -17,12 +17,19 @@ To learn how to upgrade, check out <uprade docs>.
% **Action**<br> 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]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update this to make it easier to distinguish major/minor/patch.

Suggested change
## 9.0.0 [elastic-apm-900-breaking-changes]
## 9.0.0 [elastic-apm-9-0-0-breaking-changes]

% ## 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we ready to state the release date?

% ::::

::::{dropdown} Change server information endpoint / to only accept GET and HEAD requests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's a bit confusing in the dropdown title since we can't format as /.

image

What do you think about this instead?

Suggested change
::::{dropdown} Change server information endpoint / to only accept GET and HEAD requests
::::{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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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).

Comment on lines +33 to +34
**Action**<br> Update any existing usage of e.g. `POST /` to `GET /`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Impact**<br> Any methods other than GET and HEAD to `/` will return HTTP 405 Method Not Allowed.
**Action**<br> Update any existing usage of e.g. `POST /` to `GET /`.
**Impact**<br> Any methods other than `GET` and `HEAD` to `/` will return HTTP 405 Method Not Allowed.
**Action**<br> Update any existing usage, for example, update `POST /` to `GET /`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants