Document that Actuator endpoint may have at most one extension of each type #47740
+2
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spring-projects-issues
added
the
status: waiting-for-triage
wilkinsona
requested changes
Oct 21, 2025
| You can write technology-specific extensions by using javadoc:org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension[format=annotation] and javadoc:org.springframework.boot.actuate.endpoint.jmx.annotation.EndpointJmxExtension[format=annotation]. | ||
| These annotations let you provide technology-specific operations to augment an existing endpoint. | ||
|
|
||
| NOTE: As of now, it is possible to have only a single extension per an individual javadoc:org.springframework.boot.actuate.endpoint.annotation.Endpoint[format=annotation]. |
There was a problem hiding this comment.
Thanks for the PR but I don't think this is accurate as an individual endpoint can have both a Web extension and a JMX extension. It's only multiple JMX extensions or multiple Web extensions that are not supported.
There was a problem hiding this comment.
That is correct, thank you for the clarification, @wilkinsona. Changed the wording here.
Signed-off-by: mipo256 <mikhailpolivakha@email.com> Signed-off-by: Mikhail Polivakha <mikhailpolivakha@email.com>
wilkinsona
added
type: documentation
wilkinsona
requested changes
Oct 21, 2025
| You can write technology-specific extensions by using javadoc:org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension[format=annotation] and javadoc:org.springframework.boot.actuate.endpoint.jmx.annotation.EndpointJmxExtension[format=annotation]. | ||
| These annotations let you provide technology-specific operations to augment an existing endpoint. | ||
|
|
||
| NOTE: As of now, it is not possible to have multiple javadoc:org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension[format=annotation] or javadoc:org.springframework.boot.actuate.endpoint.jmx.annotation.EndpointJmxExtension[format=annotation] extensions per a single javadoc:org.springframework.boot.actuate.endpoint.annotation.Endpoint[format=annotation]. However, it is possible to have both javadoc:org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension[format=annotation] and javadoc:org.springframework.boot.actuate.endpoint.jmx.annotation.EndpointJmxExtension[format=annotation] for a single javadoc:org.springframework.boot.actuate.endpoint.annotation.Endpoint[format=annotation] |
There was a problem hiding this comment.
Rather than this note, I wonder if it would be better to add a sentence to the proceeding paragraph. Something like the following:
"An endpoint may have at most one extension of each type".
WDYT?
wilkinsona
added
the
status: waiting-for-feedback
snicoll
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.