5.2.14 ログファイル監視ジョブ定義情報の記述方法
ログファイル監視ジョブ定義情報の記述方法を説明します。
ログファイル監視ジョブ定義情報の形式,およびパラメーターを次に示します。
- 形式
[lftpd=[!]"トラップデータ1"[:[!]"トラップデータ2"...];]... [lffnm="ログファイル名";] [lfdft={s|s2|w1|w2};] [lfrft={v:'[\]区切り文字'|f:レコード長};] [lfhds={l:ヘッダー行数|s:ヘッダーサイズ};] [lfmks=[!]"ログ情報以外のデータ1" [:[!]"ログ情報以外のデータ2"...];] [lfsiv=ファイル監視間隔;] [lfmxl=イベントデータの最大長;] [lfsrc={y|n};] [lfcre={y|n};] [jpoif=マクロ変数名:引き継ぎ情報名;] [etm=n;] [fd=実行所要時間;] [ex="実行エージェント名";] [ha={y|n};] [eu={ent|def};] [ets={kl|nr|wr|an};] [mm={and|or};] [nmg={y|n};] [eun=待ち合わせ対象ユニット名;] [ega={exec|execdeffer|none};] [uem={y|n};]
- パラメーター
-
- lftpd=[!]"トラップデータ1"[:[!]"トラップデータ2"...];
-
トラップするログファイル中のデータを定義します。
一つのlftpdパラメーターに複数のトラップデータを指定できます(AND条件が適用されます)。また,複数のlftpdパラメーターを指定できます(OR条件が適用されます)。バイト数の合計が2,048バイトまで複数指定できます。
トラップデータ中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,トラップデータには正規表現が使用できます。
- lffnm="ログファイル名";
-
監視するファイル名を定義します。
指定できる文字数は,1〜256(単位:バイト)です。「lffnm="ログファイル名"」の形式で,8件まで同時に指定できます。
ログファイル名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
マクロ変数を指定できます。
- lfdft={s|s2|w1|w2};
-
トラップするログファイルの出力形式を定義します。省略した場合,sが仮定されます。
-
s:シーケンシャルファイル(一つのログファイルに追加書き込みし続けるファイル。ログファイルが一定の容量に達すると,別のファイル名で新たにログファイルを作成して書き込むファイル)
-
s2:シーケンシャルファイル(ファイル名を変更して保存,またはファイルをいったん削除したあと,同じ名称のファイルを作成して新たにログを書き込むファイル)
ジョブの実行先ホストがWindowsの場合は,JP1/Baseが08-10以降で,JP1/AJS3,またはJP1/AJS2 08-00以降のときに指定できます。
UNIXの場合は,JP1/Baseが07-00以降で,JP1/AJS3,またはJP1/AJS2 07-00以降のときに指定できます。
-
w1:ラップアラウンド(ログファイルが一定の容量に達すると,ラップアラウンドして再び先頭からデータを上書きする形式のファイル)
-
w2:ラップアラウンド(ログファイルが一定の容量に達してラップアラウンドするとき,データを削除して再び先頭からデータを書き込む形式のファイル)
-
- lfrft={v:'[\]区切り文字'|f:レコード長};
-
トラップするログデータのレコード形式を定義します。省略した場合,v:'\n'が仮定されます。
-
v:'[\]区切り文字':可変長レコードで行を区切ります。区切り文字に指定できる文字数は,1(単位:バイト)です。
-
f:レコード長:固定長レコードで行を区切ります。レコード長に指定できる文字数は,1〜9,999,999(単位:バイト)です。
-
- lfhds={l:ヘッダー行数|s:ヘッダーサイズ};
-
ヘッダーを定義します。
-
l:ヘッダー行数:トラップするログファイルの先頭にヘッダーがある場合,ヘッダーの行数を指定します。
ヘッダー行数に指定できる値は,0〜99,999(単位:行)です。
-
s:ヘッダーサイズ:バイナリーデータやレコード形式がログレコードと異なっているなどの理由で,トラップするログファイルの先頭に行数で指定できないヘッダーがある場合,ヘッダーのサイズを指定します。
ヘッダーサイズに指定できる値は,0〜9,999,999(単位:バイト)です。
-
- lfmks=[!]"ログ情報以外のデータ1"[:[!]"ログ情報以外のデータ2"...];
-
トラップするログファイル中にログ情報以外のデータが含まれる場合,そのデータを定義します。
データは複数指定できます(バイト数の合計が1,024バイトまで複数指定できます)。
データ中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
なお,データには正規表現が使用できます。
複数のlfmksパラメーターを指定した場合,OR条件が適用されます。一つのlfmksパラメーターに複数のデータを指定した場合は,AND条件が適用されます。
- lfsiv=ファイル監視間隔;
-
ログファイルを検索する時間間隔を定義します。
指定できる値は,1〜86,400(単位:秒)です。省略した場合,10が仮定されます。
- lfmxl=イベントデータの最大長;
-
入力する指定ログファイル1行の先頭何バイト分をイベントデータにするかを定義します。
指定できる値は,2〜512(単位:バイト)です。省略した場合,512が仮定されます。
- lfsrc={y|n};
-
データの入力を先頭データから入力するかを定義します。省略した場合,nが仮定されます。
-
y:先頭データから入力します。
-
n:先頭データから入力しません。
-
- lfcre={y|n};
-
ログファイル監視ジョブを開始した場合に,指定したログファイルがなかったときにエラーにするかを定義します。省略した場合,nが仮定されます。
-
y:エラーとします。
-
n:ログファイルが作成されるまで,ファイルのオープンを繰り返します。
-
- jpoif=マクロ変数名:引き継ぎ情報名;
-
マクロ変数名は,「?AJS2xxxxx?」という形式の64バイト以内の文字列で指定します。xxxxxの部分に指定できる文字列は,A〜Z(大文字の英字),0〜9(アラビア数字),「.(ピリオド)」です。
このパラメーターは,「jpoif=マクロ変数名:引き継ぎ情報名;」の形式で,バイト数の合計が2,048バイトまで指定できます。
このパラメーターでは,後続のPCジョブ,UNIXジョブ,フレキシブルジョブ,HTTP接続ジョブ,およびアクションジョブに対してイベント情報を引き継げます。
- etm=n;
-
実行打ち切り時間を,実行開始時刻からの相対分で定義します。指定できる値は,1〜1,440(単位:分)です。起動条件内のジョブの場合,このパラメーターは無効になります。
- fd=実行所要時間;
-
終了遅延監視するジョブの実行所要時間を定義します。
指定できる値は,10進数の値で1〜1,440(単位:分)です。
起動条件として定義する場合,このパラメーターはジョブ実行時に無効になります。
- ex="実行エージェント名";
-
ジョブを実行する実行エージェント名を定義します。
指定できる文字数は,1〜255(単位:バイト)です。
実行エージェント名中に「"(ダブルクォーテーションマーク)」や「#」が含まれる場合は,キャスト文字(#)でキャストします。「"」は「#"」,「#」は「##」と記述します。
マクロ変数を指定できます。
- ha={y|n};
-
ジョブの実行を保留するかを定義します。省略した場合,nが仮定されます。起動条件内のジョブの場合,このパラメーターは無効になります。
-
y:保留します。
-
n:保留しません。
-
- eu={ent|def};
-
ジョブ実行時のJP1ユーザーを定義します。省略した場合,entが仮定されます。イベントジョブの場合,このパラメーターの指定は無視されます。
-
ent:ジョブネットを登録したJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
def:ジョブを所有するJP1ユーザーをジョブ実行時のJP1ユーザーとします。
-
- ets={kl|nr|wr|an};
-
実行打ち切り時間が経過したあとのイベントジョブの状態を定義します。省略した場合,klが仮定されます。起動条件内のジョブの場合,このパラメーターは無効になります。
-
kl:強制終了
-
nr:正常終了
-
wr:警告検出終了
-
an:異常検出終了
-
- mm={and|or};
-
指定した待ち合わせ対象ユニットとの待ち合わせ方法を指定します。
省略した場合はandが仮定されます。
-
and:すべての待ち合わせ対象ユニットが終了したら実行を開始する。
-
or:待ち合わせ対象ユニットが一つでも終了したら実行を開始する。
-
- nmg={y|n};
-
指定した待ち合わせ対象ユニットのルートジョブネットに待ち合わせる世代がないときの動作を指定します。
省略した場合はnが仮定されます。
-
y:実行を開始する。
-
n:実行を開始しない。
-
- eun=待ち合わせ対象ユニット名;
-
待ち合わせ対象ユニットとするユニットを,完全名で指定します。
待ち合わせ対象ユニットを複数指定する場合,このパラメーターを複数回指定します。最大で32個指定できます。
待ち合わせ対象ユニット名に指定できる文字数は1〜930(単位:バイト)です。
- ega={exec|execdeffer|none};
-
起動条件付きジョブネットを待ち合わせ対象に指定していて,実行世代に異常終了がある場合の動作を指定します。
省略した場合はnoneが仮定されます。
-
exec:実行を開始する。
-
execdeffer:実行を開始しない。ただし,実行世代が「繰り越し未実行」状態の場合は,実行を開始する。
-
none:実行を開始しない。
-
- uem={y|n};
-
起動条件付きジョブネットを待ち合わせ対象に指定していて,監視世代が監視未起動終了の場合の動作を指定します。
省略した場合はnが仮定されます。
-
y:実行を開始する。
-
n:実行を開始しない。
-
- 注意事項
-
-
ログファイル名には,空白文字や記号なども使用できます。ただし,「"(ダブルクォーテーションマーク)」などの特殊文字を通常文字として扱う場合は,特殊文字の前に「\」を指定してください。
(例) log\#"file
-
イベントジョブの受信情報を引き継ぎ情報として,標準ジョブやアクションジョブのパラメーターに引き継ぐ場合で,引き継ぐ情報に「"(ダブルクォーテーションマーク)」が含まれるとき,「\」を前に付けて指定する必要があります。「\」を付けない場合,受信情報を引き継いでも「"(ダブルクォーテーションマーク)」が無視されるなどの現象が発生します。これを防止するためには,「"(ダブルクォーテーションマーク)」を含むデータを指定したとおりに引き継ぎ情報として引き継がせるオプションを設定してください。
設定については,マニュアル「JP1/Automatic Job Management System 3 構築ガイド 6.3.4 「"(ダブルクォーテーションマーク)」を含むデータをイベントジョブおよびカスタムイベントジョブの引き継ぎ情報に使用するための設定」(Windowsの場合)またはマニュアル「JP1/Automatic Job Management System 3 構築ガイド 15.3.4 「"(ダブルクォーテーションマーク)」を含むデータをイベントジョブおよびカスタムイベントジョブの引き継ぎ情報に使用するための設定」(UNIXの場合)を参照してください。
-