Skip to content

Add missing configuration metadata for "management.endpoint.health.probes.add-additional-paths"#30562

Closed
luozhenyu wants to merge 1 commit intospring-projects:2.6.xfrom
luozhenyu:actuator-metadata
Closed

Add missing configuration metadata for "management.endpoint.health.probes.add-additional-paths"#30562
luozhenyu wants to merge 1 commit intospring-projects:2.6.xfrom
luozhenyu:actuator-metadata

Conversation

@luozhenyu
Copy link
Copy Markdown
Contributor

@luozhenyu luozhenyu commented Apr 6, 2022

According to the documentation of spring-boot-actuator, we can define "management.endpoint.health.probes.add-additional-paths=true" to enable liveness and readiness. However, the configuration metadata for this is missing.

If your Actuator endpoints are deployed on a separate management context, the endpoints do not use the same web infrastructure (port, connection pools, framework components) as the main application. In this case, a probe check could be successful even if the main application does not work properly (for example, it cannot accept new connections). For this reason, is it a good idea to make the liveness and readiness health groups available on the main server port. This can be done by setting the following property:

management.endpoint.health.probes.add-additional-paths=true

https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#actuator.endpoints.kubernetes-probes

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Apr 6, 2022
luozhenyu added a commit to luozhenyu/spring-boot that referenced this pull request Apr 6, 2022
@luozhenyu
Add the missing configuration metadata for "management.endpoint.
f5ee8b4 
health.probes.add-additional-paths" in spring boot actuator
autoconfigure.

Closes spring-projectsgh-30562
@luozhenyu luozhenyu force-pushed the actuator-metadata branch from e666ea1 to f5ee8b4 Compare April 6, 2022 17:02
luozhenyu added a commit to luozhenyu/spring-boot that referenced this pull request Apr 6, 2022
@luozhenyu
Add the missing configuration metadata for 'management.endpoint.
6199db3 
health.probes.add-additional-paths' in spring boot actuator
autoconfigure.

Closes spring-projectsgh-30562
@luozhenyu luozhenyu force-pushed the actuator-metadata branch from f5ee8b4 to 6199db3 Compare April 6, 2022 17:04
luozhenyu added a commit to luozhenyu/spring-boot that referenced this pull request Apr 6, 2022
@luozhenyu
Add a configuration metadata in spring-boot-actuator-autoconfigure
2ea8fe3 
The configuration metadata of "management.endpoint.health.probes.
add-additional-paths" is missing.

Closes spring-projectsgh-30562
@luozhenyu luozhenyu force-pushed the actuator-metadata branch from 6199db3 to 2ea8fe3 Compare April 6, 2022 17:12
@luozhenyu luozhenyu changed the title Add the missing configuration metadata for add-additional-paths. Add the missing configuration metadata for "management.endpoint.health.probes.add-additional-paths". Apr 6, 2022
@luozhenyu luozhenyu marked this pull request as ready for review April 6, 2022 17:13
snicoll
snicoll reviewed Apr 7, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@snicoll snicoll left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. I've left a comment for your consideration.

I believe this change was introduced in 2.6.x so the current base branch doesn't look right.

Comment thread ...ator-autoconfigure/src/main/resources/META-INF/additional-spring-configuration-metadata.json
"description": "Whether to enable liveness and readiness probes.",
"defaultValue": false
},
{
Copy link
Copy Markdown
Member

@snicoll snicoll Apr 7, 2022

Choose a reason for hiding this comment

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

This should come before the previous entries as we sort them by alphabetical order.

Copy link
Copy Markdown
Contributor Author

@luozhenyu luozhenyu Apr 7, 2022

Choose a reason for hiding this comment

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

Thanks, I have rearranged it.

@snicoll snicoll added the status: waiting-for-feedback We need additional information before we can continue label Apr 7, 2022
@luozhenyu
Add a configuration metadata in spring-boot-actuator-autoconfigure
26e17e7 
The configuration metadata of "management.endpoint.health.probes.
add-additional-paths" is missing.

Closes spring-projectsgh-30562
@luozhenyu luozhenyu force-pushed the actuator-metadata branch from 2ea8fe3 to 26e17e7 Compare April 7, 2022 06:49
@luozhenyu luozhenyu changed the base branch from 2.5.x to 2.6.x April 7, 2022 06:49
@luozhenyu
Copy link
Copy Markdown
Contributor Author

luozhenyu commented Apr 7, 2022 •
edited
Loading

Thanks for the PR. I've left a comment for your consideration.

I believe this change was introduced in 2.6.x so the current base branch doesn't look right.

@snicoll You are right. I changed the base branch to2.6.x.

@spring-projects-issues spring-projects-issues added status: feedback-provided Feedback has been provided and removed status: waiting-for-feedback We need additional information before we can continue labels Apr 7, 2022
@snicoll snicoll added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged status: feedback-provided Feedback has been provided labels Apr 7, 2022
@snicoll snicoll self-assigned this Apr 7, 2022
@snicoll snicoll added this to the 2.6.7 milestone Apr 7, 2022
@snicoll snicoll changed the title Add the missing configuration metadata for "management.endpoint.health.probes.add-additional-paths". Add missing configuration metadata for "management.endpoint.health.probes.add-additional-paths" Apr 7, 2022
@snicoll snicoll mentioned this pull request Apr 7, 2022
Closed
snicoll pushed a commit that referenced this pull request Apr 7, 2022
@luozhenyu @snicoll
Add metadata for management.endpoint.health.probes.add-additional-paths
09daad0 
See gh-30562
@snicoll snicoll closed this in fa77e1c Apr 7, 2022
@snicoll
Copy link
Copy Markdown
Member

snicoll commented Apr 7, 2022

@luozhenyu thank you for the quick follow-up and for making your first contribution to Spring Boot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@snicoll snicoll snicoll left review comments

Assignees

@snicoll snicoll

Labels

type: documentation A documentation update

Projects

None yet

Milestone

2.6.7

Development

Successfully merging this pull request may close these issues.

3 participants

@luozhenyu @snicoll @spring-projects-issues