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

Slide 1

Slide 1 text

Slide 2

Slide 2 text

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

Slide 3

Slide 3 text

Slide 4

Slide 4 text

Slide 5

Slide 5 text

Slide 6

Slide 6 text

Slide 7

Slide 7 text

Slide 8

Slide 8 text

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

Slide 9

Slide 9 text

Slide 10

Slide 10 text

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

Slide 11

Slide 11 text

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

Slide 12

Slide 12 text

Slide 13

Slide 13 text

Slide 14

Slide 14 text

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

Slide 15

Slide 15 text

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

Slide 16

Slide 16 text

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

Slide 17

Slide 17 text

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

Slide 18

Slide 18 text

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

Slide 19

Slide 19 text

Slide 20

Slide 20 text

Slide 21

Slide 21 text

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)

Slide 22

Slide 22 text

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 のみが公開される。

Slide 23

Slide 23 text

Slide 24

Slide 24 text

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 のみポートを分けることも可能

Slide 25

Slide 25 text

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

Slide 26

Slide 26 text

Slide 27

Slide 27 text

Slide 28

Slide 28 text

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

Slide 29

Slide 29 text

Slide 30

Slide 30 text

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" } }

Slide 31

Slide 31 text

Slide 32

Slide 32 text

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

Slide 33

Slide 33 text

Slide 34

Slide 34 text

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

Slide 35

Slide 35 text

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

Slide 36

Slide 36 text

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