10. 診断サービス

10.1. 診断サービスの設定

診断サービスで収集される情報には大きく分けて次のような種類があります。それぞれの種類は、複数の項目を保持しています。 収集情報の種類と、各収集項目は、収集する・収集しないを設定することができ、収集情報の種類が「収集する」という設定になっている場合のみ、 各項目を収集できます。既定値は、○が収集されること、×が収集されないことを表しています。

属性のDottedName：server.diagnostic-service

• (注1) Java VM のメモリ：ローカルモードの場合は、エージェントプロセスが起動している場合のみ、収集することができます。
• (注2) Java VM のスレッドダンプ：OS毎に次のような制限があります。
  Windows：エージェントプロセスに接続できない場合は、WebOTX AS をJavaSE6で起動している場合のみ、収集することができます。
  UNIX：server.logにスレッドダンプが出力されるため、server.logが収集されます。

システム情報

WebOTX AS が稼動しているサーバマシンのオペレーティングシステムの情報を収集します。収集する情報の詳細は以下のような項目になります。 これらの情報を収集するためには、システム情報の属性値が trueになっている必要があります。trueへの変更の仕方は、2章を参照してください。 システム情報は、あらかじめ存在する情報ではないため、診断サービス実行時に、各OS用のスクリプトファイルを実行して情報採取を行い、診断レポートに含めます。

属性のDottedName：server.diagnostic-service

インストール情報

WebOTX AS のインストールに関する情報を収集します。収集する情報の詳細は以下のような項目になります。 これらの情報を収集するためには、インストール情報の属性値がtrueになっている必要があります。 trueへの変更の仕方は、3章を参照してください。 インストール情報のうち、OSの環境変数、WebOTX AS に関する情報、WebOTX AS インストールディレクトリ配下のファイル一覧については、 診断サービス実行時に、各OS用のスクリプトファイルを実行して情報採取を行い、診断レポートに含めます。

属性のDottedName：server.diagnostic-service

コンフィグレーション情報

ドメインの設定に関する情報を収集します。収集する情報の詳細は以下のような項目になります。 これらの情報を収集するためには、コンフィグレーション情報の属性値がtrueになっている必要があります。trueへの変更の仕方は、2章を参照してください。 コンフィグレーション情報では、収集される情報は全てあらかじめ存在するファイルであり、診断サービスの実行時に新しく採取される情報はありません。 また、収集リスト・除外リストについては、「2.2.8 収集リスト・除外リストについて」を参照してください。

属性のDottedName：server.diagnostic-service

• (注) configディレクトリをルートディレクトリとした相対パスで記入してください。 リストに記入されたファイルは、他の設定項目よりも優先されます。また、パスの区切りは、統合運用管理ツールでは/または\で、運用管理コマンドでは/または\\で記入してください。

配備アプリケーション情報

配備アプリケーションに関する情報を収集します。収集する情報の詳細は以下のような項目になります。 これらの情報を収集するためには、配備アプリケーション情報の属性値がtrueになっている必要があります。trueへの変更の仕方は、2章を参照してください。 配備アプリケーション情報では、収集される情報は全てあらかじめ存在するファイルであり、 新しく診断実行時に採取される情報はありません。また、収集リスト・除外リストについては、「2.2.8 収集リスト・除外リストについて」を参照してください。

属性のDottedName：server.diagnostic-service

• (注1) applicationsディレクトリの場所が、インストール時の状態から変更されていない場合のみ収集が可能となります。
• (注2) applicationsディレクトリ、またはgeneratedディレクトリを含めた相対パスで記入してください。 リストに記入されたファイルは、他の設定項目よりも優先されます。また、パスの区切りは、統合運用管理ツールでは/または\で、運用管理コマンドでは/または\\で記入してください。
  例）generated/ejb\j2ee-apps/__JWSappclients

ログ情報

診断対象ドメインのログを収集します。収集する情報の詳細は以下のような項目になります。これらの情報を収集するためには、 ログ情報の属性値がtrueになっている必要があります。trueへの変更の仕方は、2章を参照してください。 ログ情報では、収集される情報は全てあらかじめ存在するファイルであり、新しく診断実行時に採取される情報はありません。 また、収集リスト・除外リストについては、「2.2.8 収集リスト・除外リストについて」を参照してください。

属性のDottedName：server.diagnostic-service

• (注1) 収集対象となるのは、現時点から入力された数値の時間内に更新されたログファイルとなります。
  たとえば、72と入力した場合は、現在から72時間以内に更新されたログファイルが収集されます。
  これは、過去3日間に更新されたログファイルを収集することに相当します。
• (注2)logsディレクトリをルートディレクトリとした相対パスで記入してください。
  リストに記入されたファイルは、他の設定項目よりも優先されます。また、パスの区切りは、統合運用管理ツールでは/または\で、運用管理コマンドでは/または\\で記入してください。

モニタリング情報

モニタリング（統計）情報を収集します。収集する情報の詳細は以下のような項目になります。これらの情報を収集するためには、 モニタリング情報の属性値がtrueになっている必要があります。trueへの変更の仕方は、2章を参照してください。 モニタリング情報は、あらかじめ存在する情報ではないため診断サービス実行時に情報採取を行い、診断レポートに含めます。この情報採取では、MBeanを使用しているため ローカルモードで実行した場合は採取できないことがあります。 ローカルモードで実行した場合は、エージェントプロセスが起動しており、かつ診断対象ドメインへ同じクライアント端末からログイン している場合のみ、情報を取得することができます。

• (注) 管理ドメインWebOTXAdminの場合は、デフォルトではモニタリング情報は何も採取されないため、結果のファイルには何も出力されません。

Java VM 情報

診断対象ドメインのJava VM に関する情報を収集します。収集する情報の詳細は以下のような項目になります。これらの情報を収集するためには、 Java VM 情報の属性値がtrueになっている必要があります。trueへの変更の仕方は、2章を参照してください。 Java VM 情報は、あらかじめ存在する情報ではないため、診断サービス実行時に情報採取を行い、診断レポートに含めます。 この情報採取には、一部MBeanを使用しているため、ローカルモードで実行した場合は採取できない情報があります。

属性のDottedName：server.diagnostic-service

• (注1) Java VM のメモリ：ローカルモードの場合は、エージェントプロセスが起動しており、診断対象ドメインに同じクライアント端末から ログインしている場合のみ、収集することができます。
• (注2) Java VM のスレッドダンプ：OS毎に次のような制限があります。
  Windows：エージェントプロセスに接続できない場合は、WebOTX Application Server をJavaSE6で起動している場合のみ、収集することができます。
  UNIX：server.logにスレッドダンプが出力され、server.logが収集されます。
• (注3) ログファイル名を指定した場合はそのファイルが収集されます。

拡張情報

診断サービスにて作成されるアーカイブファイルに任意の情報を含めます。

属性のDottedName：server.diagnostic-service

• (注) 収集リストには以下のような注意事項があります。
  ・絶対パスで記入してください。
  ・Windowsでは診断対象ドメインと同じドライブのファイルまたはディレクトリのみを収集することができます。
  ・パスに半角スペースが入る場合は、収集することができません。

収集リスト・除外リストについて

コンフィグレーション情報、配備アプリケーション情報、ログ情報では、収集項目に収集リスト、除外リストが存在します。 これは、各項目のtrue、falseと組み合わせて、柔軟に収集したいファイルのみを収集できるようにするためです。 各項目の優先順位は次のようになります。また、ファイルのパスには、統合運用管理ツールでは/または\を、運用管理コマンドでは/または\\を使用してください。

1. 収集リストに記入されたもの。
2. 除外リストに記入されたもの。
3. 各項目のtrue、falseの値。

よって、収集リストと除外リストに同じファイルが書かれた場合、収集リストが優先されます。次にいくつか例を挙げます。

例１）logsディレクトリ配下のagentログ以外を収集したい。
　　　server.diagnostic-service.capture-log=true
　　　server.diagnostic-service.capture-logs-dir=true
　　　server.diagnostic-service.excludes-log=agent

例２）logsディレクトリ配下の全ファイルのうち、agentディレクトリだけ除いて収集したい。
　　　しかし、agentディレクトリ配下のagent_access.logだけは収集したい。
　　　server.diagnostic-service.capture-log=true
　　　server.diagnostic-service.capture-logs-dir=true
　　　server.diagnostic-service.includes-log=agent/agent_access.log
　　　server.diagnostic-service.excludes-log=agent

10.2. 診断サービスの実行

診断サービスの実行方法について説明します。

10.2.1. 統合運用管理ツール

統合運用管理ツールを用いた診断サービスの実行方法について説明します。

1. 取得したい情報をあらかじめ設定しておきます。
   統合運用管理ツールの[診断対象ドメイン]-[アプリケーションサーバ]-[診断サービス]　を選択します。
   
   

   
   図10.2.1-1

   
   
   
2. [全般]タブのうち、取得したい情報にチェックを入れて、更新ボタンを押します。
   
   

   
   図10.2.1-2

   
   
   
3. さらに詳細に設定する場合は、各情報のタブを選択し、取得したい情報にチェックを入れます。
   また、収集したい任意のファイルを収集リストに、除外したい任意のファイルを除外リストに記入して、更新ボタンを押します。
   
   

   
   図10.2.1-3

   
   
   
4. 診断対象ドメイン名を右クリックして、[診断レポートの生成]をクリックします。
   
   

   
   図10.2.1-4

   
   
   
5. 診断レポート名を指定したい場合は出力レポート名の欄に、絶対パスで記入して下さい。絶対パスで記入しなかった場合は、診断レポートを作成できず、エラーとなります。
   出力レポート名に記入しない場合は、${INSTANSE_ROOT}/diagnostic-reportsディレクトリにドメイン名と日付を用いたレポート名で保存されます。
   また、テキストレポートに出力したい文字列がある場合は説明の欄に記入して下さい。 記入が終わったら、実行ボタンを押します。
   
   

   
   図10.2.1-5

   
   
   
6. 診断サービスの実行が成功すれば、診断レポートの保存先が絶対パスで返却されます。
   
   

   
   図10.2.1-6

   
   

10.2.2. 運用管理コマンド

運用管理コマンドを用いた診断サービスの実行方法について説明します。 各収集項目の属性名については、 [ 10.1. 診断サービスの設定 ] を参照してください。

1. 運用管理コマンドのsetコマンドを用いて、取得したい情報をあらかじめ設定しておきます。
   まず、取得したい情報の種類の属性値をtrueにします。
   
   

   例）

   set server.diagnostic-service.system=true
   

   システム情報をtrueに変更しました。

   set server.diagnostic-service.install=true
   

   インストール情報をtrueに変更しました。

   set server.diagnostic-service.config=true
   

   コンフィグレーション情報をtrueに変更しました。

   
   
2. さらに詳細に設定する場合は、各項目の属性値を変更します。
   
   

   例）

   set server.diagnostic-service.config-domain=true
   

   ドメインの設定ファイルをtrueに変更しました。

   set server.diagnositc-service.config-includes=log4otx.xml
   

   log4otx.xmlを収集リストに記入しました。

   
   
3. 次のコマンドを入力して、診断を実行します。このとき、引数には次のものが使用できます。
   
   

   例）

    generate-diagnostic-report domain1
   

   ドメイン１に対してリモートモードで診断サービスを実行しました。

   
   

   表10.2.2-1

   オプション名	記入できる値	説明
   target	ドメイン名	診断レポートを生成したいドメイン名を指定します。必須オプションです。
   outputfile	診断レポートの絶対パス	診断実行後に出力される診断レポート名を任意に指定できます。ただし、絶対パスで記入してください。 入力されない場合は、${INSTANSE_ROOT}/diagnostic-reportsディレクトリにドメイン名と日付を用いた診断レポート名で保存されます。
   local	true、false	ローカルモードで実行する場合はtrueを、リモートモードで実行する場合はfalseを指定します。 デフォルト値はfalseです。
   reportid	任意の文字列	テキストレポート内のReportIDの欄に出力される文字列を、任意に記入できます。
   targetdir	診断対象ドメイン存在するディレクトリまでの絶対パス	ローカルモード時のみ有効になります。指定されない場合は、WebOTX Application Server インストール時のディレクトリ階層だと仮定して、診断情報の収集を行います。 また、パスに半角スペースを含む場合は、パス全体を"(ダブルクォーテーション)で括ってください。

   
   
4. 診断サービスの実行が成功すれば、診断レポートの保存先が絶対パスで返却されます。
   
   

   例）

   Report File :C:\WebOTX\domains\domain1\diagnostic-reports\domain1_2008-6-3_18-27-17_report.zip
   診断レポートに含まれた情報の詳細は同名のテキストファイルを参照してください。
   ！！注意！！
   生成された診断レポート（アーカイブファイル）内に含まれるファイルには、
   ユーザ情報やマシン情報などが含まれる場合があります。
   診断レポートを WebOTX AS 問い合わせ窓口へ送付された場合、
   調査担当部隊では問題解決の目的にのみレポート内の情報を参照し、問題解決後は速やかにレポートを破棄します。
   コマンド generate-diagnostic-report は正常に実行されました。
   

10.2.3. 診断結果のファイル構成

診断サービスを実行すると、情報を収集したzipファイルが作成されます。 zipファイルの構成は以下の図のようになっています。ただし、収集する情報の種類により、ディレクトリが作成される場合と作成されない場合があります。

図10.2.3-1

それぞれのディレクトリには、次のような情報が含まれます。

10.2.4. 診断結果の確認

診断サービスを実行した結果を確認するには、診断レポートとして出力されたzipファイルと同名のテキストレポートを参照します。
テキストレポートは以下のような形式となっています。収集結果は、次のように表されます。

図10.2.4-1

テキストレポートの各項目の説明を以下の表に表します。

10.2.5. 診断サービスの利用例

診断サービスは、障害が起こった場合に利用できます。

1. アプリケーションサーバに障害が発生した場合、まずは、エラーメッセージを見て、エラーメッセージから原因が分かるようであれば、対処を行って下さい。
2. 次に、server.log、webotx_agent.logにエラーが出力されていないか確認してください。エラーが出ていた場合は、メッセージに従って対処を行って下さい。
3. それでも解決できず、WebOTXサポート窓口側に問い合わせる場合に、本サービスを利用して情報収集を行い、生成された診断レポートをメールなどで送付して下さい。

10.3. 統計レポート

統計レポート機能では、一定時間ごとに性能情報などを収集しCSVファイルへ出力を行います。 出力されたCSVファイルは表計算ソフトによりグラフ化することができます。

10.3.1. 統計レポートの出力項目

CSVファイルには、ドメイン起動後の初回出力時には項目名としてヘッダ行を出力します。 また出力を続けると、CSVファイルはログファイルのように設定されたファイルサイズと世代数に応じてローテーションを行います。 統計レポートの収集した情報は、それぞれ下記の3種類のCSVファイルとして出力されます。

10.3.1.1. エージェントプロセスの出力項目

エージェントプロセスから採取された情報は以下のファイルに出力されます。

出力内容の例は以下の通りです。

出力される項目の内容は以下の通りです。

10.3.1.2. プロセスグループの出力項目

プロセスグループから採取された情報は以下のファイルに出力されます。

出力内容の例は以下の通りです。

出力される項目の内容は以下の通りです。

10.3.1.3. プロセスグループ配下プロセスの出力項目

プロセスグループの各プロセスから採取された情報は以下のファイルに出力されます。

出力内容の例は以下の通りです。

出力される項目の内容は以下の通りです。

10.3.2. 統計レポートの設定項目

統計レポートの設定は、エージェントプロセスに対する設定とプロセスグループに対する設定があります。

10.3.2.1. エージェントプロセスの設定項目

エージェントプロセスに対する設定を行うには、統合運用管理ツールより以下のノードを選択します。
[<ドメイン名>]-[アプリケーションサーバ]-[診断サービス]-[統計レポート]

図10.3.2.1-1

設定項目の詳細は[ リファレンス集 運用管理・設定編 > 1. コンフィグレーション(設定一覧) > 1.2. 運用管理エージェント > 1.2.2. 運用管理エージェント設定項目一覧 > Dotted-name:server.diagnostic-service.statistics-report ] を参照してください。

10.3.2.2. プロセスグループの設定項目

プロセスグループに対する設定を行うには、統合運用管理ツールより以下のノードを選択します。
[<ドメイン名>]-[TPシステム]-[アプリケーショングループ]-[<アプリケーショングループ名>]-[プロセスグループ]-[<プロセスグループ名>]
上記ノード選択後、[統計レポート]のタブを選択します。

図10.3.2.2-2

設定項目の詳細は[ リファレンス集 運用管理・設定編 > 1. コンフィグレーション(設定一覧) > 1.11. TPシステム > 1.11.2. TPシステム設定項目一覧 > WebOTXJ2EEProcessGroup ] を参照してください。