Skip to content

Retain default group membership when configuring other properties on probe health groups #40268

@tharakadesilva

Description

@tharakadesilva

When configuring additional paths for Spring Boot actuator health groups ('readiness', 'liveness', etc.), unrelated health indicators to those groups unexpectedly start failing. This behavior presents risks for production environments, potentially leading to unnecessary restarts or pod terminations.

Impact:

This issue introduces the risk of unnecessary pod restarts or service disruptions within environments using health endpoints for availability checks (e.g., Kubernetes). A failing health indicator on one path could lead to cascading failures within liveness or readiness probes.

Steps to reproduce:

  1. Bootstrap a new project with SpringBoot 3.2.4.

  2. Create a custom health indicator that always reports "DOWN":

    @Bean
    HealthIndicator myHealthIndicator() {
      return () -> Health.down().build();
    }
  3. Add an additional paths to the readiness and liveness groups:

    management.endpoint.health.group.readiness.additional-path=server:/readyz
    management.endpoint.health.group.liveness.additional-path=server:/livez
    

Expected behavior (and this works without the additional path configs in step (3)):

  • /actuator/health - should fail
  • /actuator/health/readiness - should pass
  • /readyz - should pass
  • /actuator/health/liveness - should pass
  • /livez - should pass

Actual behavior:

  • /actuator/health - fails
  • /actuator/health/readiness - fails (unexpectedly)
  • /readyz - fails (unexpectedly)
  • /actuator/health/liveness - fails (unexpectedly)
  • /livez - fails (unexpectedly)

I would have expected readiness and livenss to have failed if I only set the following props:

management.endpoint.health.group.readiness.include=my
management.endpoint.health.group.liveness.include=my

Demo Project (see tests):

demo.zip

Potential Workaround (Temporary):

Avoid using additional-path on health groups where this side-effect could be disruptive.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions