11.3.1 adshcollectコマンド(資料を採取する)
形式
adshcollect 保守情報出力先ディレクトリ [-f 定義ファイル名] [-e 環境ファイル名] [-h 論理ホスト名]
機能
adshcollectコマンドによって,障害調査のための資料を一括して収集できます。adshcollectコマンドを実行する場合は,Windowsのときはコマンドプロンプトから,UNIXのときはシェルから起動してください。
このコマンドは,障害発生時の障害情報を採取するため,実行ユーザーの権限で実行する必要があります。ただし,ユーザー応答機能の情報を採取する場合は,管理者権限で実行する必要があります。
adshcollectコマンドの使用手順を次に示します。
障害が発生したときの環境ファイルを用意してください。
障害発生後,環境ファイルを変更した場合は,環境ファイルを障害発生時の運用環境に合わせて書き換えてください。障害が発生したときに環境ファイルを使用していなかった場合は,用意は不要です。
- 注意事項
Windows版の場合,環境ファイルに&(アンパーサンド)が記述されていると,adshcollectコマンドがエラー終了することがあります。
ジョブ環境ファイルに&(アンパーサンド)が記述されている場合は,ジョブ環境ファイルをコピーして,コピーしたジョブ環境ファイルの&(アンパーサンド)を削除してください。さらに手順3で,コピーしたジョブ環境ファイルを-eオプションに指定してください。
システム環境ファイルに&(アンパーサンド)が記述されている場合は,事前にシステム環境ファイルを別のディレクトリにコピーしてバックアップを作成したあと,&(アンパーサンド)を削除してください。
定義ファイルを用意してください。
coreファイルまたはdumpファイルを採取する場合,任意の場所に定義ファイルを作成してください。coreファイルまたはdumpファイルを採取する必要がない場合は,作成は不要です。
adshcollectコマンドを実行します。
次のように引数を指定してadshcollectコマンドを実行してください。
実行時の注意点については「注意事項」を参照してください。
- 保守情報出力先ディレクトリ
指定したディレクトリに保守情報が作成されるため,次の点に注意してください。
・保守情報の出力先は書き込み可能であり,十分な空き容量があること
・JP1/Advanced Shellで使用しないディレクトリであること
- 環境ファイル名
手順1で用意した環境ファイルのパスを-eオプションまたは環境変数ADSH_ENVに指定してください。手順1で環境ファイルを用意しなかった場合は,指定は不要です。
- 定義ファイル名
手順2で用意した定義ファイルのパスを-fオプションに指定してください。手順2で定義ファイルを用意しなかった場合は,指定は不要です。
- 論理ホスト名
障害が発生したときの環境が論理ホストの場合は,-hオプションに論理ホスト名を指定してください。障害が発生したときの環境が論理ホストではない場合は,指定は不要です。
引数
- 保守情報出力先ディレクトリ
- 【Windows限定】
保守情報を格納したファイルを出力先ディレクトリに出力します。ディレクトリの名称は次の形式となります。
ADSHyyyymmddhhmmss
yyyymmdd:adshcollectコマンドを起動した日付
hhmmss:adshcollectコマンドを起動した24時間制のローカルタイムでの時刻
Windowsの標準機能にはUNIXのtar相当の機能がないため,保守情報を提供する場合,このファイルをユーザーの圧縮ツールを使用してzipまたはlzh形式などの一般的な形式に圧縮してください。
- 【UNIX限定】
収集した情報をtarのアーカイブファイルとして出力する場合の,出力先のディレクトリを指定します。また,一時ファイルを必要とする場合は,このディレクトリに作成します。アーカイブファイルの名称は次の形式となります。
ADSHyyyymmddhhmmss.tar
yyyymmdd:adshcollectコマンドを起動した日付
hhmmss:adshcollectコマンドを起動した24時間制のローカルタイムでの時刻
保守情報を出力した圧縮ファイルのディスク使用量は次のとおりです。
システム実行ログ,トレースログの容量+DUMPまたはCOREで指定したファイルの容量※
- 注※
Windows環境の場合はDUMPファイル,UNIX環境の場合はCOREファイルになります。
- -f 定義ファイル名
採取する保守情報が定義された定義ファイルの名称を指定します。絶対パスまたはカレントディレクトリからの相対パスで指定します。設定内容は項目「定義ファイルと環境ファイルの設定」を参照してください。
定義ファイル名の指定は任意です。定義ファイル名の指定がない場合は,DUMP,CORE相当の保守情報を採取しません。
- -e 環境ファイル名
このオプションは,環境変数ADSH_ENVに設定したファイルパスと別のファイルパスを指定したい場合に指定します。絶対パスまたはカレントディレクトリからの相対パスで指定します。
このオプションの指定がない場合
環境変数ADSH_ENVに設定したファイルパスを環境ファイル名として扱います。
このオプションと環境変数ADSH_ENVの指定がない場合
システム環境ファイルの内容に従って資料を採取します。
このオプションの指定,環境変数ADSH_ENVの指定,およびシステム環境ファイルがない場合
SPOOL_DIR,LOG_DIRおよびTRACE_DIRはデフォルト値になります。
- -h 論理ホスト名
障害情報を採取する論理ホスト名を指定します。指定された論理ホスト名を基に環境ファイルが解析されます。
「-h」だけ指定して引数の論理ホスト名を指定しなかった場合は,JP1_HOSTNAME環境変数から論理ホスト名を取得します。そのときJP1_HOSTNAME環境変数の指定がなければ,usageを出力してエラー終了します。JP1_HOSTNAME環境変数については,マニュアル「JP1/Base 運用ガイド」を参照してください。
定義ファイルと環境ファイルの設定
採取する情報を定義ファイルに定義し,採取情報の出力先を環境ファイルに定義します。
定義ファイルの定義
定義ファイルは,「#-adsh_conf△1」に続いてキーワードと値をスペースで区切って記述します。値に指定するファイル名はすべて絶対パスで指定します。
定義ファイルのキーワードと内容を次の表に示します。どのキーワードも指定は任意ですが,定義ファイルにはこれらのキーワード以外の内容(例えばコメントなど)は指定できません。また,どのキーワードにも値にワイルドカードは指定できません。
表11‒7 定義ファイルのキーワードと指定の関係 キーワード
指定内容
複数指定
DUMP【Windows限定】
ワトソンログなど,Windowsで採取したいdumpファイルを指定します。ワトソンログについては,Windowsの資料を参照してください。
パスにスペースがある場合は,ダブルクォーテーションで囲んでください。
○
(16個まで)
CORE【UNIX限定】
coreファイルを障害情報として採取する必要があるとき,ファイルを格納しているディレクトリ名を指定します。指定したディレクトリ以下にある,名前の一部に「core」と付いたファイルを一括して採取します。
○
- (凡例)
○:指定できます。
環境ファイルの定義
環境ファイルのキーワードと内容を次の表に示します。どのキーワードも指定は任意です。キーワードの指定がない場合は,表の「パス名のデフォルト値」に示す情報を採取します。また,どのキーワードにも値にワイルドカードは指定できません。
表11‒8 環境ファイルのキーワードと指定の関係 キーワード
(環境設定パラメーター)
指定内容
パス名のデフォルト値
複数指定
SPOOL_DIR
スプールルートディレクトリのパス名※
実行環境の場合【Windows限定】
共有ドキュメントフォルダ\Hitachi\JP1AS\JP1ASE\spool
開発環境の場合【Windows限定】
共有ドキュメントフォルダ\Hitachi\JP1AS\JP1ASD\spool
実行環境の場合【UNIX限定】
/var/opt/jp1as/spool
×
LOG_DIR
システム実行ログ出力先ディレクトリのパス名※
実行環境の場合【Windows限定】
共有ドキュメントフォルダ\Hitachi\JP1AS\JP1ASE\log
開発環境の場合【Windows限定】
共有ドキュメントフォルダ\Hitachi\JP1AS\JP1ASD\log
実行環境の場合【UNIX限定】
/opt/jp1as/log
×
TRACE_DIR
トレースログ出力先ディレクトリのパス名※
実行環境の場合【Windows限定】
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASE\trace
開発環境の場合【Windows限定】
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASD\trace
実行環境の場合【UNIX限定】
/opt/jp1as/trace
×
- (凡例)
×:指定できません。
- 注※
Windowsのパスにスペースがある場合は,ダブルクォーテーションで囲んでください。
定義ファイルと環境ファイルの指定例
Windowsの場合
定義ファイルの指定例を次に示します。
#-adsh_conf DUMP "C:\Program Files\Hitachi\JP1AS\JP1ASE\dump"
環境ファイルの指定例を次に示します。
#-adsh_conf SPOOL_DIR "C:\Documents and Settings\All Users\Documents\Hitachi\JP1AS\JP1ASE\spool" #-adsh_conf LOG_DIR "C:\Documents and Settings\All Users\Documents\Hitachi\JP1AS\JP1ASE\log" #-adsh_conf TRACE_DIR "C:\Documents and Settings\All Users\Application Data\Hitachi\JP1AS\JP1ASE\trace"
UNIXの場合
定義ファイルの指定例を次に示します。
#-adsh_conf CORE /home/user1/program1
環境ファイルの指定例を次に示します。
#-adsh_conf SPOOL_DIR /var/opt/jp1as/spool #-adsh_conf LOG_DIR /opt/jp1as/log #-adsh_conf TRACE_DIR /opt/jp1as/trace
adshcollectコマンドで採取するファイルの一覧
adshcollectコマンドで採取するファイルと最大サイズは,次の表に示すようにWindowsとUNIXで異なります。
ファイルの種類 |
ファイル名 |
最大サイズ |
採取 |
---|---|---|---|
スプール管理ファイル |
[環境ファイルのSPOOL_DIR※]\adsh.jobid |
1KB程度 |
○ |
システム実行ログ(JP1/Advanced Shell) |
[環境ファイルのLOG_DIR※]\AdshLog.log [環境ファイルのLOG_DIR※]\AdshLog_n.log(nは面数) |
[環境ファイルのLOG_FILE_SIZE]×(n+1) MB |
○ |
[環境ファイルのLOG_DIR※]\AdshLog.conf |
1KB程度 |
○ |
|
JP1/Advanced Shell内部処理の実行ログ |
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASE\uxpl\spool\uxpllog[n].txt(nは面数:最大2面) |
5MB |
○ |
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASD\uxpl\spool\uxpllog[n].txt(nは面数:最大2面) |
5MB |
○ |
|
共通アプリケーションフォルダ\Hitachi\JP1AS\misc\uxpl\spool\uxpllog[n].txt(nは面数:最大2面) |
5MB |
○ |
|
トレースログ (JP1/Advanced Shell) |
[環境ファイルのTRACE_DIR※]\AdshTrace_[n].log(nは面数:4面固定) |
[環境ファイルのTRACE_FILE_SIZE]×nMB |
○ |
トレースログ(カスタムジョブ) |
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASV\trace\AdshTrace_1.log |
1MB |
○ |
トレースログ(エディタ) |
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASD\adshedit\trace\AdshTrace_1.log |
1MB |
○ |
トレースログ (JP1/Advanced Shell,JP1/Advanced Shell - Developer共通コマンド) |
共通アプリケーションフォルダ\Hitachi\JP1AS\misc\trace\AdshTrace_[n].log(nは面数) |
8MB |
○ |
トレースログ(エディタ独自機能) |
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASD\adshedit\trace\adshedit.txt |
ユーザー環境の設定による |
○ |
アプリケーション実行エージェント機能ログ【実行環境限定】 |
共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASE\ appexec\APPEXECAGENT.log 共通アプリケーションフォルダ\Hitachi\JP1AS\JP1ASE\ appexec\APPEXECAGENT n.log(nは面数:最大2面) |
5MB程度 |
○ |
dumpファイル |
定義ファイルのDUMP以下のdumpファイル |
ユーザー環境の設定による |
△ |
環境ファイル |
環境変数ADSH_ENVのファイルまたは-eオプションで指定したファイル |
1KB程度 |
△ |
システム環境ファイル |
共通アプリケーションフォルダ\Hitachi\JP1AS\製品名\conf\adshrc.ase |
1KB程度 |
△ |
マシンに設定されているホスト名 |
システムルートフォルダ\system32\drivers\etc\hosts |
ユーザー環境の設定による |
○ |
マシンに設定されているサービスポート |
システムルートフォルダ\system32\drivers\etc\services |
ユーザー環境の設定による |
○ |
環境情報ファイル |
ADSHTMPyyyymmddhhmmss.txt yyyymmdd:adshcollectコマンドの起動日 hhmmss:adshcollectコマンドの起動時刻 |
ユーザー環境の設定による |
○ |
- (凡例)
○:adshcollectコマンドによって必ず採取します。
△:adshcollectコマンドのオプション指定時に採取します。
- 注※
-
環境ファイルで変更できます。パス名のデフォルト値については,前記の表を参照してください。
ファイルの種類 |
ファイル名 |
最大サイズ |
採取 |
---|---|---|---|
スプール |
[環境ファイルのSPOOL_DIR※]/.jobid |
1KB程度 |
○ |
システム実行ログ |
[環境ファイルのLOG_DIR※]/AdshLog.log [環境ファイルのLOG_DIR※]/AdshLog_[n].log(nは面数) |
[環境ファイルのLOG_FILE_SIZE]×(n+1) MB |
○ |
[環境ファイルのLOG_DIR※]/AdshLog.conf |
1KB程度 |
○ |
|
トレースログ |
[環境ファイルのTRACE_DIR※]/AdshTrace_[n].log(nは面数) |
[環境ファイルのTRACE_FILE_SIZE]×nMB |
○ |
coreファイル |
定義ファイルのキーワード「CORE」で採取したcoreファイル |
ユーザー環境の設定による |
△ |
ユーザー応答機能管理デーモンの情報 |
/opt/jp1as/system以下の起動ログおよびpidファイル |
1KB程度×稼働するユーザー応答機能管理デーモンの数 |
○ |
環境ファイル |
環境変数ADSH_ENVのファイルまたは-eオプションで指定したファイル |
1KB程度 |
△ |
システム環境ファイル |
/opt/jp1as/conf/adshrc.ase |
1KB程度 |
○ |
インストール済みの日立製品 |
/etc/.hitachi/pplistd/pplistd |
ユーザー環境の設定による |
○ |
環境変数 |
|
ユーザー環境の設定による |
○ |
環境情報ファイル |
ADSHTMPyyyymmddhhmmss.txt yyyymmdd:adshcollectコマンドの起動日 hhmmss:adshcollectコマンドの起動時刻 |
ユーザー環境の設定による |
○ |
tarのログ |
ADSHTARyyyymmddhhmmss.txt yyyymmdd:adshcollectコマンドの起動日 hhmmss:adshcollectコマンドの起動時刻 |
1KB程度 |
○ |
- (凡例)
○:adshcollectコマンドによって必ず採取します。
△:adshcollectコマンドのオプション指定時に採取します。
- 注※
-
環境ファイルで変更できます。パス名のデフォルト値については,前記の表を参照してください。
注意事項
保守情報出力先ディレクトリには,出力ファイルおよび一時ファイルを作成するため,空き領域を確保してください。また,保守情報出力先ディレクトリは書き込み可能にしてください。
adshcollectコマンドの実行中に強制終了すると,一時ファイルが保守情報出力先ディレクトリに残る場合があります。このような場合は,一時ファイルを手動で削除してください。
【UNIX限定】ユーザー応答機能を使用している場合は,root権限を持つユーザーでadshcollectコマンドを実行してください。root権限を持つユーザー以外で実行した場合は,ユーザー応答機能の情報を採取できません。
【Windows限定】ユーザー応答機能を使用している場合は,Administrators権限を持つユーザーでadshcollectコマンドを実行してください。Administrators権限を持つユーザー以外で実行した場合は,ユーザー応答機能の情報を採取できません。
保守情報出力先ディレクトリのパス,環境ファイルのパス,定義ファイルのパス,SPOOL_DIRのパス,LOG_DIRのパス,TRACE_DIRのパス,DUMPのパス,COREのパスおよびadshcollectコマンド実行時のカレントディレクトリのパスに次の記号を指定しないでください。
& ( ) [ ] { } ^ = ; ! ' + , ` ~ # %
adshcollectコマンドの引数の保守情報出力先ディレクトリ,定義ファイル名,環境ファイル名,論理ホスト名にオプションを指定した場合,そのオプションをディレクトリまたはファイル名,論理ホスト名として解釈します。