ログファイルトラップ機能の動作定義ファイルの詳細について説明します。
なお,ログファイルトラップ機能の動作定義ファイルはデフォルトで提供されません。ユーザーが作成する場合と,定義配布機能によって作成される場合があります。
(1) 格納先ディレクトリ
confディレクトリにjevlog.confの名称の動作定義ファイルを作成した場合は,jevlogstartコマンドの-fオプションの指定を省略できます。
confディレクトリを次に示します。
任意のファイル名で,任意のフォルダに作成できますが,jevlogstartコマンドを実行する際,-fオプションにディレクトリ名を補ったファイル名を指定する必要があります。
(2) パラメーター一覧
定義できるパラメーターは全部で13種類あります。パラメーターの一覧を次に示します。
項番 | パラメーター |
---|---|
1 | [ retry-times=リトライ回数(イベントサービスへの接続用)] |
2 | [ retry-interval=リトライ間隔(イベントサービスへの接続用)] |
3 | [ open-retry-times=リトライ回数(ログファイルのオープン用)] |
4 | [ open-retry-interval=リトライ間隔(ログファイルのオープン用)] |
5 | [ read-retry-times=リトライ継続回数しきい値(ログファイルの読み込み用)] |
6 | [ hold-count=JP1イベントの保留件数 ] |
7 | [ keep-event={ OLD | NEW } ] |
8 | [ FILETYPE={ SEQ | SEQ2 | WRAP1 | WRAP2 | HTRACE } ] |
9 | ![]() |
10 | [HEADLINE=ヘッダーの行数] |
11 | [HEADSIZE=ヘッダーのサイズ] |
12 | ![]() |
13 | ![]() |
(3) MARKSTR,ACTDEFパラメーター文法
動作定義ファイルを定義するときの文法を次に示します。
正規表現の文法の詳細については,「付録F 正規表現の文法」を参照してください。
(4) パラメーターの説明
動作定義ファイルの各パラメーターを説明します。
(a) retry-times
[ retry-times=リトライ回数(イベントサービスへの接続用)]
一時的な通信障害で,イベントサービスへの接続に失敗した場合に行うリトライの回数を指定します。値は,0~86,400の10進数で指定します。このパラメーターを省略すると,リトライは行われません。
なお,リトライ回数とリトライ間隔の指定にかかわらず,リトライを開始してから86,400秒(24時間)経過するとエラーとなります。
(b) retry-interval
[ retry-interval=リトライ間隔(イベントサービスへの接続用)]
一時的な通信障害で,イベントサービスへの接続に失敗した場合に行うリトライの間隔を秒単位で指定します。リトライ回数を1以上に設定した場合に有効となります。リトライ間隔は,イベントサービスへの接続に失敗してから次にイベントサービスへの接続を試みるまでの間隔です。イベントサービスへの接続処理に掛かる時間は含みません。値は,1~600の10進数で指定します。このパラメーターを省略すると,10秒が仮定されます。
なお,リトライ回数とリトライ間隔の指定にかかわらず,リトライを開始してから86,400秒(24時間)経過するとエラーとなります。
(c) open-retry-times
[ open-retry-times=リトライ回数(ログファイルのオープン用)]
ログファイルトラップの開始時に,一時的にログファイルをオープンできなかった場合に行うリトライの回数を指定します。値は,1~3,600の10進数で指定します。このパラメーターを省略すると,1回が仮定されます。
なお,リトライ回数とリトライ間隔の指定にかかわらず,リトライを開始してから3,600秒経過するとエラーとなります。
(d) open-retry-interval
[ open-retry-interval=リトライ間隔(ログファイルのオープン用)]
ログファイルトラップの開始時に,一時的にログファイルをオープンできなかった場合に行うリトライ処理のリトライ間隔を秒単位で指定します。リトライ間隔は,ログファイルのオープンに失敗してから,次にログファイルのオープンを試みるまでの間隔です。値は,1~600の10進数で指定します。このパラメーターを省略すると,1秒が仮定されます。
なお,リトライ回数とリトライ間隔の指定にかかわらず,リトライを開始してから3,600秒経過すると,エラーと見なされ該当のログファイルの監視を停止します。
(e) read-retry-times
[ read-retry-times=リトライの継続回数のしきい値(ログファイルの読み込み用)]
一時的にログファイルの読み込みに失敗した場合に行うリトライの,継続回数のしきい値を秒単位で指定します。リトライの継続回数のしきい値とは,10ミリ秒間隔で5回行うリトライを1セットとしてカウントした回数です。10ミリ秒間隔で5回行うリトライが,read-retry-timesパラメーターに指定した回数を超えると,エラーと見なされ該当のログファイルの監視を停止します。
値は,1~1,000の10進数で指定します。このパラメーターを省略すると,100回が仮定されます。
(f) hold-count
[ hold-count=JP1イベントの保留件数 ]
リトライ処理中に保留できるJP1イベントの件数を指定します。値は,1~1,000の10進数で指定します。このパラメーターを省略すると,100件が仮定されます。
リトライ処理を行う場合,リトライ処理中に変換されたJP1イベントを保留するためのリソースが必要となります。リトライ処理を行う場合に必要なメモリー所要量を次に示します。
JP1イベントの保留件数 × 1KB
(g) keep-event
[ keep-event={ OLD | NEW } ]
リトライ処理中に保留されたJP1イベントが保留件数を超過した場合,超過したJP1イベントは消去されます。超過した場合に,古いJP1イベントと新しいJP1イベントのどちらを残すかを指定します。このパラメーターを省略すると,OLDが仮定されます。
(h) FILETYPE
[ FILETYPE={ SEQ | SEQ2 | WRAP1 | WRAP2 | HTRACE } ]
読み込むログファイルのデータ出力形式を指定します。このパラメーターを省略すると,SEQが仮定されます。
(i) RECTYPE
[ RECTYPE={ VAR { ’¥n’| ’1行の終了文字’ | ’1行の終了記号’} | FIX レコード長 } ]
読み込むログファイルのレコード形式を指定します。このパラメーターを省略すると,RECTYPE=VAR ’¥n’が仮定されます。つまり,可変長で「¥n」が1行の区切りというレコード形式の指定になります。
(j) HEADLINE
読み込むログファイルの先頭にヘッダーがある場合,ヘッダーの行数を10進数(0~99,999)で指定します。
このパラメーターを省略すると,0行が仮定されます。
(k) HEADSIZE
読み込むログファイルの先頭にヘッダーがあり,かつそのヘッダーが行数で指定できない場合,ヘッダーのサイズを10進数(0~9,999,999)で指定します。行数で指定できないヘッダーとは,バイナリーデータや,レコード形式がログデータと異なっているヘッダーなどです。
HEADLINEパラメーターを指定しているときには,このパラメーターは無効になります。
このパラメーターを省略すると,0バイトが仮定されます。
(l) MARKSTR
監視の対象外にしたいログデータを正規表現で指定します。正規表現は「" "」で囲んで指定します。また,一つのパラメーターに複数の正規表現が指定できます。ログデータ以外のデータとは,一定間隔でログファイル中に出力されるデータなどです。ログデータ以外のデータの例を次に示します。
(例)"==== 13:00:00 JP1/Base Event ===="
「!」を一つ目の「" "」の手前に付けた場合,指定した正規表現に一致しないデータを選択します。複数の正規表現を指定した場合,「!」の指定も含んだ,すべての正規表現の条件に一致するデータだけを選択します。このパラメーターを複数指定した場合,それぞれの指定に一致するデータをすべて選択します。
MARKSTRパラメーターに指定した正規表現がチェックされるのは,入力したログデータのうち,先頭からjevlogstartコマンドの-mオプションで指定した長さまでの間だけです。
このパラメーターを省略すると,ログデータ以外のデータはないと仮定されます。
(m) ACTDEF
読み込むログファイル中のデータの正規表現と,対応するイベントIDおよび重大度を指定します。正規表現に一致するログがあると,指定したイベントIDでJP1イベントを発行します。一つのパラメーターには複数の正規表現が指定できます。
0000011A:00000000
11A:0
11A
このパラメーターを複数指定した場合,それぞれの指定に一致するデータをすべて選択します。
ACTDEFパラメーターに指定した正規表現がチェックされるのは,入力したログデータのうち,先頭からjevlogstartコマンドの-mオプションで指定した長さまでの間だけです。
このパラメーターは省略できません。