10.3.3　ヘルスチェック

(a)　障害検知時に出力されるイベントプロパティ

障害イベント・回復イベントの発行時には，JSON形式のイベントプロパティを出力します。

ヘルスチェックの結果に応じて，出力するイベントプロパティは次のように異なります。

• イベントプロパティ（接続失敗またはデータ送受信失敗）

  {
   "type": "httprequest",
   "timestamp": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
   "succeeded": false,
   "port": 8080<リクエスト先のポート番号>,
   "virtualhost": "127.0.0.1",
   "method": "GET",
   "path": "*<Request-URIに指定するパス>",
   "errorkind": "connectfailure<エラー種別:connectfailureまたはiofailure>",
   "exceptionname": "xxx<発生した例外クラス名>",
   "exceptionmsg": "yyy<発生した例外メッセージ>"
  }

• イベントプロパティ（エラー応答）

  {
   "type": "httprequest",
   "timestamp": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
   "succeeded": false,
   "port": 8080<リクエスト先のポート番号>,
   "virtualhost": "127.0.0.1",
   "method": "GET",
   "path": "*<Request-URIに指定するパス>",
   "errorkind": "errorresponse",
   "statuscode": 500<ヘルスチェックレスポンスのステータスコード>
  }

• 成功イベントプロパティ

  {
   "type": "httprequest",
   "timestamp": "yyyy-MM-dd'T'HH:mm:ss.SSSXXX",
   "succeeded": true,
   "port": 8080<リクエスト先のポート番号>,
   "virtualhost": "127.0.0.1",
   "method": "GET",
   "path": "*<Request-URIに指定するパス>",
   "statuscode": 200<ヘルスチェックレスポンスのステータスコード>
  }

(b)　障害検知後のアクション

障害イベントの通知を受けた場合，デフォルトでは次のアクションを実行します。

• スナップショットログを収集します。

• Tomcatサーバプロセスの停止指示は出さないで処理を続行します。

アクションの変更方法については「(3)(b)　障害イベント・回復イベントの通知後の動作」を参照してください。

(a)　ヘルスチェックの監視設定

Tomcatプロセスモニタのconfig.properties（uCART設定ファイル）で，次に示す項目を設定できます。

• ヘルスチェックの有効／無効

• ヘルスチェックのインターバル

• ヘルスチェックHTTPリクエストのHTTP接続タイムアウト時間

• ヘルスチェックHTTPリクエストのHTTP読み込みタイムアウト時間

該当するプロパティと設定例を次に示します。この例ではデフォルト値を記載しています。

healthcheck.httprequest.enabled=true
healthcheck.httprequest.check.default.interval=30000
healthcheck.httprequest.check.default.connecttimeout=3000
healthcheck.httprequest.check.default.readtimeout=10000

config.properties（uCART設定ファイル）については，「12.2　config.properties（uCART設定ファイル）」を参照してください。

(b)　障害イベント・回復イベントの通知後の動作

障害イベント・回復イベントの通知後の動作は，config.properties（uCART設定ファイル）で変更できます。変更できる内容は次のとおりです。

• ユーザコマンドの実行

  ユーザコマンドを定義する場合は，別途「10.4　稼働監視機能の設定（ユーザコマンドの実行）」の定義が必要です。

• スナップショットログの収集有無

• Tomcatサーバプロセスの停止有無

config.properties（uCART設定ファイル）については，「12.2　config.properties（uCART設定ファイル）」を参照してください。

なお，障害イベント・回復イベントの通知時にアクションを実行する場合は，そのアクション実行時間が経過したあとにhealthcheck.httprequest.check.default.intervalで指定したインターバルを空けて次のヘルスチェックHTTPリクエストを送信します。

該当するプロパティと設定例を次に示します。この例では，「10.4　稼働監視機能の設定（ユーザコマンドの実行）」で設定する「ユーザコマンド定義のID」として，「exec1」「exec2」を設定しています。

• 接続失敗の検知の場合

  healthcheck.httprequest.actions.connectfailure.usercommand.idrefs.1=exec1
  healthcheck.httprequest.actions.connectfailure.snapshot=true
  healthcheck.httprequest.actions.connectfailure.terminate=false

• データ送受信失敗の検知の場合

  healthcheck.httprequest.actions.iofailure.usercommand.idrefs.1=exec1
  healthcheck.httprequest.actions.iofailure.snapshot=true
  healthcheck.httprequest.actions.iofailure.terminate=false

• レスポンスステータスコードによるエラー検知の場合

  healthcheck.httprequest.actions.errorresponse.usercommand.idrefs.1=exec1
  healthcheck.httprequest.actions.errorresponse.snapshot=true
  healthcheck.httprequest.actions.errorresponse.terminate=false

• 回復イベントに対するユーザコマンドを定義する場合

  healthcheck.httprequest.actions.recovery.usercommand.idrefs.1=exec2