ヘルスチェック機能の実装⚓︎

AlesInfiny Maia において定義しているヘルスチェックの実装例について説明します。

ヘルスチェック機能の概要については、ヘルスチェックの必要性 を参照してください。

ヘルスチェック機能の 2 種類のプローブ⚓︎

ヘルスチェック機能を実装する際、以下に示すいずれかの要素を確認することで正常に動作しているとみなすことができます。

• 活動性

  アプリがクラッシュしていたり、再起動の必要性が発生したりしていないこと。

• 対応性

  アプリが正常に動作していて、かつリクエストを受信する準備ができていること。

これら 2 つの要素を満たすため、 AlesInfiny Maia のサンプルアプリケーションでは活動性と対応性の状態をユーザーに渡す 2 種類のプローブを定義します。 詳細については 実装方針 に示します。

実装方針⚓︎

Spring Boot を用いた Web アプリケーションでは、 Spring Boot Actuator を利用することで比較適容易にヘルスチェック機能を実装可能です。 Spring Boot Actuator はアプリケーションレベルでサーバーを監視、管理する追加機能を提供するモジュールです。

AlesInfiny Maia ではこのモジュールを利用してヘルスチェック用のエンドポイントを作成することを推奨しています。 設定内容の詳細に関しては、サンプルアプリケーション内のプレゼンテーション層の application.properties を参照してください。

AlesInfiny Maia のサンプルアプリケーションでは、前節 で述べた通り活動性と対応性をそれぞれ満たす 2 つのプローブを実装しており、 以下のアドレスでヘルスチェックの状態を確認できます。

• 活動性のプローブ（http://localhost:8080/api/health/check）

  アプリが正常に動作していることを確認するためのプローブ。

• 対応性のプローブ（http://localhost:8080/api/health/datasource）

  データベースの正常動作によって、リクエストを受信する準備ができていることを確認するためのプローブ。

本ドキュメントにおける ヘルスチェックのレスポンス形式 に基づき、アクセスしたアドレスからの HTTP レスポンスは以下のように定義します。これにより、簡潔な形でサーバーの状態を把握できます。