2. 診断サービスの実行

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

2.1. 統合運用管理ツール

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

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

    diagnositc-image

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

    diagnositc-image

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

    diagnositc-image

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

    diagnositc-image

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

    diagnositc-image

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

    diagnositc-image

2.2.運用管理コマンド

運用管理コマンドを用いた診断サービスの実行方法について説明します。 各収集項目の属性名については、運用編のコンフィグレーション、1章の診断サービスについてを参照してください。

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

  2. 例)
    set server.diagnostic-service.capture-system-info=true

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

    set server.diagnostic-service.capture-install-info=true

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

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

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


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

  4. 例)
    set server.diagnostic-service.capture-domain.xml=true

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

    set server.diagnostic-service.capture-hs-err=true

    JVMの出力するエラーログファイルをtrueに変更しました。

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

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


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

  6. 例)
     generate-diagnostic-report domain1

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


    オプション名 記入できる値 説明
    target ドメイン名 診断レポートを生成したいドメイン名を指定します。必須オプションです。
    outputfile 診断レポートの絶対パス 診断実行後に出力される診断レポート名を任意に指定できます。ただし、絶対パスで記入してください。
    入力されない場合は、${INSTANSE_ROOT}/diagnostic-reportsディレクトリにドメイン名と日付を用いた診断レポート名で保存されます。

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

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

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

2.3.診断結果の確認

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

収集結果 説明
OK 収集に成功しました。
NG 収集に失敗しました。詳細はwebotx_agent.logを参照してください。
収集対象に選択されませんでした。

diagnositc-image

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

■診断レポートの概要

テキストレポート項目 説明
Date 日付です。
ReportID reportidとして入力された文字列を出力します。
Report 診断レポート名を絶対パスで出力します。

■システム情報

テキストレポート項目 説明
Operating system information システム情報全体の収集結果です。
OS summary
(OS Name, OS Version, CPU : osinfo.txt)
OSの概要の収集結果です。
Memory usage
(Physical and virtual memory size : osinfo.txt)
メモリの使用状況の収集結果です。
Memory usage
(Physical and virtual memory size : osinfo.txt)
メモリの使用状況の収集結果です。
Disk usage
(Total size, Free space, Available space, File system : osinfo.txt)
ディスクの使用状況の収集結果です。
List of processes
(Name, Process ID : osinfo.txt)
プロセス一覧の収集結果です。
List of active connections
(Protocol, Local address, Foreign address, State : osinfo.txt)
ネットワークの状態の収集結果です。

■インストール情報

テキストレポート項目 説明
Installation of WebOTX Application Server インストール情報全体の収集結果です。
Log file about installation of WebOTX Application Server
(ant_setup.log)
WebOTX Application Server インストール時のログの収集結果です。
Configuration file about WebOTX Application Server
(asenv.bat, asenv.conf)
WebOTX Application Server の設定ファイルの収集結果です。
Configuration file about WebOTX Application Server Agent Service
(woasinfo.properties)
WebOTX Agent Service の設定ファイルの収集結果です。
Environment variables
(env.txt)
OSの環境変数の収集結果です。
Basic information about WebOTX Application Server
(Edition, Version, Pacthes : otxinfo.txt)
WebOTX Application Server に関する情報の収集結果です。
List of the all in the "WebOTX" directory
(otxlist.txt)
WebOTX Application Server インストールディレクトリ配下のファイル一覧の収集結果です。

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

テキストレポート項目 説明
Configuration of WebOTX Application Server コンフィグレーション情報全体の収集結果です。
Configuration file about target domain
(domain.xml)
ドメインの設定ファイルの収集結果です。
Log file about target domain's JVM crash
(hs_err_pid.log)
JVMが出力するエラーログファイルの収集結果です。
Target domain's "config" directory
(excluding domain.xml, hs_err_pid.log, "persistent-mbean" directory)
configディレクトリ配下の全ファイルの収集結果です。
Target domain's "persistent-mbean" directory in "config" directory persistent-mbeanディレクトリの収集結果です。
Included list configディレクトリ配下に対する収集リストの収集結果です。
Excluded list configディレクトリ配下に対する除外リストの除外結果です。

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

テキストレポート項目 説明
Configuration of the deployed applications 配備アプリケーション情報全体の収集結果です。
Deployement descriptors
(XML files in "applications" directory)
配備記述子の収集結果です。
Part of files in target domain's "generated" directory
("policy" directory, "xml" directory)
generatedディレクトリ配下の一部のファイルの収集結果です。
All of the target domain's "generated" directory ggeneratedディレクトリ配下の全ファイルの収集結果です。
Included list applicationsディレクトリ、generatedディレクトリ配下に対する収集リストの収集結果です。
Excluded list applicationsディレクトリ、generatedディレクトリ配下に対する除外リストの除外結果です。

■ログ情報

テキストレポート項目 説明
Log of WebOTX Application Server ログ情報全体の収集結果です。
Log file about System.out and System.err
(server.log)
標準出力、標準エラー出力に関するログの収集結果です。
Log file about all massages from target domain agent service
(webotx_agent.log)
ドメインのエージェントサービスに関するログの収集結果です。
All of the target domain's "logs" directory
(excluding server.log, webotx_agent.log, access.log)
logsディレクトリ配下の全ファイルの収集結果です。
Log file about server accesses and domain agent accesses
(server_access.log, agent_access.log)
サーバ、ドメインのエージェントサービスへのアクセスログの収集結果です。
Included list logsディレクトリ配下に対する収集リストの収集結果です。
Excluded list logsディレクトリ配下に対する除外リストの除外結果です。

■モニタリング情報

テキストレポート項目 説明
Monitoring information モニタリング情報全体の収集結果です。
Monitoring information
(domain, server, tpsystem : monitorinfo.txt)
モニタリング情報の収集結果です。

■JVM情報

テキストレポート項目 説明
JVM information JVM情報全体の収集結果です。
Target domain's JVM version
(javaversion.txt)
Javaのバージョンの収集結果です。
Memory usage of target domain's JVM
(jvmmemory.txt)
JVMのメモリの収集結果です。
Thread dump from target domain's JVM
(threaddump.txt or server.log)
JVMのスレッドダンプの収集結果です。

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

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

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