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

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

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

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

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

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

以上！！

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

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

1. Spring Boot とは

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

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

2. Spring Boot Actuatorとは

Actuator = 駆動装置？

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

2. Spring Boot Actuator とは Copyright © Acroquest Technology Co.,
Ltd. All rights reserved. 15 $ curl -XGET localhost:8080/actuator/health { "status": "UP" } 共通のプレフィックス(/actuator) の後ろにエンドポイント名をつける JSON形式

2. Spring Boot Actuator とは ◼ エンドポイント一覧 (2.0～) Copyright ©
Acroquest Technology Co., Ltd. All rights reserved. 16 auditevents beans caches conditions configprops env flyway health httptrace info integrationgraph loggers liquibase metrics mappings scheduledtasks sessions shutdown threaddump heapdump jolokia logfile prometheus

2. Spring Boot Actuator とは ◼ エンドポイント一覧 (2.0～) Copyright ©
Acroquest Technology Co., Ltd. All rights reserved. 17 auditevents beans caches conditions configprops env flyway health httptrace info integrationgraph loggers liquibase metrics mappings scheduledtasks sessions shutdown threaddump heapdump jolokia logfile prometheus ヘルスチェックスレッドダンプメトリクス (JVM情報など)

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

3. Actuator に触ってみよう

3. Actuatorに触ってみよう Copyright © Acroquest Technology Co., Ltd. All rights
reserved. 20 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> </dependency> pom.xml AutoConfiguration でエンドポイントが登録される

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

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

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

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

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

4. 開発に役立つ使い方

4. 開発に役立つ使い方それ、Actuatorで楽になれるよ実際に読み込まれたプロパティが分からない ⇒ env Controllerのどのメソッドがどのエンドポイントに対応しているか分からない ⇒ mappings
ログレベルを変えるのにいちいち再起動するのが面倒だ ⇒ loggers Copyright © Acroquest Technology Co., Ltd. All rights reserved. 28

4. 開発に役立つ使い方 ◼ env エンドポイント • アプリが読み込んだ環境変数やプロパティを一覧にして取得できる Copyright ©
Acroquest Technology Co., Ltd. All rights reserved. 30 { "activeProfiles": [ "mysql" ], "propertySources": [ { "name": "applicationConfig: [classpath:/application.properties]", "properties": { "management.endpoints.web.base-path": { "value": "/manage", "origin": "class path resource [application.properties]:18:36" } }

4. 開発に役立つ使い方 ◼ mapping エンドポイント • エンドポイントとControllerのメソッドとの対応関係を一覧で取得できる Copyright ©
Acroquest Technology Co., Ltd. All rights reserved. 32 "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": [] }

4. 開発に役立つ使い方 ◼ loggers エンドポイント • アプリケーションを動かしながら、ログレベルの取得と変更ができる ➢ /loggersでログレベルの一覧取得、/loggers/{ロガー名}で
特定のパッケージ・クラスに対するログレベルを取得 ➢ GETで取得、POSTで変更 ➢ ログレベルの変更は /loggers/{ロガー名} に対してのみ可能 (ログレベルをアプリ全体で変更する場合はROOTロガーのログレベルを変更する) Copyright © Acroquest Technology Co., Ltd. All rights reserved. 34

4. 開発に役立つ使い方 ◼ ログレベルの取得 Copyright © Acroquest Technology Co., Ltd.
All rights reserved. 35 $ curl -XGET localhost:8080/actuator/loggers/org.springframework { "configuredLevel": null, "effectiveLevel": "INFO" } 実際に適用されているログレベルは effectiveLevel

4. 開発に役立つ使い方 ◼ ログレベルの変更 Copyright © Acroquest Technology Co., Ltd.
All rights reserved. 36 # ログレベルを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のみリクエストに入れる

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

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

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

More Decks by Ryo Shindo

Other Decks in Programming

Featured

Transcript