Tomcatコミッタがお送りするちょっとマニアックなTomcatのコンフィグレーション10選

by kfujino

Slide 1

Slide 1 text

Slide 2

Slide 2 text

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

Slide 9

Slide 9 text

設定値を外部リソースから読み込む ● さらに、org.apache.tomcat.util.digester. PROPERTY_SOURCE=org.apache.tomcat.util.digester. EnvironmentPropertySourceをJavaオプションに指定するとプロセスの環境変数から取得することが可能 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 10

Slide 10 text

ポートオフセット ● 同一筐体で複数台のTomcatを立ち上げる際の良くやるやり方としてserver.xmlのport番号の設定だけ変更してTomcat を起動する。（バインド例外を避ける為） ● でも、複数あるport番号をちまちま変更するのは面倒 ● そんなときはポートオフセットを利用 ● offset分ずらした値でportを設定する。 ● 例えば、 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 11

Slide 11 text

Slide 12

Slide 12 text

Json Error Report ● Tomcatのエラーページ ○ デフォルト設定ではHTMLページをTomcatが組み立てて返却 ○ TomcatをAPIServerとして動作させる場合、HTMLが返却されると嬉しくないことがある。JSONでレシポンスを返して欲しい。 ○ そんなときは、エラーをHTMLページではなく、JSONデータで返すerrorReportValveを利用する Confidential Copyright ©︎ 2021 by Future Corporation

Slide 13

Slide 13 text

Slide 14

Slide 14 text

Slide 15

Slide 15 text

StuckThreadDetectionValve ● Tomcatを利用しているシステムのどこかわからんが処理がスタックしたり、レスポンスが遅延して返ってこないケース ● Javaだとスレッドダンプを取得してアナライザで解析 ● 発生時に即座にとれれば良いが。。 ● 依頼するにも再現させてなど、タイムリーにできない Confidential Copyright ©︎ 2021 by Future Corporation

Slide 16

Slide 16 text

StuckThreadDetectionValve ● そんなときは、StuckThreadDetectionValveを利用 ● StuckThreadDetectionValveはバックグラウンドでリクエスト処理スレッドを常に監視し、閾値を超えたリクエスト処理スレッドのスタックトレースを出力してくれる Confidential Copyright ©︎ 2021 by Future Corporation 閾値

Slide 17

Slide 17 text

Slide 18

Slide 18 text

Slide 19

Slide 19 text

Legacyアプリケーションベース ● javaEE→jakartaEEへのネームスペース変更のビックバンの影響（後述）で、javaEEを含むアプリケーションは Tomcat10では動かない。つまり、今Tomcat9等にデプロイしているアプリケーションはTomcat10では動かない。 ● 恒久対応としては、jakartaEEに対応したアプリにアップデートすること ● 暫定対応として、Host＃legacyAppBaseをアプリケーションディレクトリとして利用することが可能 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 20

Slide 20 text

Legacyアプリケーションベース ● Host#legacyAppBase指定したディレクトリ（デフォルト：webapps-javaee）にアプリケーションを配置するとマイグレーションツールが起動して、バイナリをjakartaEE 対応に変更してデプロイしてくれる ※他のEEコンテナは知らない。最初いろいろ議論していたが各コミュニティでその先どうなったかは不明 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 21

Slide 21 text

Slide 22

Slide 22 text

Slide 23

Slide 23 text

静的クラスタメンバーシップ ● Tomcatでクラスタ構成を組む場合、デフォルトのクラスタリングのメンバシップはマルチキャストを利用する ● Cloud環境等マルチキャストが使えないケースのクラスタメンバシップの組み方を二つ紹介 Confidential Copyright ©︎ 2021 by Future Corporation Tomcat1 Tomcat2 Tomcat3 マルチキャストAddr Group

Slide 24

Slide 24 text

静的クラスタメンバーシップ ● Staticメンバシップ ○ マルチキャストは動的にマルチキャストアドレスにジョインしてきたノードを登録するが、staticメンバシップはあらかじめクラスタメンバを定義する ○ 定義したクラスタメンバでクラスタを構成する ○ 定義した全てを起動しておく必要はなく、必要数分定義しておけば良い Confidential Copyright ©︎ 2021 by Future Corporation

Slide 25

Slide 25 text

静的クラスタメンバーシップ ● Staticメンバシップ Confidential Copyright ©︎ 2021 by Future Corporation Tomcat1 Static（Unicast Addr）Group メンバ定義 • Tomcat1 • Tomcat2 • Tomcat3 Tomcat2 メンバ定義 • Tomcat1 • Tomcat2 • Tomcat3 Tomcat3 メンバ定義 • Tomcat1 • Tomcat2 • Tomcat3

Slide 26

Slide 26 text

Slide 27

Slide 27 text

静的クラスタリングメンバーシップ ● 注意 ○ 当初から方針が大分変っているのでググって出る情報は古いものが多いので注意 ○ 詳解Tomcatでも古い方法で書かれている ○ StaticMembershipInterceptorでも出来るが非推奨、 LocalMember設定不要等 ○ IPをキャッシュしてしまうので、今度修正しておきます！ Confidential Copyright ©︎ 2021 by Future Corporation

Slide 28

Slide 28 text

Cloudクラスタメンバーシップ ● Cloudメンバシップ ○ kubernetes用のクラスタメンバシップ ○ DNSPingとKubePingの2実装（※後者を説明） ○ 別途kubernetesの環境が必要 ○ PodにCloudメンバシップを設定したTomcatインスタンスをデプロイ ○ KubePingを利用してダイナミックにクラスタメンバシップを構築する Confidential Copyright ©︎ 2021 by Future Corporation

Slide 29

Slide 29 text

Slide 30

Slide 30 text

Slide 31

Slide 31 text

Slide 32

Slide 32 text

組込みTomcatのコンフィグソース ● SpringBoot等に組込まれているTomcat ● SpringBoot専用機ではないので、だれでもnew Tomcat()で Tomcatインスタンスを作成できる。起動もできる。 ● とはいっても、new Tomcat()した後、どうやってTomcatをコンフィグするのかわからない ● 簡単なWebサーバならさっくっと出来るが、少し凝った設定をしているserver.xmlで構成されたTomcatを組込みで再現するのはなかなか大変 ● そんな時のコンフィグを二つ紹介 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 33

Slide 33 text

Slide 34

Slide 34 text

Slide 35

Slide 35 text

Slide 36

Slide 36 text

多言語化対応 ● Tomcatのログ等はその環境に合わせた言語で出力されます ● ただ、あらゆる言語を操るコミッタはいないので、コミュニティ全員で協力して多言語化を進めています ● そのツールとして、コミュニティではPOEditorを利用しています ● https://cwiki.apache.org/confluence/display/TOMCAT/M anaging+translations Confidential Copyright ©︎ 2021 by Future Corporation

Slide 37

Slide 37 text

Slide 38

Slide 38 text

多言語化対応 ● Tomcat translations projectにジョインして言語を選択することで手軽に翻訳が可能 ● ソースをハッキングしなくてもコミュニティ貢献が気軽に出来ます ● なのでTomcatのログの日本語がおかしかったらPOEditor経由で直して頂ければ、リリース時に反映されます ● 8割くらい私が勢いでやっているのでいろいろ問題あると思いますので気軽に修正してください Confidential Copyright ©︎ 2021 by Future Corporation

Slide 39

Slide 39 text

Slide 40

Slide 40 text

Tomcat10以降のバージョン体系 ● はじめに。知っておくこと１ ○ TomcatはJavaEEのサブセットをsupport ■ Tomcat7.0.x : support Java EE 6 ■ Tomcat8.5.x : support Java EE 7 ■ Tomcat9.0.x : support Java EE 8 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 41

Slide 41 text

Slide 42

Slide 42 text

Tomcat10以降のバージョン体系 ● JakartaEE8→JakartaEE9へのバージョンアップ ○ 仕様の追加云々はないが、めんどくさい ○ javax.* -> jakarta.* のネームスペースの変更 ○ 簡単にいうと、JavaEE8（JakartaEE8）のアプリケーションは JakartaEE9と互換性はない ○ つまり動かない。Java的に言うとClassNotFoundException Confidential Copyright ©︎ 2021 by Future Corporation

Slide 43

Slide 43 text

Tomcat10以降のバージョン体系 ● Tomcat10について ○ Tomcat10.0.xはJakartaEE9をサポートする ○ Tomcat9以前で稼働しているアプリケーションは Tomcat10では（マイグレーションしないと）動作しない ○ まぁいつかはマイグレーションはしないといけないので可能ならやりましょう。 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 44

Slide 44 text

Tomcat10以降のバージョン体系 ● Tomcat10を含めたサポート状況 ○ Tomcat7.0.x : support Java EE 6 ○ Tomcat8.5.x : support Java EE 7 ○ Tomcat9.0.x : support Java EE 8（JakartaEE8） ○ Tomcat10.0.x : support JakartaEE9 ● これが今現在の状態。まぁまだ分かる Confidential Copyright ©︎ 2021 by Future Corporation

Slide 45

Slide 45 text

Tomcat10以降のバージョン体系 ● では、JakartaEE10がリリースされるとどうなるか？ ○ Tomcat8.5.x : support Java EE 7 ○ Tomcat9.0.x : support Java EE 8 ○ Tomcat9.10.x : support Java EE 8 with Tomcat10 API ○ Tomcat10.0.x : EOL ○ Tomcat10.1.x : support JakartaEE10 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 46

Slide 46 text

Tomcat10以降のバージョン体系 ● では、JakartaEE11がリリースされるとどうなるか？ ○ Tomcat8.5.x : support Java EE 7 →多分EOL ○ Tomcat9.0.x : support Java EE 8 ○ Tomcat9.10.x : EOL ○ Tomcat9.11.x : support Java EE 8 with Tomcat11 API ○ Tomcat10.1.x : support JakartaEE10 ○ Tomcat11.0.x : support JakartaEE11 Confidential Copyright ©︎ 2021 by Future Corporation

Slide 47

Slide 47 text

Slide 48

Slide 48 text