Web系開発メモ

Java, JavaScript, CSS, HTML などの記事を書いています。

SpringBoot入門:アプリの管理やモニタリング

Spring Boot の Webアプリを、HTTP経由で管理したり、モニタリングする方法を書きます。今回は、Spring Boot の Actuator という機能を使います。

前提

この記事は、入門記事「JSONを返す」の資源(ビルドファイル、クラス等)を利用しています。必要に応じて参照して頂けると嬉しいです。

手順1. ビルドファイルの編集

記事「JSONを返す」で作成した pom.xml を編集して、dependenciesspring-boot-starter-actuator を追加します。

    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

手順2. 起動

次のコマンドでアプリを起動します。

gssb > mvn spring-boot:run

手順3. 確認

http://localhost:8080/health にアクセスすると、システムの状態を受け取ることができます。

{"status":"UP"}

補足. 他の機能について

他にも色々な機能がありそうです。

  • /dump:スレッドダンプを返却
  • /mappings@RequestMappings の path を返却
  • 等々

ただ、デフォルトだと機能が無効になっていて、アクセスするとエラーが返されるものが多いです。機能の一覧や、有効化の方法は、下のリンク先に書かれていました。

Spring Boot Actuator - Spring Boot リファレンス

本番運用する場合は、セキュリティ的なことも含めて、色々と検討したほうが良さそうです。

ソースコード

gssb - GitHub
※ プロジェクト名の gssb は、Getting Started Spring Boot の略です。