12.2. マイクロサービスのヘルスチェック

MicroProfile Health は、以下の 3 つのエンドポイントを提供します。

readiness または liveness ヘルスチェックを実装するには、コードに @Liveness または @Readiness アノテーションを追加します。これらのアノテーションは、提供されたエンドポイントを Kubernetes の liveness および readiness プローブにリンクします。

以下の例は、ヒープメモリーの使用状況をチェックする @Liveness アノテーションを示しています。メモリー消費が 90% 未満の場合は、UP ステータスを返します。メモリー使用量が 90% を超えると、DOWN ステータスが返されます。

@Liveness
@ApplicationScoped
public class MemoryCheck implements HealthCheck {
 @Override
 public HealthCheckResponse call() {
        // status is up if used memory is < 90% of max
        MemoryMXBean memoryBean = ManagementFactory.getMemoryMXBean();
        long memUsed = memoryBean.getHeapMemoryUsage().getUsed();
        long memMax = memoryBean.getHeapMemoryUsage().getMax();

        HealthCheckResponse response = HealthCheckResponse.named("heap-memory")
                .withData("used", memUsed)
                .withData("max", memMax)
                .state(memUsed < memMax * 0.9)
                .build();
        return response;
    }
}

以下の例は、ヒープメモリー使用量が 90% 未満の場合に /health/live エンドポイントからの JSON 応答を示しています。最初のステータスは、エンドポイントから返されるすべてのヘルスチェックの全体的なステータスを示します。2 つ目のステータスは、前述の name の値で指定された特定のチェックのステータスを示しています。この例では ヒープメモリー です。全体的なステータスが UP になるようにするには、エンドポイントで実行されるすべてのチェックに渡す必要があります。

{
  "status": "UP",
  "checks": [
    {
      "name": "heap-memory",
      "status": "UP",
      "data": {
        "used": "1475462",
        "max": ”51681681"
      }
    }
  ]
}

以下の例は、利用可能なデータベース接続をチェックする @Readiness アノテーションを示しています。接続に成功すると、UP ステータスが返されます。接続が利用できない場合は、DOWN のステータスを返します。

@Readiness
@ApplicationScoped
public class DatabaseReadyCheck implements HealthCheck {

    @Override
    public HealthCheckResponse call() {

        if (isDBConnected()) {
           return HealthCheckResponse.up(“databaseReady”);
        }
        else {
           return HealthCheckResponse.down(“databaseReady”);
        }
    }
}

以下の例は、データベース接続が利用できない場合に、/health/ready エンドポイントからの JSON 応答を示しています。最初のステータスは、エンドポイントから返されるすべてのヘルスチェックの全体的なステータスを示します。2 つ目のステータスは、前述の name の値で指定された特定のチェックのステータスを示しています。この例では databaseReady です。エンドポイントで実行されるチェックに失敗した場合、全体のステータスは DOWN になり ます。

{
  "status": ”DOWN",
  "checks": [
    {
      "name": ”databaseReady",
      "status": ”DOWN",
    }
  ]
}