第1章 ヘルスチェックを使用してインスタンスステータスを追跡する
ヘルス REST エンドポイントを呼び出して、インスタンスの起動が完了し、リクエストを処理する準備ができているかどうかを確認します。
Red Hat build of Keycloak には、ヘルスチェックのサポートが組み込まれています。この章では、Red Hat build of Keycloak のヘルスチェックを有効にして使用する方法を説明します。Red Hat build of Keycloak ヘルスチェックは、デフォルトで管理ポート 9000
で公開されます。詳細は、管理インターフェイスの設定 を参照してください。
1.1. Red Hat build of Keycloak のヘルスチェックエンドポイント リンクのコピーリンクがクリップボードにコピーされました!
Red Hat build of Keycloak は、次の 4 つのヘルスエンドポイントを公開します。
-
/health/live
-
/health/ready
-
/health/started
-
/health
各エンドポイントの意味は、Quarkus SmallRye Health のドキュメント を参照してください。
これらのエンドポイントは、次のような JSON オブジェクトにより、成功した場合は HTTP ステータス 200 OK
、失敗した場合は 503 Service Unavailable
で応答します。
追加のチェックごとの情報を含まないエンドポイントの成功応答:
{ "status": "UP", "checks": [] }
{
"status": "UP",
"checks": []
}
データベース接続に関する情報を含むエンドポイントの成功応答: