JP1/Base 運用ガイド
機能
ログファイルトラップ機能を起動するコマンドです。このコマンドを実行すると,オプションに指定してあるログファイルを検索します。そして,任意のデータを持つログの1行をJP1イベント化し,イベントサーバに登録します。このコマンドの起動前に,ログファイルトラップ機能の動作定義ファイルを作成しておく必要があります。
ログファイルに出力されるデータの形式が異なるファイルは同時に扱えません。この場合は,新たに別のログファイルトラップ機能を起動する必要があります。
形式
jevlogstart [-f 動作定義ファイル名] [-t ファイル監視間隔(秒)] [-m イベント化するデータの最大長(バイト)] [-h] [-n 表示コマンド名](UNIX限定) [-p ログデータ出力元プログラム名] [-r] [-s 登録先イベントサーバ名] [-a 監視名] ログファイル名1[ログファイル名32(100)]
実行権限
Windowsの場合:Administrators権限(WindowsのUAC機能が有効な場合は管理者コンソールから実行)
UNIXの場合:スーパーユーザー権限
格納先ディレクトリ
- Windowsの場合
- インストール先フォルダ\bin\
- UNIXの場合
- /opt/jp1base/bin/
引数
-f 動作定義ファイル名
ログファイルトラップ機能の動作定義ファイルの名称を256バイト以内で指定します。なお,相対パス名を指定する場合,ディレクトリ名を補ったフルパス名が256バイト以内になるように指定してください。相対パスはこのコマンドを実行するカレントディレクトリからの相対パスです。あらかじめconfフォルダにjevlog.confを作成し,そこに動作定義内容を指定しておいた場合,このオプションは省略できます。
jevlog.confの格納先ディレクトリは次のとおりです。
- Windowsの場合
- インストール先フォルダ\conf\
- UNIXの場合
- /etc/opt/jp1base/conf/
-t ファイル監視間隔(秒)
ログファイルの監視間隔(1〜86,400秒)を指定します。このオプションを省略すると,10が仮定されます。
- WRAP1,WRAP2またはHTRACEの形式のログファイルを監視する場合
- ラップラウンドする頻度が高い場合や監視間隔を長く指定した場合に,ログファイルトラップがデータを読み込む前に上書きされてしまい,データの読み込み漏れが発生するおそれがあります。データの読み込み漏れの予防策として,次の監視間隔の見積もり式を参考にしてください。
- ログファイルサイズ(バイト) × ログファイル数 > 1秒当たりの出力サイズ(バイト) × 監視間隔(秒)
-m イベント化するデータの最大長(バイト)
指定したログファイルを読み込むとき,ログファイルの1行を,先頭から何バイト(1〜1,024)までJP1イベントにするのかを指定します。行の終了文字は終了記号「\0」に変更されます。先頭からのバイトの指定には,「\0」が含まれます。読み込んだログファイルの1行がこのオプションで指定されたバイト数を超えた場合,イベント化するデータは「-mで指定したバイト数 - 1バイト」になります。
このオプションで指定した値は,入力したログファイルの1行の有効範囲を示します。したがって,動作定義ファイルのMARKSTRパラメーターの正規表現とACTDEFパラメーターの正規表現をチェックするのは,ここで指定した範囲内です。つまり,有効範囲を超えたカラムに対応する正規表現があっても,それらはチェックの対象にはなりません。このオプションを省略すると,512が仮定されます。行終了文字は「\0」に変更されます。
-h
ログを先頭から読み込みたい場合に指定します。ログを出力するプログラムを起動したあとにこのコマンドを実行すると,この時点ですでに出力されているログは読み込まれません。しかし,このオプションを指定すれば,ファイルの先頭データから読み込みができるようになります。ラップラウンドファイルの場合,ファイルの先頭からEOF(End Of File)までデータを読み込んだ後,カレント入力ポインターを見つけて,最新データを読み込んでいきます。
-n 表示コマンド名
このオプションはUNIXだけで使用できます。
ログファイルトラップ機能の表示コマンド名を指定します。この表示コマンド名は,psコマンドで表示できます。なお,コマンド名は256バイト以内で指定してください。このオプションを省略した場合,「ログファイル名1」が表示コマンド名に仮定されます。
-p ログデータ出力元プログラム名
ログデータを出力するプログラム名を指定します。指定した名称はJP1/IM - Viewの[イベントコンソール]画面に表示されます。
表示される名称は次のとおりです。
- Windowsの場合
- /HITACHI/JP1/NT_LOGTRAP/ログデータ出力元プログラム名
- UNIXの場合
- /HITACHI/JP1/UX_LOGTRAP/ログデータ出力元プログラム名
このオプションを省略すると,Windowsの場合,「/HITACHI/JP1/NT_LOGTRAP」,UNIXの場合,「/HITACHI/JP1/UX_LOGTRAP」と表示されます。
-r
-rオプションを指定しておくと,ログファイルトラップ機能起動時に指定したログファイルが存在しなかった場合,そのファイルが作成されるまで,-tオプションで指定した間隔でオープンを試みます。オープンに成功すると検索を開始します。
このオプションを省略した場合,ログファイルトラップ機能を起動した時点で,指定したログファイルが存在していない場合,ログファイルトラップ機能はログファイルのオープンを中止し,処理を終了します。
-s 登録先イベントサーバ名
JP1イベント登録先のサーバ名を,このオプションで指定されたサーバ名に変更します。指定できるイベントサーバは,自ホストで稼働しているイベントサーバに限ります。このオプションを省略すると,自ホストと同じイベントサーバ名(hostnameコマンドが返すホスト名)が仮定されます。イベントサーバ名は255バイト以内で指定してください。
このオプションは,主にクラスタシステムで使用します。
また,自ホスト名がショート名の環境で物理ホストのイベントサービスをFQDN形式で起動している場合は,このオプションで明示的にFQDN形式のイベントサーバ名を指定してください。
-a 監視名
ID番号に代わる別名として監視名を指定します。監視名は30バイト以内で指定してください。使用できる文字は,英数字,ハイフン,およびアンダーラインです。監視名の先頭の文字は,必ず英数字を指定してください。大文字,小文字は区別されます。
ログファイル名1[ ...ログファイル名32(100)]
監視するログファイル名を指定します。ログファイル名を256バイト以内で指定します。なお,相対パス名を指定する場合,ディレクトリ名を補った完全名が256バイト以内になるように指定してください。相対パスはこのコマンドを実行するカレントディレクトリからの相対パスです。ログファイル名の先頭に「-(ハイフン)」を指定しないでください。
指定できる個数はWindowsでは32個,UNIXでは100個までです。ただし,オープンできるファイル数が各システムによって異なるため,実際に指定できる個数の最大値は,Windowsでは32以下,UNIXでは100以下になる場合があります。また,UNIXの場合,1ログファイルの監視につき,1プロセスを使用します。psコマンドで表示されるコマンド名は「ログファイル名.child」です。
ログファイルの形式によっては監視できない場合があります。監視できるログファイルおよび監視できないログファイルの形式については,「7.2.2 ログファイルトラップ機能を使用する前に」を参照してください。
注意事項
- ログファイルトラップ機能は,ログを出力するプログラムを起動する前に起動してください。ログ出力中のファイルに対してログファイルトラップ機能を起動すると,正しくトラップできません。まだ,存在していないログファイルを指定する場合は,-rオプションでログファイルトラップ機能を待機させてください。
- Windowsの場合,ログファイルトラップ管理サービス,UNIXの場合,ログファイルトラップ管理デーモンが起動されているのを確認してから,jevlogstartコマンドを実行してください。
戻り値
0 正常終了 1 引数エラー 2 サービスまたは管理デーモンが起動していない 3 イベントサービスが起動していない 4 同一の監視名で起動済み(-aオプション指定時だけ) 255 そのほかのエラー また,jevlogstartコマンドを実行すると,標準出力にID番号を出力します。このID番号は,指定したログファイルのログファイルトラップ変換を終了するときに必要になります。
使用例
この使用例は,Windowsの場合です。
- (例1)
- ログファイルc:\log\logfile1.logから検索し,読み込みます。ここでの引数はログファイル名以外すべてデフォルトです。動作定義ファイルはJP1/Baseのconfフォルダ内のjevlog.conf,ファイル監視間隔は10秒,イベント化するデータの最大長は512バイトです。
jevlogstart c:\log\logfile1.log
- (例2)
- 動作定義ファイルをc:\conf\configfile.confにして,ログファイル c:\log\logfile1.logから検索し,読み込みます。
jevlogstart -f c:\conf\configfile.conf c:\log\logfile1.log
- (例3)
- ファイル監視間隔を5秒にして,ログファイルc:\log\logfile1.logとc:\log\logfile2.logから検索し,読み込みます。
jevlogstart -t 5 c:\log\logfile1.log c:\log\logfile2.log
All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.