Spring Boot Actuatorの使い方
本記事ではSpring BootとGradleを使用しているプロジェクトでのSpring Boot Actuatorの設定方法と使い方をご紹介します。
Actuatorを使ったことがない、あるいは、Spring Bootの初心者向けの記事です。
Spring Boot Actuatorとは
Spring Boot Actuatorは、Spring Bootアプリケーションの運用時に役立つ機能を提供するモジュールのことです。
アプリケーションの監視、管理、デバッグなどで役立ちます。
Spring Boot Actuatorでは複数のエンドポイントが用意されており、
例えばhealthエンドポイントではアプリケーションが正常に動作しているかの情報を返します。
セットアップ方法と検証手順
今回はGradleを使用しているプロジェクトでのセットアップ手順を記載します。
Spring Boot プロジェクト内のbuild.gradleに依存関係を追加します。
dependencies {
implementation 'org.springframework.boot:spring-boot-starter-actuator'
}
追加後にGradleの読み込みを行うと、Actuatorのエンドポイントが有効になります。
ローカル環境で正常に稼働しているアプリケーションにactuatorの有効化し
http://localhost:8080/actuator/health へアクセスすると {"status":"UP"} というレスポンスが返されます。
ご自身の環境でactuatorを試す場合は アプリケーションのパスに /actuator/health を追加して確認してみてください。
health以外のエンドポイントの使用方法
actuatorには他にもエンドポイントが用意されているので、必要なものを利用することができます。
デフォルトで有効化されるのはhealthのエンドポイントのみです。
他のエンドポイントを使用する場合は別途設定が必要になため、公式ドキュメントの「2.1. エンドポイントを有効にする」以降を参照しapplication.properties を編集してみてください。
Discussion