Spring Boot Actuator additional health checks

Overview

Spring Boot Actuator Health Checks Starter provides additional health indicators for monitoring external services and dependencies:

Remote Spring Boot Actuator endpoints health check
HTTP endpoint availability check
TCP port availability check

Installation

Add the following dependency to your pom.xml:

<dependency>
    <groupId>org.alexmond</groupId>
    <artifactId>spring-boot-health-checks-starter</artifactId>
    <version>{page-component-version}</version>
</dependency>

Configuration

Actuator Health Check

Monitors health of remote Spring Boot Actuator endpoints.

management:
  health:
    actuator:
      sites:
        self:
          url: http://localhost:8080/actuator/health
          timeout: 10s
          interval: 1m

HTTP Health Check

Checks availability of HTTP endpoints.

management:
  health:
    http:
      sites:
        self:
          url: http://localhost:8080/actuator/info
          timeout: 10s
          interval: 1m
        self2:
          url: http://localhost:8080/actuator/info
          status: bad_request

Port Health Check

Verifies if TCP ports are accessible.

management:
  health:
    port:
      sites:
        database:
          host: db.example.com
          port: 5432
          timeout: 10s
          interval: 1m

Configuration Properties

Below you can find a list of configuration properties.

Table 1. Configuration Properties
Name	Default Value	Description
management.health.actuator.sites	{}	Map of site configurations where key is site identifier and value contains site-specific settings for actuator health checks.
management.health.http.sites	{}	Map of site configurations where key is site identifier and value contains site-specific settings for HTTP health checks.
management.health.port.sites	{}	Map of site configurations where key is site identifier and value contains port availability check settings.