Hitachi

JP1 Version 12　JP1/Base 運用ガイド

ログファイルトラップ動作定義ファイル

〈このページの構成〉

形式

retry-times=リトライ回数（イベントサービスへの接続用）

retry-interval=リトライ間隔（イベントサービスへの接続用）

open-retry-times=リトライ回数（ログファイルのオープン用）

open-retry-interval=リトライ間隔（ログファイルのオープン用）

read-retry-times=リトライ継続回数のしきい値（ログファイルの読み込み用）

hold-count=JP1イベントの保留件数

keep-event={ OLD | NEW }

upd-output-event={ 0 | 1 }

FILETYPE={ SEQ | SEQ2 | SEQ3 | WRAP1 | WRAP2 | HTRACE | UPD }

RECTYPE=｛VAR｛’\n’｜’1行の終了文字’|’1行の終了記号’｝｜FIX　レコード長｝

HEADLINE=ヘッダーの行数

HEADSIZE=ヘッダーのサイズ

unset-extattr={[TRAP_ID,TRAP_NAME] | [TRAP_ID] | [TRAP_NAME]}

MARKSTR=[!]"正規表現"

[!]"正規表現n"※

ACTDEF=[{EXIT}][<重大度>]イベントID [!]"正規表現"

[!]"正規表現n"※

注※　「正規表現n」は複数個の指定を表します。

ページの先頭へ

パラメーターの分類

必須パラメーター

なし

選択パラメーター

  • FILETYPE

  • RECTYPE

  • HEADLINE

  • HEADSIZE

  • MARKSTR

  • ACTDEF

ページの先頭へ

ファイル名

任意

jevlog.conf.model（ログファイルトラップ動作定義ファイルのモデルファイル）

ページの先頭へ

格納先ディレクトリ

次に示すディレクトリにjevlog.confの名称のログファイルトラップ動作定義ファイルを作成した場合は，jevlogstartコマンドの-fオプションの指定を省略できます。ログファイルトラップ動作定義ファイルは，次のディレクトリにあるモデルファイル（jevlog.conf.model）を参照してください。

Windowsの場合

インストール先フォルダ\conf\

UNIXの場合

/etc/opt/jp1base/conf/

任意のディレクトリに任意のファイル名でログファイルトラップ動作定義ファイルを作成した場合は，jevlogstartコマンドの-fオプションにディレクトリ名を補ったファイル名を指定する必要があります。

ページの先頭へ

説明

監視するログファイルの形式や，監視失敗時のリトライなどを設定しておくファイルです。ログファイルトラップ動作定義ファイルは初期設定では提供されません。ユーザーが作成する場合と，定義配布機能によって作成される場合があります。

ページの先頭へ

定義の反映時期

jevlogstartコマンドまたはjevlogreloadコマンドを実行すると，設定が有効になります。jevlogstartコマンドおよびjevlogreloadコマンドの詳細については，「15.　コマンド」の「jevlogstart」，「jevlogreload」を参照してください。

ページの先頭へ

記述内容

ログファイルトラップ動作定義ファイルには，次に示す規則があります。

retry-times=リトライ回数（イベントサービスへの接続用）

一時的な通信障害で，イベントサービスへの接続に失敗した場合に行うリトライの回数を指定します。値は，0〜86,400（回）の10進数で指定します。このパラメーターを省略すると，3回が仮定されます。

なお，リトライ回数とリトライ間隔の指定に関係なく，リトライを開始してから86,400秒（24時間）経過するとエラーとなります。

retry-interval=リトライ間隔（イベントサービスへの接続用）

一時的な通信障害で，イベントサービスへの接続に失敗した場合に行うリトライの間隔を指定します。リトライ回数を1以上に設定した場合に有効となります。リトライ間隔は，イベントサービスへの接続に失敗してから次にイベントサービスへの接続を試みるまでの間隔です。イベントサービスへの接続処理に掛かる時間は含みません。値は，1〜600（秒）の10進数で指定します。このパラメーターを省略すると，10秒が仮定されます。

なお，リトライ回数とリトライ間隔の指定に関係なく，リトライを開始してから86,400秒（24時間）経過するとエラーとなります。

open-retry-times=リトライ回数（ログファイルのオープン用）

ログファイルトラップの開始時に，一時的にログファイルをオープンできなかった場合に行うリトライの回数を指定します。値は，1〜3,600（回）の10進数で指定します。このパラメーターを省略すると，1回が仮定されます。

なお，リトライ回数とリトライ間隔の指定に関係なく，リトライを開始してから3,600秒（1時間）経過するとエラーとなります。

open-retry-interval=リトライ間隔（ログファイルのオープン用）

ログファイルトラップの開始時に，一時的にログファイルをオープンできなかった場合に行うリトライ間隔を指定します。リトライ間隔は，ログファイルのオープンに失敗してから，次にログファイルのオープンを試みるまでの間隔です。値は，1〜600（秒）の10進数で指定します。このパラメーターを省略すると，1秒が仮定されます。

なお，リトライ回数とリトライ間隔の指定に関係なく，リトライを開始してから3,600秒（1時間）経過すると，エラーとなります。

read-retry-times=リトライの継続回数のしきい値（ログファイルの読み込み用）

一時的にログファイルの読み込みに失敗した場合に行うリトライの，継続回数のしきい値を指定します。リトライの継続回数のしきい値とは，10ミリ秒間隔で5回行うリトライを1セットとしてカウントした回数です。10ミリ秒間隔で5回行うリトライが，このパラメーターに指定した回数を超えると，エラーとなります。値は，1〜1,000（回）の10進数で指定します。このパラメーターを省略すると，100回が仮定されます。

hold-count=JP1イベントの保留件数

リトライ処理中に保留できるJP1イベントの件数を指定します。値は，1〜1,000（件）の10進数で指定します。このパラメーターを省略すると，100件が仮定されます。

リトライ処理をする場合，リトライ処理中に変換されたJP1イベントを保留するためのリソースが必要となります。リトライ処理をする場合に必要なメモリー所要量を次に示します。

JP1イベントの保留件数 × 1キロバイト

keep-event={ OLD | NEW }

リトライ処理中に保留されたJP1イベントが保留件数を超過した場合，超過したJP1イベントは消去されます。超過した場合に，古いJP1イベントと新しいJP1イベントのどちらを残すかを指定します。このパラメーターを省略すると，OLDが仮定されます。

OLD

古いJP1イベントを残したい場合に指定します。この場合，hold-countパラメーターに指定したJP1イベントの保留件数までJP1イベントを保留し，以降に発生したJP1イベントは保留されずに消去されます。

NEW

新しいJP1イベントを残したい場合に指定します。この場合，JP1イベントの保留件数を超過すると，古いJP1イベントから消去されます。

upd-output-event={ 0 | 1 }

ログファイルのデータ出力形式にUPDを指定した場合，監視対象となるログファイルを検出したときに，JP1イベント（00003A25または00003A26）を出力するかどうかを指定します。このパラメーターを省略すると0が仮定されます。UPD以外を指定した場合，このパラメーターの指定は無視されます。

0

JP1イベントを出力しない場合に指定します。

1

JP1イベントを出力する場合に指定します。

FILETYPE={ SEQ | SEQ2 | SEQ3 |WRAP1 | WRAP2 | HTRACE | UPD }

読み込むログファイルのデータ出力形式を指定します。このパラメーターを省略すると，SEQが仮定されます。

SEQ

シーケンシャルファイル（一つのログファイルに追加書き込みし続けるファイル，またはログファイルが一定の容量に達すると，別のファイル名で新たにログファイルを作成して書き込むファイル）の場合に指定します。

SEQ2

次のようなファイルの場合に指定します。

  • Windowsの場合

    同一ボリューム内でファイル名を変更したあと，変更前のファイル名と同じ名称のファイルを作成して新たにログを書き込むファイルです。

  • UNIXの場合

    ファイル名を変更，またはファイルをいったん削除したあと，変更／削除前のファイル名と同じ名称のファイルを作成して新たにログを書き込むファイルです。

注意事項

SEQ2で監視する場合，監視間隔の間にログファイルが1回切り替わると，切り替わる前のファイル内から前回読み込んだデータ以降に蓄積されたデータを読み込んだあと，新たなファイル内のデータを読み込みます。そのため，監視間隔の間に2回以上切り替わると，切り替わる直前のファイルからのデータしか読み込めません。ログファイルが切り替わる頻度を考慮してjevlogstartコマンドの-tオプション（監視間隔）を設定してください。

SEQ3（Windows限定）

Windows上で，ファイルをいったん削除したあと，削除前のファイル名と同じ名称のファイルを作成して，新たにログを書き込むファイルの場合に指定します。

なお，リモートマシンにあるこの形式のログファイルを，IM構成管理機能のリモート監視のログファイルトラップで監視する場合，SEQ2で監視できます。ただし，この形式のログファイルをローカルマシン上のログファイルトラップで監視する場合は，SEQ3で監視する必要があります。

注意事項

  • SEQ3で監視する場合，ログファイルが削除された際に，前回読み込んだデータ以降に蓄積されていたデータがあると，読み込めないデータが発生します。ログ出力後，すぐにログファイルを削除している場合は，注意が必要です。

  • SEQ2形式で出力されるファイルをSEQ3で監視した場合，ログファイルがリネームされた際に，前回読み込んだデータ以降に蓄積されていたデータがあると，読み込めないデータが発生します。SEQ2で監視している場合は，この現象は発生しません。

WRAP1

ラップアラウンドファイル（ラップアラウンドして，再び先頭からデータを上書きするファイル）の場合に指定します。

WRAP1の場合，読み込むログファイルのコピーを作成して，そのコピーと現在のログファイルを比較して読み込み位置を決定するため，監視するファイルの容量と同じサイズのディスク容量が必要です。

注意事項

  • WRAP1で大容量のファイルを監視する場合，書き込んでいるデータ位置がファイルの最後の方にあると，最初のJP1イベントが発生するまでに時間が掛かります。

  • 次のようなラップアラウンドファイルの場合，JP1イベントへの変換が遅延したり，JP1イベントへ変換できなかったりすることがあります。

    ・短期間にラップアラウンドを繰り返す。

    ・ファイルの容量以上のログが一度に出力される。

    ・同じログデータが複数出力される。

WRAP2

ラップアラウンドファイル（ラップアラウンドするとき，データを削除して再び先頭からデータを書き込むファイル）の場合に指定します。

統合トレースログを監視する場合はWRAP2を適用してください。

ファイルを削除または名称を変更して作成し直す運用の場合は，SEQ2を指定してください。

注意事項

  • WRAP2の場合，データをすべて読み込む前にラップアラウンドしてデータが削除されると，読み込めないデータが発生します。監視間隔を長くすると，一度に読み込むデータの量が多くなるため，jevlogstartコマンドの-tオプション（監視間隔）の指定に注意してください。

  • JP1/Baseは，ラップアラウンドしたことを，ファイルのサイズが小さくなったことで検知しています。ラップアラウンド前とラップアラウンド後のファイルのサイズが同じである場合やラップアラウンド後のファイルのサイズが大きい場合，ラップアラウンドしたと判断しないため注意が必要です。

  • 統合トレースログに出力されるメッセージについては，複数のプロセスから同時に出力されるとメッセージが破損することがあるため，特定のメッセージを監視したい場合は，統合トレースログの排他機能を有効にしてください。排他機能の詳細については，「15.　コマンド」の「hntr2conf」を参照してください。

HTRACE

マルチプロセス対応トレースファイル（複数のプロセスが一組のトレースファイルを共有し，メモリマップドファイルを使用した固定サイズのファイル）の場合に指定します。

ログファイルへの書き込み方法はWRAP1と同様で，ログファイルが一定の容量に達するとラップアラウンドして，再び先頭からデータを上書きします。

Windowsの場合，Unicodeファイルの監視は，文字コードがUTF-8で出力されたログに対応しています。文字コードがUTF-16で出力されたログは監視できません。

UPD

常に，最新のログファイルを監視する場合に指定します。

この形式のログファイルを監視する場合，jevlogstartコマンド実行時に，ワイルドカードを含むように監視ファイル名を指定します。ワイルドカード指定に該当するログファイルのうち，最新更新日時のログファイルを監視対象として，ログファイルトラップを起動します。ログファイルトラップ起動後（監視中）は，ワイルドカード指定に該当する，新規に作成されたログファイルを監視対象とします。

ワイルドカードの対象となるファイルの上限は，1,000個です。なお，ワイルドカードの対象となるファイルでも，ファイル名の長さが完全名で257バイト以上のときは監視対象にはなりません。

また，監視対象となるファイルは，シーケンシャルファイル（一つのログファイルに追加書き込みし続けるファイル）でなければなりません。

RECTYPE={ VAR { ’\n’| ’1行の終了文字’ | ’1行の終了記号’} | FIX レコード長 }

読み込むログファイルのレコード形式を指定します。このパラメーターを省略すると，RECTYPE=VAR ’\n’が仮定されます。つまり，可変長で「\n」が1行の区切りというレコード形式の指定になります。

VAR

可変長のレコード形式の場合に，1行の終了文字，または1行の終了記号を指定します。C言語でのキャラクター1文字の指定と同じように「’’」で囲み，エスケープシーケンスでも指定できます。

FIX

固定長のレコード形式の場合に，レコード長を1行の区切りとして指定します。レコード長は，1〜9,999,999（バイト）の10進数で指定します。

HEADLINE=ヘッダーの行数

読み込むログファイルの先頭にヘッダーがある場合，ヘッダーの行数を，0〜99,999（行）の10進数で指定します。このパラメーターを省略すると，0行が仮定されます。

HEADSIZE=ヘッダーのサイズ

読み込むログファイルの先頭にヘッダーがあり，かつそのヘッダーが行数で指定できない場合，ヘッダーのサイズを，0〜9,999,999（バイト）の10進数で指定します。行数で指定できないヘッダーとは，バイナリーデータや，レコード形式がログデータと異なっているヘッダーなどです。HEADLINEパラメーターを指定しているときには，このパラメーターは無効になります。このパラメーターを省略すると，0バイトが仮定されます。

WindowsでUnicodeファイルの監視をする場合，Unicodeファイルの先頭にBOMがあるときは，BOMのサイズ（UTF-8の場合は3バイト，UTF-16の場合は2バイト）を除いたヘッダーのサイズを指定してください。

unset-extattr={[TRAP_ID,TRAP_NAME] | [TRAP_ID] | [TRAP_NAME]}

JP1/Baseのバージョンが10-50以降の場合，ログファイルトラップが出力するJP1イベントの拡張属性に監視ID（JP1_TRAP_ID）と監視名（JP1_TRAP_NAME）が出力されます。これらの属性値を出力しないようにする場合に，このパラメーターを指定します。このパラメーターを省略すると，監視IDと監視名が出力されます。

TRAP_ID,TRAP_NAME

監視IDと監視名のどちらも出力しない場合に指定します。

TRAP_ID

監視IDを出力しない場合に指定します。

TRAP_NAME

監視名を出力しない場合に指定します。

MARKSTR=[!]"正規表現"

ログデータ以外のデータなど，監視の対象外にしたいデータを正規表現で指定します。正規表現は「"　"」で囲んでください。ログデータ以外のデータとは，一定間隔でログファイル中に出力されるデータなどです。ログデータ以外のデータの例を次に示します。 

（例）"==== 13:00:00 JP1/Base Event ===="

「!」を「"　"」の前に付けた場合，除外条件となり，指定した正規表現に一致しないデータを監視の対象外とします。

一つのMARKSTRパラメーターには，複数の正規表現を指定できます。複数の正規表現を指定した場合，AND条件となり，「!」の指定も含むすべての正規表現の条件に一致するデータだけを監視対象外とします。なお，複数の正規表現を指定する場合は，正規表現の間を改行で区切ってください。2行目からは値だけを指定します。この場合，2行目以降の値の前に一つ以上の空白を入れてください。次に，「====」および「MARK」を含むデータを監視の対象外に指定する場合の例を示します。 

（例）MARKSTR="===="（改行）
      △△△△△"MARK"
    （凡例）△：空白

このパラメーターは複数指定できます。指定できる個数に制限はありません。複数指定した場合，OR条件となり，それぞれの指定に一致するデータをすべて監視対象外とします。

このパラメーターに指定した正規表現がチェックされるのは，入力したログデータのうち，先頭からjevlogstartコマンドの-mオプションで指定した長さまでの間だけです。このパラメーターをすべて評価してからACTDEFを評価します。このパラメーターを省略すると，ログデータ以外のデータはないと仮定されます。

ACTDEF=[{EXIT}][<重大度>]イベントID [!]"正規表現"

JP1イベントに変換するログデータの正規表現と，対応するJP1イベントのイベントIDおよび重大度を指定します。正規表現に一致するログがあると，指定したイベントIDでJP1イベントを発行します。なお，「=」，「{EXIT}」，「<重大度>」，および「イベントID」の間にはスペースまたはタブを入れないでください。入れた場合は文法エラーになります。

このパラメーターは複数指定できます。指定できる個数に制限はありません。複数指定した場合，OR条件となり，それぞれの指定に一致するデータをすべてJP1イベントに変換します。

このパラメーターに指定した正規表現がチェックされるのは，入力したログデータのうち，先頭からjevlogstartコマンドの-mオプションで指定した長さまでの間だけです。

正規表現の拡張については，「3.4.5　使用する正規表現を拡張する」を参照してください。

WindowsでUnicodeファイルを監視する場合は，必ず拡張した正規表現を指定してください。この場合，正規表現の拡張設定（"REGEXP"="EXTENDED"）の有無に関係なく，拡張した正規表現でフィルタリングします。拡張した正規表現の指定方法については，「付録F.2　正規表現を拡張した場合に使用できる拡張正規表現」を参照してください。

このパラメーターは省略できません。

{EXIT}

複数のACTDEFパラメーターを指定した場合に，「{EXIT}」を指定した条件に一致した時点で，そのログデータの監視を終了します。

複数のACTDEFパラメーターを指定した場合，一つのログデータが複数のACTDEFパラメーターの条件に一致すると，一致した数だけJP1イベントが発行されます。「{EXIT}」を指定しておくと，「{EXIT}」を指定した条件のイベントIDでJP1イベントが発行され，以降の監視は行われません。

「{EXIT}」を指定した場合，および指定しない場合の処理の違いを次の図に示します。

図16‒6　ログファイルトラップ動作定義ファイル指定例

[図データ]
<重大度>

JP1イベントの拡張属性の重大度を「<　>」で囲んで指定します。重大度とイベントIDは，対にして指定します。指定できる値を次に示します。

  • Emergency

  • Alert

  • Critical

  • Error

  • Warning

  • Notice

  • Information

  • Debug

指定を省略した場合は，Noticeが仮定されます。

イベントID

イベントサーバにJP1イベントを登録する際のイベントIDを指定します。イベントIDは上位4バイト（基本コード）と下位4バイト（拡張コード）をコロン「:」で区切り，16進数で記述します。A〜Fは大文字で記述してください。なお，下位4バイトまたはコロン以下の下位4バイトは省略できます。この場合，省略値には0を仮定します。また，上位下位とも8桁に満たない場合は前から補われます。ユーザーが指定できる範囲の値，0:0〜1FFF:0および7FFF8000:0〜7FFFFFFF:0を指定してください。なお，拡張コードには0を指定してください。

イベントIDの表記例を次に示します。次に示す3通りの表記は同じ意味になります。

0000011A:00000000
11A:0
11A
"正規表現"

JP1イベントに変換するログデータを正規表現で指定します。正規表現は「"　"」で囲んでください。「!」を一つ目の「"　"」の手前に付けた場合，除外条件となり，指定した正規表現に一致しないデータを変換対象とします。

一つのACTDEFパラメーターには，複数の正規表現を指定できます。複数の正規表現を指定した場合，AND条件となり，「!」の指定も含むすべての正規表現の条件に一致するデータだけをJP1イベントに変換します。なお，複数の正規表現を指定する場合は，正規表現の間を改行で区切ってください。2行目からは正規表現だけを指定します。この場合，2行目以降の値の前に一つ以上の空白を入れてください。次に，「jp1base」および「error」を含むデータを，イベントID「00000333」でJP1イベントに変換する場合の指定例を示します。 

（例）ACTDEF=00000333  "jp1base"（改行）
      △△△△△"error"
    （凡例）△：空白

ページの先頭へ

注意事項

ページの先頭へ

定義例

ページの先頭へ

Copyright (C) 2019, 2021, Hitachi, Ltd.

Copyright (C) 2019, 2021, Hitachi Solutions, Ltd.