For the latest stable version, please use Actuator extensions 4.1.1.4!

Spring Boot Actuator Extensions

1. Introduction

A collection of extensions and utilities for Spring Boot Actuator, providing enhanced monitoring and health check capabilities for your Spring Boot applications. These extensions help improve application observability and maintenance through comprehensive health checks and secure exposure of monitoring data.

2. Modules

2.1. spring-boot-health-checks

Extension module that provides additional health check indicators for comprehensive application monitoring (HTTP, Actuator, and Port status).

2.2. spring-boot-manual-health-starter

Provides a manual health endpoint to control application health status for graceful shutdown and service state control.

2.3. spring-boot-actuator-sanitizer

Utility library designed to sanitize sensitive information in actuator endpoint responses. This module helps ensure secure exposure of monitoring data by filtering out confidential details.

2.4. spring-boot-test-app

Sample Spring Boot application that demonstrates the practical usage of the actuator extensions. Use this module as a reference for implementing the extensions in your own applications.

3. Requirements

  • Java 17 or higher

  • Spring Boot 3.5.16

  • Maven build tool

4. Changelog

  • 3.5.16.3

    • Security: under a Turkish or Azerbaijani default locale the sanitizer left keys containing an upper-case I, such as MY.PRIVATE.VALUE, unmasked in /env and /configprops. Key matching is now locale-independent. Upgrade if your JVM may run with such a default locale.

    • Fixed health-manual under the same locales: it no longer rejects out_of_service in lower or mixed case (the status was set to UNKNOWN).

    • Fixed a connection leak in the external HTTP and actuator health indicators. Each check built an HTTP client and never closed it, so its keep-alive connection stayed open until garbage collection. The client is now closed after every check. Reported health details are unchanged.

    • This is the final release of the 3.5 line: open-source support for Spring Boot 3.5 has ended. Please move to the 4.x lines of these starters.

  • 3.5.16.2

    • The starters now ship spring-configuration-metadata.json, so IDEs complete and document their management.* properties. Earlier releases were built without it.

    • The build is now checked on JDK 17, 21 and 25.

  • 3.5.16.1

    • Upgraded Spring Boot to 3.5.16 (3.5 maintenance line).

  • 3.5.15.1

    • Upgraded Spring Boot to 3.5.15 (3.5 maintenance line).

    • Bumped JaCoCo to 0.8.15 and central-publishing-maven-plugin to 0.11.0; removed an unused property.

    • Added a branch input to the release workflow so releases can be cut from any branch.

    • Hardened a flaky external HTTP health-check test for hosts where an unroutable IP fails fast instead of timing out.

    • Adopted a Boot-tracking version scheme: the project version is now <spring-boot-version>.x (e.g. 3.5.15.1).

  • 1.0.5 Upgraded Spring Boot to 3.5.14 and updated dependencies.

  • 1.0.4

    • Upgraded Spring Boot to 3.5.10.

    • Refactored ManualHealthEndpoint: Unified status management into a single @WriteOperation, added @ReadOperation.

    • Fixed package naming typo from healchecks to healthchecks.

    • Improved ExternalHttpHealthIndicator and ExternalActuatorHealthIndicator with better timeout handling and edge case tests.

    • Fixed auto-configuration for spring-boot-manual-health-starter.

    • Improved project documentation and README.

  • 1.0.3 Upgraded spring boot to 3.5.8, and other dependencies

  • 1.0.2 Upgrade to Spring Boot 3.5.7. Added code coverage reporting and introduced two new configuration options for customizing sanitization by extending default key and pattern lists.