開発者のためのSpring Boot Actuator入門 / jsug-2019-08

Copyright © Acroquest Technology Co., Ltd. All rights reserved. 1
開発者のための
Spring Boot Actuator入門
JSUG勉強会 2019その8
Acroquest Technology株式会社
進藤遼

View Slide

自己紹介
• 進藤遼
• Acroquest Technology株式会社
• 日本Springユーザ会スタッフ
• Twitter: @shindo_ryo
• Spring歴は約4年
• 最近はエンプラ系システムでアーキテクチャ設計やったり
Goで分散トレーシングやったり。

View Slide

Acroquestのミッション・ビジョン
テクノロジストチームとして
ビジネスの革新的価値創出に挑戦する
ビジョン
Acroquestの創り出す技術で
地球を感動で進化させる
ミッション

View Slide

Spring Boot 枠のセッションなので
Spring Boot の話をします

View Slide

https://speakerdeck.com/masatoshitada/spring-for-spring-boot-number-jsug

View Slide

以上！！

View Slide

（ここから真面目に話す）

View Slide

アジェンダ
1. Spring Bootとは
2. Spring Boot Actuatorとは
3. Actuatorに触ってみよう
4. 開発に役立つ使い方
➢ env – アプリの設定の確認
➢ mappings – ControllerとURLのマッピングの確認
➢ loggers – ログレベルの確認/変更

View Slide

1. Spring Boot とは

View Slide

Spring Bootとは・・・
• 重厚長大化したSpringプロジェクト群を使った
開発を簡単にはじめられる仕組み
✓ ただしシンプルであるとは言っていない (Simple is not Easy.)
• AutoConfigurationの仕組みによって、Spring
アプリケーションに必要な設定・Bean定義等を
大幅に省略することができる
✓ dependencyに追加するだけでデフォルト設定が効く
✓ 設定を変えたければ、プロパティを指定するか、自分で
Bean定義を部分的に書く

View Slide

本質ではないポイント
• Uber jar (組み込みTomcat)
✓ Bootでもwarは作れる
✓ とはいえ、最近のWAFはほとんどExecutable Jarをつくる
• ymlファイルで設定を書く
✓ .propertiesでも.ymlでも設定する内容は同じ
✓ xmlはほとんど書く必要はないが、必要であれば書くという
程度

View Slide

2. Spring Boot Actuatorとは

View Slide

Actuator = 駆動装置？

View Slide

2. Spring Boot Actuator とは
• 実行中のSpring Boot アプリケーションの
情報を取得するための機能
• アプリケーションに組み込むことで、アプリの設定や
メトリクスなどをHTTP/JMXで取得できるようになる
Spring Boot Application
Spring Boot Actuator
Env Metrics Health Beans
Thread
dump
HTTP
…
JMX

View Slide

$ curl -XGET localhost:8080/actuator/health
{
"status": "UP"
}
共通のプレフィックス(/actuator)
の後ろにエンドポイント名をつける
JSON形式

View Slide

◼ エンドポイント一覧 (2.0～)
auditevents
beans
caches
conditions
configprops
env
flyway
health
httptrace
info
integrationgraph
loggers
liquibase
metrics
mappings
scheduledtasks
sessions
shutdown
threaddump
heapdump
jolokia
logfile
prometheus

View Slide

◼ エンドポイント一覧 (2.0～)
auditevents
beans
caches
conditions
configprops
env
flyway
health
httptrace
info
integrationgraph
loggers
liquibase
metrics
mappings
scheduledtasks
sessions
shutdown
threaddump
heapdump
jolokia
logfile
prometheus
ヘルスチェック
スレッドダンプ
メトリクス
(JVM情報など)

View Slide

• メトリクス収集ライブラリのMicrometer
との統合も可能
➢ Boot 2.0からはspring-boot-starter-actuatorに
micrometerが含まれている
• ただし今回は開発時に役立つActuatorの使い方を
お話しします。

View Slide

3. Actuator に触ってみよう

View Slide


org.springframework.boot
spring-boot-starter-actuator

pom.xml
AutoConfiguration で
エンドポイントが登録される

View Slide

management:
endpoints:
web:
base-path: /manage
exposure:
include: '*'
exclude: flyway
endpoint:
shutdown:
enabled: true
server:
port: 8082
application.yml
Actuatorのエンドポイント共通
のプレフィックスを指定する
(デフォルトは /actuator)

View Slide

Copyright © Acroquest Technology Co., Ltd. All rights reserved.
management:
endpoints:
web:
base-path: /manage
exposure:
include: '*'
exclude: flyway
endpoint:
shutdown:
enabled: true
server:
port: 8082
22
application.yml
公開するエンドポイントを指定
する。
デフォルトではhealthとinfo
のみが公開される。

View Slide

management:
endpoints:
web:
base-path: /manage
exposure:
include: '*'
exclude: flyway
endpoint:
shutdown:
enabled: true
server:
port: 8082
23
application.yml
shutdownの公開は別設定

View Slide

management:
endpoints:
web:
base-path: /manage
exposure:
include: '*'
exclude: flyway
endpoint:
shutdown:
enabled: true
server:
port: 8082
24
application.yml
Actuator のみポートを分ける
ことも可能

View Slide

◼ 注意事項
✓ 本番環境にActuatorを適用する場合、
アクセス制御は必ずつけること
➢ アプリ本体と同様にSpring Securityで
Actuatorエンドポイントを保護してください
✓ 実際に利用するエンドポイントのみ公開すること
➢ プロファイルで環境ごとに公開範囲を分ける
➢ Dev環境以外は思い切ってOFFにするのもあり

View Slide


View Slide

Spring Bootで開発していると、こんな悩みありますよね？
実際に読み込まれたプロパティが分からない
Controllerのどのメソッドがどのエンドポイント
に対応しているか分からない
ログレベルを変えるのにいちいち再起動
するのが面倒だ

View Slide

それ、Actuatorで楽になれるよ
実際に読み込まれたプロパティが分からない
⇒ env
Controllerのどのメソッドがどのエンドポイント
に対応しているか分からない
⇒ mappings
ログレベルを変えるのにいちいち再起動
するのが面倒だ
⇒ loggers

View Slide

• お悩み①
実際に読み込まれたプロパティ/
環境変数が分からない！
デバッガで確認するのが大変！

View Slide

◼ env エンドポイント
• アプリが読み込んだ環境変数やプロパティを一覧にして
取得できる
{
"activeProfiles": [
"mysql"
],
"propertySources": [
{
"name": "applicationConfig: [classpath:/application.properties]",
"properties": {
"management.endpoints.web.base-path": {
"value": "/manage",
"origin": "class path resource [application.properties]:18:36"
}
}

View Slide

• お悩み②
どんなエンドポイントがあるのか
分からない！
Controllerとの対応が
全然見えない！

View Slide

◼ mapping エンドポイント
• エンドポイントとControllerのメソッドとの対応関係を
一覧で取得できる
"dispatcherServlet": [
{
“handler”: “public StringOwnerController.processCreationForm(Owner,BindingResult)",
"predicate": "{POST /owners/new}",
"details": {
"handlerMethod": {
"className": "org.springframework.samples.petclinic.owner.OwnerController",
"name": "processCreationForm",
},
"requestMappingConditions": {
"methods": ["POST"],
"params": [],
"patterns": ["/owners/new"],
"produces": []
}

View Slide

• お悩み③
ログレベルの設定が複雑で
最終的な結果が分からない・・・
ログレベルを変えるためだけに
アプリを再起動するのが
面倒・・・

View Slide

◼ loggers エンドポイント
• アプリケーションを動かしながら、ログレベルの
取得と変更ができる
➢ /loggersでログレベルの一覧取得、/loggers/{ロガー名}で
特定のパッケージ・クラスに対するログレベルを取得
➢ GETで取得、POSTで変更
➢ ログレベルの変更は /loggers/{ロガー名} に対してのみ可能
(ログレベルをアプリ全体で変更する場合はROOTロガーの
ログレベルを変更する)

View Slide

◼ ログレベルの取得
$ curl -XGET localhost:8080/actuator/loggers/org.springframework
{
"configuredLevel": null,
"effectiveLevel": "INFO"
}
実際に適用されているログレベルは
effectiveLevel

View Slide

◼ ログレベルの変更
# ログレベルをDEBUGに変更
$ curl -XPOST localhost:8080/actuator/loggers/org.springframework
-H ‘Content-Type: application/json’ –d ‘{“configuredLevel”: “DEBUG”}’
$ curl -XGET localhost:8080/actuator/loggers/org.springframework
{"configuredLevel":"DEBUG","effectiveLevel":"DEBUG"}
ConfiguredLevelのみ
リクエストに入れる

View Slide

• (余談)curl が面倒であればSpring Boot Adminを
使うのもありかも・・・
(時間があればデモします)

View Slide

まとめ
✓ Spring Boot Actuatorでアプリの情報を
簡単に取得できる！
✓ dependencyを追加するだけで適用できる！
✓ 運用だけじゃなくて開発にも役立つよ！

View Slide

Enjoy your Bootiful Life!!
Evolve the Earth with Emotion of Technology

View Slide

開発者のためのSpring Boot Actuator入門 / jsug-2019-08

開発者のためのSpring Boot Actuator入門 / jsug-2019-08

Ryo Shindo

More Decks by Ryo Shindo

Other Decks in Programming

Featured

Transcript