目次

• 前書き

• 変更内容

• はじめに

• 第1編　概要

  • 1.　概要

    • 1.1　本製品の目的

    • 1.2　本製品の構成

    • 1.3　本製品の前提条件

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

      • 1.3.2　実行可能JAR/WAR形式およびWARデプロイ形式の前提条件

      • 1.3.3　その他の注意事項

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

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

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

      • 1.4.3　コンテナ仮想化環境のユースケース

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

  • 2.　オンプレミス環境・仮想マシン環境での設計（実行可能JAR/WAR形式）

    • 2.1　オンプレミス環境・仮想マシン環境共通の設計ポイントを確認する

      • 2.1.1　アクセスログを有効化する

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

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

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

    • 2.2　オートスケーリング構成の仮想マシン環境特有の設計ポイントを確認する

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

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

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

  • 3.　オンプレミス環境・仮想マシン環境での構築（実行可能JAR/WAR形式）

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

    • 3.2　インストールする

    • 3.3　インストールディレクトリ配下の所有グループを変更する

  • 4.　オンプレミス環境・仮想マシン環境での運用（実行可能JAR/WAR形式）

    • 4.1　システムを起動する

      • 4.1.1　本製品を組み込んだ実行可能JAR/WARの起動方法

    • 4.2　システムを停止する

      • 4.2.1　本製品を組み込んだ実行可能JAR/WARの停止方法

    • 4.3　設定を変更する

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

    • 4.5　保守資料を収集する

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

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

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

  • 5.　オンプレミス環境・仮想マシン環境での設計（WARデプロイ形式）

    • 5.1　オンプレミス環境・仮想マシン環境共通の設計ポイントを確認する

      • 5.1.1　アクセスログを有効化する

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

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

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

    • 5.2　オートスケーリング構成の仮想マシン環境特有の設計ポイントを確認する

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

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

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

  • 6.　オンプレミス環境・仮想マシン環境での構築（WARデプロイ形式）

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

    • 6.2　インストールする

    • 6.3　Tomcatに組み込む

  • 7.　オンプレミス環境・仮想マシン環境での運用（WARデプロイ形式）

    • 7.1　システムを起動する

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

    • 7.2　システムを停止する

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

    • 7.3　設定を変更する

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

    • 7.5　保守資料を収集する

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

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

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

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

  • 8.　コンテナ仮想化環境での設計（実行可能JAR/WAR形式）

    • 8.1　コンテナ仮想化環境共通の設計ポイントを確認する

      • 8.1.1　アクセスログを有効化する

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

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

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

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

    • 8.2　Kubernetesなどのコンテナオーケストレーションツール特有の設計ポイントを確認する

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

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

  • 9.　コンテナ仮想化環境での構築（実行可能JAR/WAR形式）

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

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

    • 9.3　Dockerfileを作成する

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

  • 10.　コンテナ仮想化環境での運用（実行可能JAR/WAR形式）

    • 10.1　システムを起動する

    • 10.2　システムを停止する

    • 10.3　設定を変更する

    • 10.4　Kubernetes環境で運用する

    • 10.5　保守資料を収集する

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

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

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

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

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

  • 11.　コンテナ仮想化環境での設計（WARデプロイ形式）

    • 11.1　コンテナ仮想化環境共通の設計ポイントを確認する

      • 11.1.1　アクセスログを有効化する

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

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

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

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

    • 11.2　Kubernetesなどのコンテナオーケストレーションツール特有の設計ポイントを確認する

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

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

  • 12.　コンテナ仮想化環境での構築（WARデプロイ形式）

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

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

    • 12.3　Dockerfileを作成する

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

  • 13.　コンテナ仮想化環境での運用（WARデプロイ形式）

    • 13.1　システムを起動する

    • 13.2　システムを停止する

    • 13.3　設定を変更する

    • 13.4　Kubernetes環境で運用する

    • 13.5　保守資料を収集する

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

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

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

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

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

• 第4編　機能

  • 14.　プロセスモニタ機能

    • 14.1　プロセスモニタ機能（実行可能JAR/WAR形式）

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

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

      • 14.1.3　プロセスモニタ機能の制限事項

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

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

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

      • 14.1.7　実行可能JAR/WARプロセスの強制終了

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

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

      • 14.1.10　プロセスモニタの起動スクリプト

    • 14.2　プロセスモニタ機能（WARデプロイ形式）

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

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

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

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

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

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

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

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

  • 15.　トレース機能

    • 15.1　トレース機能の概要

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

      • 15.2.1　実行可能JAR/WAR形式のセットアップ方法

      • 15.2.2　WARデプロイ形式のセットアップ方法

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

      • 15.3.1　実行可能JAR/WAR形式のアンセットアップ方法

      • 15.3.2　WARデプロイ形式のアンセットアップ方法

    • 15.4　トレース機能初期化処理のトレース

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

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

    • 15.7　Beanのトレース

    • 15.8　ApplicationContext初期化時および停止時のトレース

    • 15.9　HTTPリクエストのトレース

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

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

    • 15.12　RestTemplateのトレース

    • 15.13　WebClientのトレース

    • 15.14　データベースアクセスのトレース

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

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

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

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

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

    • 15.15　JdbcTemplateのトレース

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

  • 16.　稼働監視機能

    • 16.1　稼働監視機能の概要

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

      • 16.1.2　稼働監視機能の監視項目

      • 16.1.3　稼働監視で検知したイベントに対するアクション

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

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

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

      • 16.2.2　モニタ対象プロセスへの稼働監視用ライフサイクルリスナーの設定

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

      • 16.3.1　プロセス起動監視

      • 16.3.2　ハートビート監視

      • 16.3.3　プロセス生存監視

      • 16.3.4　ヘルスチェック

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

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

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

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

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

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

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

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

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

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

      • 17.3.3　その他の情報の取得

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

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

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

      • 17.4.3　アプリケーション設定値情報のマスキング

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

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

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

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

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

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

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

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

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

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

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

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

      • 17.8.4　monitor.tomcat.change.work.directory.enabledをfalseに変更している場合（WARデプロイ形式）

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

      • 17.8.6　ログの出力先を本製品のデフォルトの位置に設定しない場合

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

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

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

      • 17.9.2　モニタ対象プロセスの正常終了時にもスナップショットログを出力したい場合

      • 17.9.3　モニタ対象プロセスの停止要求時，停止する前にモニタ対象稼働中情報を取得したい場合

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

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

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

• 第5編　リファレンス

  • 18.　定義ファイル

    • 18.1　定義ファイルの種類

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

      • 18.2.1　形式

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

      • 18.2.3　機能

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

      • 18.2.5　ログ取得レベル

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

      • 18.3.1　形式

      • 18.3.2　ファイルの格納先

      • 18.3.3　機能

      • 18.3.4　指定可能な環境変数

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

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

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

  • 19.　ログファイル

    • 19.1　ログファイルの種類

    • 19.2　プロセスモニタのログ

      • 19.2.1　メッセージログ

      • 19.2.2　保守ログ

      • 19.2.3　標準出力ログ・標準エラー出力ログ

      • 19.2.4　JavaVMログ

    • 19.3　モニタ対象プロセスのログ

      • 19.3.1　トレースログ

      • 19.3.2　JavaVMログ

  • 20.　メッセージ

    • 20.1　メッセージの形式

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

      • 20.1.2　java.util.loggingのレベル

    • 20.2　メッセージの詳細

  • 21.　JavaVM起動オプション

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

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

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

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

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

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

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

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

  • 23.　運用管理用REST API

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

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

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

      • GETメソッド

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

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

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

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

      • getClientApInfoメソッド

      • getPrfTraceメソッド

      • getRootApInfoメソッド

• 付録

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

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

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

  • 付録D　HMP-ADIFとの連携

    • 付録D.1　本製品とHMP-ADIFを連携して使用した場合のユースケース

    • 付録D.2　連携手順

    • 付録D.3　相関ID機能との連携

    • 付録D.4　分散トレーシング機能との連携

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

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

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

    • 付録E.3　英略語

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

• 索引

ページの先頭へ