目次

• 前書き

• 変更内容

• はじめに

• 第1編　概要

  • 1.　概要

    • 1.1　本製品の目的

    • 1.2　本製品の概要

    • 1.3　本製品の前提条件

      • 1.3.1　インストールが必要なOS，OSSおよびJava VM

      • 1.3.2　Tomcatサーバプロセスの前提

      • 1.3.3　その他の注意事項

    • 1.4　本製品のユースケース

      • 1.4.1　オンプレミス環境またはオンプレミス相当のクラウド上仮想マシン環境の場合

      • 1.4.2　オートスケーリング構成のクラウド上仮想マシン環境の場合

      • 1.4.3　コンテナ仮想化環境の場合

• 第2編　オンプレミス環境・仮想マシン環境での設計・構築・運用

  • 2.　設計

    • 2.1　オンプレミス環境および仮想マシン環境共通の設計ポイント

      • 2.1.1　本製品による性能影響を確認する

      • 2.1.2　TomcatプロセスモニタのHTTP機能に対するセキュリティを確認する

      • 2.1.3　本製品によるリソース消費量を確認する

    • 2.2　オートスケーリング構成の仮想マシン特有の設計ポイント

      • 2.2.1　スナップショットログの出力先を不揮発なストレージに設定する

      • 2.2.2　オートスケーリンググループからの閉塞を高速化する

      • 2.2.3　スケールイン開始前にスナップショットログ出力処理時間分の猶予を設ける

  • 3.　構築

    • 3.1　セットアップの前提条件を確認する

    • 3.2　インストールする

    • 3.3　Tomcatに組み込む

  • 4.　運用

    • 4.1　システムを起動する

      • 4.1.1　本製品を組み込んだTomcatの起動方法

    • 4.2　システムを停止する

      • 4.2.1　本製品を組み込んだTomcatの停止方法

    • 4.3　設定を変更する

    • 4.4　オートスケーリング環境で運用する

    • 4.5　保守資料を収集する

    • 4.6　サポートサービスへ問い合わせる

    • 4.7　修正パッチを適用する

    • 4.8　アンセットアップする

• 第3編　コンテナ仮想化環境での設計・構築・運用

  • 5.　設計

    • 5.1　コンテナ仮想化環境共通の設計ポイント

      • 5.1.1　本製品による性能影響を確認する

      • 5.1.2　TomcatプロセスモニタのHTTP機能に対するセキュリティを確認する

      • 5.1.3　本製品によるリソース消費量を確認する

      • 5.1.4　スナップショットログの出力先を不揮発なストレージに設定する

    • 5.2　Kubernetesなどのコンテナオーケストレーションツール特有の設計ポイント

      • 5.2.1　コンテナの閉塞を高速化する

      • 5.2.2　スケールイン開始前にスナップショットログ出力処理時間分の猶予を設ける

  • 6.　構築

    • 6.1　セットアップの前提条件を確認する

    • 6.2　インストーラを準備する

    • 6.3　Dockerfileを作成する

    • 6.4　Dockerイメージをビルドする

  • 7.　運用

    • 7.1　システムを起動する

    • 7.2　システムを停止する

    • 7.3　設定を変更する

    • 7.4　Kubernetes環境で運用する

    • 7.5　保守資料を収集する

    • 7.6　サポートサービスへ問い合わせる

    • 7.7　修正パッチを適用したDockerイメージをビルドする

      • 7.7.1　修正パッチ適用前の前提条件を確認する

      • 7.7.2　修正パッチを適用したDockerfileを作成する

      • 7.7.3　修正パッチを適用したDockerイメージをビルドする

• 第4編　機能

  • 8.　Tomcatプロセスモニタ機能

    • 8.1　Tomcatプロセスモニタ機能の概要

    • 8.2　Tomcatプロセスモニタ機能の適用方法

    • 8.3　Tomcatプロセスモニタ機能の解除方法

    • 8.4　Tomcatプロセスモニタ機能適用後の終了ステータス

    • 8.5　自動でスナップショットログが収集されるタイミング

    • 8.6　Tomcatサーバプロセスの強制終了

    • 8.7　TomcatプロセスモニタのHTTP機能

    • 8.8　Tomcatプロセスモニタの一時領域

  • 9.　トレース機能

    • 9.1　トレース機能の概要

    • 9.2　トレース機能のセットアップ方法

    • 9.3　トレース機能のアンセットアップ方法

    • 9.4　サーバの開始時および終了時のトレース

    • 9.5　Webアプリケーションの開始時および終了時のトレース

    • 9.6　HTTPリクエストおよびサーブレット・フィルタのトレース

    • 9.7　HTTPセッションのトレース

    • 9.8　JAX-RSクライアントのトレース

    • 9.9　Tomcat JDBC Connection Poolのトレース

      • 9.9.1　javax.sql.DataSourceインターフェイスのトレース

      • 9.9.2　java.sql.Connectionインターフェイスのトレース

      • 9.9.3　java.sql.Statementのインターフェイスのトレース

      • 9.9.4　java.sql.PreparedStatementインターフェイスのトレース

      • 9.9.5　java.sql.CallableStatementインターフェイスのトレース

      • 9.9.6　Tomcat JDBC Connection Poolのトレース取得シーケンス

    • 9.10　ユーザ作成スレッドおよび非同期処理API利用上の注意事項

  • 10.　稼働監視機能

    • 10.1　稼働監視機能の概要

      • 10.1.1　稼働監視機能の位置づけ

      • 10.1.2　稼働監視機能の概要

      • 10.1.3　稼働監視機能の検知内容の出力（イベントプロパティ）

    • 10.2　稼働監視機能の設定（基本項目）

      • 10.2.1　Tomcatプロセスモニタ側の設定

      • 10.2.2　Tomcatサーバプロセスへの稼働監視用ライフサイクルリスナーの設定

    • 10.3　稼働監視機能の設定（監視項目）

      • 10.3.1　プロセスの起動監視

      • 10.3.2　ハートビート監視

      • 10.3.3　プロセス生存監視

      • 10.3.4　ヘルスチェック

      • 10.3.5　リクエスト処理の停滞監視

    • 10.4　稼働監視機能の設定（ユーザコマンドの実行）

  • 11.　統計情報出力機能

    • 11.1　統計情報出力機能の概要

      • 11.1.1　統計情報出力機能の前提条件

    • 11.2　統計情報出力機能のセットアップ方法

      • 11.2.1　server.xml（Tomcatのサーバ設定ファイル）を編集する

      • 11.2.2　config.properties（本製品の設定ファイル）を編集する

    • 11.3　統計情報出力機能のアンセットアップ方法

    • 11.4　統計情報出力機能の開始と終了

    • 11.5　統計情報出力機能のタイマースレッド

  • 12.　スナップショットログ収集機能

    • 12.1　スナップショットログ収集機能の概要

    • 12.2　スナップショットログの出力

      • 12.2.1　スナップショットログの出力先

      • 12.2.2　スナップショットログの出力形式

    • 12.3　スナップショットログの収集対象

      • 12.3.1　ファイルによる情報の収集

      • 12.3.2　コマンドの実行による情報の取得

    • 12.4　機密情報のマスキング

      • 12.4.1　定義情報のマスキング

      • 12.4.2　config.properties（本製品の設定ファイル）のマスキング

    • 12.5　スナップショットログの自動収集

      • 12.5.1　障害時の保守情報の収集

    • 12.6　スナップショットログの手動収集

      • 12.6.1　Tomcatプロセスモニタが稼働しているときの収集方法

      • 12.6.2　Tomcatプロセスモニタが稼働していないときの取得方法

      • 12.6.3　スナップショットログの多重実行に関する注意事項

      • 12.6.4　手動収集のユースケース

    • 12.7　スナップショットログの出力テスト

    • 12.8　ユースケース別の設定（自動収集・手動収集共通）

      • 12.8.1　収集対象を変更したい場合

      • 12.8.2　機密情報のマスキングルールを追加したい場合

      • 12.8.3　Context要素のaltDDNameを設定している場合

      • 12.8.4　monitor.tomcat.change.work.directory.enabledをfalseに変更している場合

      • 12.8.5　スレッドダンプの出力先を変更したい場合（日立JavaVM使用時）

      • 12.8.6　ログ出力先を<common.baseの指定値>以外に設定している場合

      • 12.8.7　同一環境で複数のTomcatプロセスモニタを動作させる場合

    • 12.9　ユースケース別の設定（自動収集）

      • 12.9.1　スナップショットログの出力先を変更したい場合

      • 12.9.2　Tomcatサーバプロセスの正常終了時にもスナップショットログを出力したい場合

      • 12.9.3　Tomcatサーバプロセスの停止要求時，停止する前にTomcat稼働中情報を取得したい場合

      • 12.9.4　稼働監視で障害を検知したときのTomcat稼働中情報取得時の条件をカスタマイズしたい場合

      • 12.9.5　スナップショットログの自動収集後に任意のコマンドを実行したい場合

      • 12.9.6　統計情報出力機能の初期化処理に失敗したときの，モニタ対象稼働中情報取得時の条件をカスタマイズしたい場合

      • 12.9.7　Context要素のantiResourceLockingをtrueに設定している場合

    • 12.10　ユースケース別の設定（手動収集）

      • 12.10.1　オプションの指定を省略したときのデフォルト値を変更したい場合

• 第5編　リファレンス

  • 13.　定義ファイル

    • 13.1　定義ファイルの種類

    • 13.2　config.properties（本製品の設定ファイル）

      • 13.2.1　形式

      • 13.2.2　ファイルの格納先，および格納先の変更方法

      • 13.2.3　機能

      • 13.2.4　指定可能なプロパティ

      • 13.2.5　ログ取得レベル

    • 13.3　setenv.sh（Tomcat起動時の環境変数定義ファイル）

      • 13.3.1　形式

      • 13.3.2　ファイルの格納先

      • 13.3.3　機能

      • 13.3.4　指定可能な環境変数

    • 13.4　catalina.properties（Tomcatのプロパティ定義ファイル）

    • 13.5　server.xml（Tomcatのサーバ設定ファイル）

    • 13.6　context.xml（Tomcatのコンテキスト設定ファイル）

  • 14.　ログファイル

    • 14.1　ログファイルの種類

    • 14.2　ログファイルの文字コード

    • 14.3　Tomcatプロセスモニタのログ

      • 14.3.1　メッセージログ

      • 14.3.2　保守ログ

      • 14.3.3　JavaVMログ

    • 14.4　Tomcatサーバプロセスのログ

      • 14.4.1　Tomcatトレースログ

      • 14.4.2　JavaVMログ

      • 14.4.3　統計情報ログ

  • 15.　メッセージ

    • 15.1　メッセージの形式

      • 15.1.1　メッセージの記述形式

      • 15.1.2　java.util.loggingのレベル

    • 15.2　メッセージの詳細

      • KDLR00000-E

      • KDLR00001-E

      • KDLR00100-I

      • KDLR00101-I

      • KDLR00102-I

      • KDLR00103-E

      • KDLR00104-E

      • KDLR00105-E

      • KDLR00106-E

      • KDLR00107-I

      • KDLR00108-E

      • KDLR00109-E

      • KDLR00110-E

      • KDLR00111-E

      • KDLR00112-E

      • KDLR00113-E

      • KDLR00200-E

      • KDLR00201-E

      • KDLR00202-E

      • KDLR00203-E

      • KDLR00204-E

      • KDLR00205-E

      • KDLR10000-I

      • KDLR10001-E

      • KDLR10002-I

      • KDLR10003-W

      • KDLR10004-W

      • KDLR10005-W

      • KDLR10006-W

      • KDLR10007-W

      • KDLR10008-W

      • KDLR10009-I

      • KDLR10010-I

      • KDLR10011-E

      • KDLR10012-E

      • KDLR10013-E

      • KDLR10014-E

      • KDLR10015-E

      • KDLR10016-E

      • KDLR10017-E

      • KDLR10018-I

      • KDLR10019-I

      • KDLR10020-E

      • KDLR10021-W

      • KDLR10022-E

      • KDLR10023-I

      • KDLR10024-I

      • KDLR10025-W

      • KDLR10026-I

      • KDLR10027-I

      • KDLR10028-W

      • KDLR10029-W

      • KDLR10030-E

      • KDLR10031-I

      • KDLR10037-I

      • KDLR10038-I

      • KDLR10039-E

      • KDLR10040-E

      • KDLR10041-W

      • KDLR10042-W

      • KDLR10043-W

      • KDLR10044-E

      • KDLR10045-E

      • KDLR10047-W

      • KDLR10050-E

      • KDLR10051-E

      • KDLR20100-I

      • KDLR20101-E

      • KDLR20102-E

      • KDLR20103-E

      • KDLR20105-E

      • KDLR20106-E

      • KDLR20200-I

      • KDLR20201-E

      • KDLR20202-E

      • KDLR20203-E

      • KDLR20204-E

      • KDLR20205-E

      • KDLR20206-E

      • KDLR20207-E

      • KDLR20208-E

      • KDLR20209-E

      • KDLR20210-I

      • KDLR20211-W

      • KDLR20214-W

      • KDLR20215-W

      • KDLR20216-W

      • KDLR20217-E

      • KDLR20218-I

      • KDLR20219-I

      • KDLR20220-W

      • KDLR20221-I

      • KDLR20222-I

      • KDLR20223-W

      • KDLR20224-I

      • KDLR20225-I

      • KDLR20226-I

      • KDLR20227-I

      • KDLR20228-E

      • KDLR20229-E

      • KDLR20230-W

      • KDLR20231-W

      • KDLR20232-W

      • KDLR30000-I

      • KDLR30001-E

      • KDLR30002-I

      • KDLR30003-E

      • KDLR30004-W

      • KDLR30005-W

      • KDLR40000-E

      • KDLR40001-W

      • KDLR40002-W

      • KDLR40003-I

      • KDLR40004-I

      • KDLR40005-I

      • KDLR40006-I

      • KDLR40007-E

      • KDLR40008-I

      • KDLR40009-E

      • KDLR40010-W

      • KDLR40012-E

      • KDLR40013-W

      • KDLR40014-I

      • KDLR40067-E

      • KDLR50000-I

      • KDLR50001-I

      • KDLR50002-E

      • KDLR50003-I

      • KDLR50004-I

      • KDLR50005-E

      • KDLR50007-E

      • KDLR50008-E

      • KDLR50009-E

      • KDLR99998-E

  • 16.　JavaVM起動オプション

    • 16.1　日立JavaVMを使用する場合

    • 16.2　他社製JavaVMを使用する場合

  • 17.　運用管理用コマンド

    • 17.1　運用管理用コマンドの概要

      • 17.1.1　運用管理用コマンド文法の記述形式

      • 17.1.2　運用管理用コマンドの入力形式

    • 17.2　スナップショットログ収集コマンド

      • 17.2.1　collect-snapshot.sh（スナップショットログ収集）

  • 18.　運用管理用REST API

    • 18.1　運用管理用REST APIの概要

      • 18.1.1　運用管理用REST APIの記述形式

    • 18.2　スナップショットログ収集REST API

      • 18.2.1　GETメソッド

  • 19.　ユーザアプリケーションで使用できるAPI

    • 19.1　ユーザアプリケーションで使用できるAPIの概要

      • 19.1.1　ユーザアプリケーションで使用できるAPIの記述形式

    • 19.2　性能解析トレースで使用するAPI

      • 19.2.1　getClientApInfoメソッド

      • 19.2.2　getPrfTraceメソッド

      • 19.2.3　getRootApInfoメソッド

• 付録

  • 付録A　GUIを使用したインストール

  • 付録B　GUIを使用したアンセットアップ

  • 付録C　本製品のアーカイブファイルを用いたインストールおよびアンセットアップ

  • 付録D　このマニュアルの参考情報

    • 付録D.1　関連マニュアル

    • 付録D.2　このマニュアルでの表記

    • 付録D.3　英略語

    • 付録D.4　KB（キロバイト）などの単位表記について

• 索引

ページの先頭へ