28. X-MON のヘルスチェック

Ver 3.14.0 以降の X-MON において、GET リクエストを送ることにより X-MON のヘルスチェックを行うことができます。

本書における解説環境
X-MON ver 3.14.0

28.1. パスについて

以下のパスに GET リクエストを送ってください。

  • /health

  • /health/

28.2. 何をチェックするのか

X-MON による監視機能、および通知機能に異常がないかをチェックします。

具体的には、それら機能を構成する以下の4サービスを確認します。

  • X-MON

  • XmonAlertd

  • Redis

  • PostgreSQL

28.3. 受け付ける HTTP メソッドについて

GET リクエストのみを受け付けます。

POST, PUT, DELETE などのリクエストには 405 のステータスコードを返します。

28.4. レスポンスについて

  • MIME type は、 text/plain; charset=UTF-8 となります。

28.4.1. チェック対象のサービスがすべて正常に稼働している場合

  • 200 のステータスコードが返ります。

  • 出力はありません。

28.4.2. チェック対象のサービスに異常があった場合

  • 503 のステータスコードが返ります。

  • Service "ServiceName [, ServiceName ...]" unavailable という出力が返ります。

出力の例)

  • Service "X-MON" unavailable

  • Service "PostgreSQL, Redis, XmonAlertd" unavailable

Note

出力の形式は今後変更になる可能性があります。