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

9b8f304ce234a4a8e38708247ffd68e0?s=47 Ryo Shindo
August 28, 2019

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

JSUG勉強会 2019その8 Spring for Beginner
https://jsug.doorkeeper.jp/events/95750

9b8f304ce234a4a8e38708247ffd68e0?s=128

Ryo Shindo

August 28, 2019
Tweet

Transcript

  1. 1.

    Copyright © Acroquest Technology Co., Ltd. All rights reserved. 1

    開発者のための Spring Boot Actuator入門 JSUG勉強会 2019その8 Acroquest Technology株式会社 進藤 遼
  2. 2.

    自己紹介 • 進藤 遼 • Acroquest Technology株式会社 • 日本Springユーザ会 スタッフ

    • Twitter: @shindo_ryo • Spring歴は約4年 • 最近はエンプラ系システムでアーキテクチャ設計やったり Goで分散トレーシングやったり。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 2
  3. 3.

    Acroquestのミッション・ビジョン Copyright © Acroquest Technology Co., Ltd. All rights reserved.

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

    Copyright © Acroquest Technology Co., Ltd. All rights reserved. 4

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

    Copyright © Acroquest Technology Co., Ltd. All rights reserved. 5

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

    アジェンダ 1. Spring Bootとは 2. Spring Boot Actuatorとは 3. Actuatorに触ってみよう

    4. 開発に役立つ使い方 ➢ env – アプリの設定の確認 ➢ mappings – ControllerとURLのマッピングの確認 ➢ loggers – ログレベルの確認/変更 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 8
  7. 10.

    Spring Bootとは・・・ • 重厚長大化したSpringプロジェクト群を使った 開発を簡単にはじめられる仕組み ✓ ただしシンプルであるとは言っていない (Simple is not

    Easy.) • AutoConfigurationの仕組みによって、Spring アプリケーションに必要な設定・Bean定義等を 大幅に省略することができる ✓ dependencyに追加するだけでデフォルト設定が効く ✓ 設定を変えたければ、プロパティを指定するか、自分で Bean定義を部分的に書く Copyright © Acroquest Technology Co., Ltd. All rights reserved. 10
  8. 11.

    本質ではないポイント • Uber jar (組み込みTomcat) ✓ Bootでもwarは作れる ✓ とはいえ、最近のWAFはほとんどExecutable Jarをつくる

    • ymlファイルで設定を書く ✓ .propertiesでも.ymlでも設定する内容は同じ ✓ xmlはほとんど書く必要はないが、必要であれば書くという 程度 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 11
  9. 14.

    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
  10. 15.

    2. Spring Boot Actuator とは Copyright © Acroquest Technology Co.,

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

    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
  12. 17.

    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情報など)
  13. 18.

    2. Spring Boot Actuator とは • メトリクス収集ライブラリのMicrometer との統合も可能 ➢ Boot

    2.0からはspring-boot-starter-actuatorに micrometerが含まれている • ただし今回は開発時に役立つActuatorの使い方を お話しします。 Copyright © Acroquest Technology Co., Ltd. All rights reserved. 18
  14. 20.

    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 で エンドポイントが登録される
  15. 21.

    3. Actuatorに触ってみよう Copyright © Acroquest Technology Co., Ltd. All rights

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

    3. Actuatorに触ってみよう 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 のみが公開される。
  17. 23.

    3. Actuatorに触ってみよう 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 23 application.yml shutdownの公開は別設定
  18. 24.

    3. Actuatorに触ってみよう 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 24 application.yml Actuator のみポートを分ける ことも可能
  19. 25.

    3. Actuatorに触ってみよう ◼ 注意事項 ✓ 本番環境にActuatorを適用する場合、 アクセス制御は必ずつけること ➢ アプリ本体と同様にSpring Securityで

    Actuatorエンドポイントを保護してください ✓ 実際に利用するエンドポイントのみ公開すること ➢ プロファイルで環境ごとに公開範囲を分ける ➢ Dev環境以外は思い切ってOFFにするのもあり Copyright © Acroquest Technology Co., Ltd. All rights reserved. 25
  20. 29.

    4. 開発に役立つ使い方 • お悩み① Copyright © Acroquest Technology Co., Ltd.

    All rights reserved. 29 実際に読み込まれたプロパティ/ 環境変数が分からない! デバッガで確認するのが大変!
  21. 30.

    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" } }
  22. 31.

    4. 開発に役立つ使い方 • お悩み② Copyright © Acroquest Technology Co., Ltd.

    All rights reserved. 31 どんなエンドポイントがあるのか 分からない! Controllerとの対応が 全然見えない!
  23. 32.

    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": [] }
  24. 33.

    4. 開発に役立つ使い方 • お悩み③ Copyright © Acroquest Technology Co., Ltd.

    All rights reserved. 33 ログレベルの設定が複雑で 最終的な結果が分からない・・・ ログレベルを変えるためだけに アプリを再起動するのが 面倒・・・
  25. 34.

    4. 開発に役立つ使い方 ◼ loggers エンドポイント • アプリケーションを動かしながら、ログレベルの 取得と変更ができる ➢ /loggersでログレベルの一覧取得、/loggers/{ロガー名}で

    特定のパッケージ・クラスに対するログレベルを取得 ➢ GETで取得、POSTで変更 ➢ ログレベルの変更は /loggers/{ロガー名} に対してのみ可能 (ログレベルをアプリ全体で変更する場合はROOTロガーの ログレベルを変更する) Copyright © Acroquest Technology Co., Ltd. All rights reserved. 34
  26. 35.

    4. 開発に役立つ使い方 ◼ ログレベルの取得 Copyright © Acroquest Technology Co., Ltd.

    All rights reserved. 35 $ curl -XGET localhost:8080/actuator/loggers/org.springframework { "configuredLevel": null, "effectiveLevel": "INFO" } 実際に適用されているログレベルは effectiveLevel
  27. 36.

    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のみ リクエストに入れる
  28. 39.

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

    Technology Copyright © Acroquest Technology Co., Ltd. All rights reserved. 39