actuatorで、Beanの依存関係を覗いたり、ヘルスチェックをしよう

spring-actuator は、システムの状態を確認するためのAPIを自動でアプリケーションに追加してくれます。

actuatorを依存に追加するだけで、以下のようなエンドポイントが追加されます。

  1. env : アプリケーションで使われている全プロパティの設定値を参照できる
  2. health : ヘルスチェック。RedisDB など、アプリケーションで使用しているサービス毎にStatusを表示。
  3. beans : DIコンテナに登録されている Bean の一覧と、その詳細情報(scopeやクラスパス)。
  4.  info: アプリケーションに対し、自由に記述できる情報。
  5. mappings : 外部に公開されているAPI一覧を返却します。
  6. httptrace : アプリケーションに過去に投げられたリクエスト群を返却します。

 

actuatorが提供するAPIは合計20種類以上あります。こちらのページに、追加されるエンドポイントが記述されております。

1. 依存関係を追加する

pom.xml に以下を追記します。

 

2. application.propertiesに公開したいエンドポイントを定義する。

セキュリティ上の理由などで、spring-actuatorが提供する全てのエンドポイントを公開したくない場合もあります。

公開しても良いエンドポイントを、application.propertiesに記述しましょう。

 

アプリケーションを起動し、http://localhost:8888/actuator/health に接続すると、ヘルスチェックが可能です。

http://localhost:8888/actuator/beans では、DIコンテナに存在するBean情報を取得できます。

自作したAPIのコントローラーのBean情報なども取得できます。

http://localhost:8888/actuator/env では、アプリケーション内の全てのproperty情報が取得できます。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です