Design Health, Readiness & Management Access

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36

package com.example.health;

import org.springframework.boot.actuate.health.Health;
import org.springframework.boot.actuate.health.HealthIndicator;
import org.springframework.stereotype.Component;

@Component("orderQueue")
public class OrderQueueHealthIndicator implements HealthIndicator {

    private final QueueClient queueClient;

    public OrderQueueHealthIndicator(QueueClient queueClient) {
        this.queueClient = queueClient;
    }

    @Override
    public Health health() {
        try {
            long lag = queueClient.getConsumerLag();
            if (lag > 10_000) {
                return Health.down()
                    .withDetail("reason", "Consumer lag exceeded threshold")
                    .withDetail("currentLag", lag)
                    .build();
            }
            return Health.up()
                .withDetail("consumerLag", lag)
                .withDetail("queueDepth", queueClient.getDepth())
                .build();
        } catch (Exception ex) {
            return Health.down(ex)
                .withDetail("error", "Failed to contact message broker")
                .build();
        }
    }
}

1
2
3
4
5
6
7
8
9
10

management:
  endpoint:
    health:
      probes:
        enabled: true
      group:
        readiness:
          include: "readinessState,db,orderQueue"
        liveness:
          include: "livenessState" # Strictly internal JVM state!

1
2
3
4
5
6
7
8
9
10
11
12

server:
  port: 8080 # Public HTTP API traffic

management:
  server:
    port: 8081 # Internal management traffic
    address: 127.0.0.1 # Bind strictly to loopback or VPC internal interface
  endpoints:
    web:
      exposure:
        include: "health,metrics,prometheus"
      base-path: "/actuator"