Spring Boot Actuatorを使ったヘルスチェック用APIの実装

どうも高妻です。Twitterでプログラミングのことや暗号通貨のことをつぶやいているのでよかったらフォローしてください。Follow @Tomokazu106

Spring Boot Actuatorとは

Spring Bootのプラグインで導入するだけでヘルスチェックのエンドポイントを追加できます。

Spring Boot Actuatorのドキュメントはこちら

インストール

gradleでのインストールはbuild.gradleに下記を追加してください。

dependencies {
	compile('org.springframework.boot:spring-boot-starter-actuator')
}

dependencies {

compile('org.springframework.boot:spring-boot-starter-actuator')

}

これだけで/healthというパスでAPIが作られてヘルスチェック用に使えます。

エンドポイントの種類

エンドポイントは最大20個あり、ヘルスチェック以外にアプリケーションの情報を取得することができます。

詳細情報：https://docs.spring.io/spring-boot/docs/current-SNAPSHOT/reference/htmlsingle/#production-ready-endpoints

独自にヘルスチェックのエンドポイントを設定することもできますがあまりそのような場面はないのでデフォルト設定で問題ないかと思います。

この記事を書いた人
最新の記事

高妻智一

2013年CyberAgent新卒入社スマホゲームを作る子会社に所属し、サーバーサイドのエンジニアを担当。２年目の終わりから新規子会社の立ち上げに参加し、サーバーサイドのエンジニアリーダーとしてサービースのリリースから運用までを担当。現在はTwitterなどSNSのテキスト解析を行うソーシャルメディア分析のサーバーサイドを開発中。言語はNode.js、Kotlinを使用。