イベントサーバ設定ファイル(conf)の詳細について説明します。
(1) 格納先ディレクトリ
イベントサーバ設定ファイルの格納先ディレクトリを次に示します。
(2) パラメーター一覧
イベントサーバ設定は,次に示すパラメーターの集まりです。
パラメーター名 | 内 容 |
---|---|
ports | JP1イベント受信用IPアドレスとポート番号を指定する。 |
client-bind | JP1イベント送信用IPアドレスを指定する(複数LAN接続機能用パラメーター)。 |
users | JP1イベントを取得できるユーザー名を指定する。 |
eventids | 取得できるイベントIDを指定する。 |
alt-userid | WindowsおよびJavaのプログラムで仮定するユーザーIDまたはグループIDを指定する。 |
forward-limit | JP1イベント転送失敗時のリトライ期限を指定する。 |
after-error | 他サーバ転送のエラー後の転送抑止時間を指定する。 |
expire | イベントデータベース内のJP1イベントの保管期限を指定する。 |
db-size | イベントデータベースの容量を指定する。 |
buffnum | バージョン5以前の製品であるJP1/SESまたはJP1/AJSの関数などで取得するための保存JP1イベント数を指定する。 |
include ses-conf | バージョン5以前の製品であるJP1/SESの環境定義ファイルを取り込むことを指定する。 |
include ajs-conf | バージョン5以前の製品であるJP1/AJSの環境定義ファイルを取り込むことを指定する。 |
options | オプションのフラグを指定する。 |
remote-server | 他イベントサーバへの接続方法を指定する。 |
error-size | イベントサービスエラーログファイル(error.*)の容量を指定する。 |
trace-size | イベント転送トレースログファイル(trace.*)の容量を指定する。 |
evtlog-size | イベントサービストレースログファイル(imevterr.*)の容量を指定する。 |
fwderr-size | イベントサービス転送エラーログファイル(fwderr.*)の容量を指定する。 |
log-keep | ログファイル(error.*,trace.*,imevterr.*,fwderr.*)の数を指定する。 |
log-level | ログ(syslog,イベントログ,error.*,trace.*)の出力レベルを指定する(JP1/Base 06-51の場合だけ指定する)。 |
forward-timeout | JP1イベント転送のタイムアウト時間を指定する。 |
retry-interval | 転送失敗時のリトライ間隔を指定する。 |
repetition-noncheck-server | 重複登録チェックを抑止するイベントサーバ名を指定する。 |
restart | 再起動回数,リトライ間隔およびリセット時間を指定する。 |
JP1イベントの転送のリトライに関連するパラメーターは,forward-limit,after-error,retry-intervalです。デフォルトでは,JP1イベントの転送に失敗すると,3,600秒の間600秒の間隔で転送をリトライします。
クラスタ運用の場合,JP1イベントの転送中に転送元ホストまたは転送先ホストがフェールオーバーすると,そのJP1イベントの転送は失敗します。確実にJP1イベントを転送するために,必ず転送をリトライするように設定してください。
JP1イベントの転送のリトライに関連するパラメーターの相関関係を次の図に示します。
図6-1 リトライ関連のパラメーターの相関関係
なお,転送抑止期間を除いたリトライ間隔内で,次のJP1イベントの転送が発生した場合には,その時点でリトライが行われます。
JP1イベントの転送のリトライ中にイベントサービスの再起動またはリロードが行なわれた場合,転送されなかったJP1イベントはリトライ期限内であればイベントサービスの起動時に再送されます。
(3) パラメーターの説明
イベントサーバ設定の各パラメーターを説明します。
(a) ports アドレス 転送用ポート指定 AP用ポート指定
このイベントサーバが,他プログラムからの接続を受け入れるために使用するIPアドレスとポート番号を指定します。なお,このパラメーターでの指定は,バージョン5以前の製品であるJP1/SESまたはJP1/AJSが稼働するホストからのイベント受信には適用されません。
(b) client-bind アドレス
このイベントサーバが,他プログラムにJP1イベントを送信するために使用するIPアドレスを指定します。このパラメーターは,ネットワークを分離した環境でイベントサービスを運用するときに利用します。通常は,このパラメーターを指定する必要はありません。このパラメーターを省略すると,portsパラメーターに指定されたアドレスの形式でJP1イベントを送信します。ネットワークを分離した環境での運用については,「11.3 ネットワークを分離した環境での運用」を参照してください。また,このパラメーターでの指定は,バージョン5以前の製品であるJP1/SESまたはJP1/AJSが稼働するホストへのイベント送信には適用されません。
(c) users { * | ユーザー名 } …
JP1イベントを取得できるユーザー名を指定します。
このパラメーターは複数指定でき,すべての指定の和が,JP1イベントを取得できるユーザーとなります。このパラメーターを一つも指定しないと,どのユーザーもJP1イベントを取得できません。
なお,include ses-confパラメーター,またはinclude ajs-confパラメーターに指定するファイル内でユーザー名が設定されていない場合は,このパラメーターにユーザー名を指定する必要があります。
(d) eventids { * | 基本コード | 基本コード:拡張コード }
プログラムで取得できるイベントIDを指定します。ここで指定されないイベントIDのJP1イベントは,発行されてもエラーにはなりませんが,取得できません。
このパラメーターは複数指定でき,すべての指定の和が,取得できるJP1イベントとなります。このパラメーターを一つも指定しないと,JP1イベントを取得できません。
(e) alt-userid 代用ユーザーID 代用グループID
WindowsおよびJavaの実行環境は,数値形式のユーザーID・グループIDの概念を持たないため,代わりにイベントデータ中に設定する値を指定します。
代用ユーザーIDおよび代用グループIDは,-1~65,535の10進数で指定します。省略すると,どちらも-1を仮定します。
(f) forward-limit リトライ期限
JP1イベントの転送に失敗した場合の,リトライを繰り返す期限を秒単位で指定します。転送設定ファイルの指定によるJP1イベントの転送は,転送に成功するか,ここに指定された時間が過ぎるまで,retry-intervalパラメーターで指定した間隔で繰り返されます。
値は,0~86,400の10進数で指定します。省略した場合は,0(リトライしない)を仮定します。なお,このパラメーターを設定する場合は,retry-intervalパラメーターで指定するリトライ間隔よりも大きい値を指定してください。
(g) after-error エラー後の転送抑止時間
ある他サーバへのJP1イベント転送が失敗した後,そのサーバへのJP1イベント転送を抑止する時間を秒単位で指定します。したがって,指定された時間内は,JP1イベントはそのサーバへ転送されず,エラーとして扱われます。
値は0~2,147,483,647の10進数で指定します。retry-intervalパラメーターよりも小さい値を指定してください。このパラメーターを省略すると,30秒を仮定します。
(h) expire イベント保管期限
発行されたJP1イベントを,イベントデータベースに保管しておく時間を秒単位で指定します。JP1イベントはJP1イベントの発行後,指定された時間内はイベントデータベース中に保管され,JP1/IM - Viewなどから参照できます。ただし,イベントデータベースの容量がdb-sizeパラメーターで指定した値に達した場合は,保管期限に達していなくても削除されることがあります。
値は0~2,147,483,647の10進数で指定します。このパラメーターを省略すると,31,536,000秒,つまり365日が仮定されます。
(i) db-size イベントデータベースの容量
イベントデータベースの容量(バイト数)を指定します。指定された容量に達すると, JP1イベント保管期限に達していなくても,古いJP1イベントが削除されることがあります。イベントサービスでは,指定された容量の最大約2倍のディスク容量を使用します。
値は0~2,147,483,647の10進数で指定します。このパラメーターを省略すると,容量は2,147,483,647バイトが仮定されます。
保存する日数分のイベントデータベースの容量の計算式を次に示します。ファイルサイズを指定する際に参考にしてください。
[{a × (b + 64) + (c × 64)}×d]/2 (バイト)
注※ 1日当たりに登録されるイベントとは,自ホスト上で発生するイベント,他ホストから受信するJP1/SESイベントおよびJP1イベント,転送されるイベントのことを指します。
(j) buffnum SESイベント数
バージョン5以前の製品であるJP1/SESおよびJP1/AJSの関数,コマンド,またはジョブでJP1イベントを取得するために保存しておくJP1イベント数を指定します。この値を超えたJP1イベントが登録されると,古いJP1イベントから順に削除され,削除されたJP1イベントは,取得できなくなります。値は,UNIXの場合は2,500~10,000,Windowsの場合は64~2,048の10進数で指定します。省略すると,UNIXの場合は2,500,Windowsの場合は1,024を仮定します。
(k) include ses-conf ファイル名
バージョン5以前の製品であるJP1/SESの環境定義ファイルから,バッファー数(BUFFNUM),ユーザー名(USER),イベントID(EVIDxxxx)の指定を取り込むことを指定します。取り込んだバッファー数の指定は,イベントサーバ設定ファイル自体に記述されたbuffnumパラメーターの指定よりも優先します。また,ユーザー名およびイベントIDの指定は,イベントサーバ設定ファイルでの指定と取り込んだ指定の和となります。
ファイル名はフルパスで指定します。この指定はUNIX版のJP1/Baseだけで有効になり,Windows版のJP1/Baseでは無効になります。
(l) include ajs-conf
バージョン5以前の製品であるJP1/AJS - EEの設定ダイアログボックスで指定した,最大イベント数,UNIXユーザーID,UNIXグループID,ユーザー名,およびイベントIDの指定を取り込むことを指定します。取り込んだ最大イベント数,UNIXユーザーID,UNIXグループIDの指定は,イベントサーバ設定ファイル自体に記述されたbuffnumパラメーター,alt-useridパラメーターの指定よりも優先します。また,ユーザー名およびイベントIDの指定は,イベントサーバ設定ファイルでの指定と取り込んだ指定の和となります。
この指定はWindows版のJP1/Baseだけで有効になり,UNIX版のJP1/Baseでは無効になります。
(m) options [no-sync | sync] [remote-receive] [conv-off] [v5-unused] [KAJP1037-hntroff] [KAJP1037-syslogoff]
オプションのフラグを指定します。このパラメーターは,複数に分けて指定できます。
受信イベント | 受信機能 | イベントの受信(検知) |
---|---|---|
JP1イベント | JP1/SES互換用イベント取得関数 ajsevgetコマンド | 検知しない |
JP1/SES形式のイベント | JP1/SES互換用イベント取得関数 ajsevgetコマンド | 検知される |
パラメーター | v5-unused未設定時 | v5-unused設定時 |
---|---|---|
server | イベントサーバ名に@を指定すると,DNSに対応し,また,DNS環境でもJP1/SES互換機能を利用できるイベントサーバとなります。 | イベントサーバ名に@を指定すると,DNSに対応したイベントサーバとなります。 |
パラメーター | v5-unused未設定時 | v5-unused設定時 |
---|---|---|
users | *を指定すると,すべてのユーザーからJP1イベントを取得できるようになります。ただし,バージョン5以前の製品であるJP1/SESおよびJP1/AJSの関数,コマンド,またはジョブを使用してJP1イベントを取得する場合には,ユーザー名の指定が必要です。 | ユーザー名の指定は不要です。 |
eventids | *を指定すると,すべてのJP1イベントを取得できるようになります。ただし,バージョン5以前の製品であるJP1/SESおよびJP1/AJSの関数,コマンド,またはジョブを使用して取得または発行する場合,イベントIDが指定されていなければなりません。 | *を指定すると,すべてのJP1イベントを取得できるようになります。 |
buffnum | バージョン5以前の製品であるJP1/SESおよびJP1/AJSの関数,コマンド,またはジョブでJP1イベントを取得するために保存しておくJP1イベント数を指定します。 | このパラメーターは無視されます。 |
include ses-conf | バージョン5以前の製品であるJP1/SESの環境定義ファイルから,バッファー数(BUFFNUM),ユーザー名(USER),イベントID(EVIDxxxx)の指定を取り込むことを指定します。 | このパラメーターは無視されます。 |
include ajs-conf | バージョン5以前の製品であるJP1/AJS - EEの設定ダイアログボックスで指定した,最大イベント数,UNIXユーザーID,UNIXグループID,ユーザー名,およびイベントIDの指定を取り込むことを指定します。 | このパラメーターは無視されます。 |
options | conv-offを指定するとバージョン5以前の製品であるJP1/SES,JP1/AJSとの互換性のために用意されているJP1/SES互換用イベント取得関数の利用を抑止します。 | v5-unusedはconv-offで有効になる機能を含んでいます。指定してもエラーにはなりませんが,指定する必要はありません。 |
remote-server | 通信タイプにsesを指定するとバージョン5以前の製品であるJP1/SESのプロトコルでJP1イベントを送受信します。 | 通信タイプにsesが指定されたイベントサーバへの転送は常に失敗します。 |
(n) remote-server イベントサーバ名 通信タイプ [アドレス [ポート指定] ]
他サーバへイベントを転送する際の接続方法を指定します。このパラメーターには,異なるイベントサーバ名を複数指定できます。
(o) error-size ファイルサイズ
イベントサービスエラーログファイル(error.*)の最大容量(バイト数)を指定します。指定したサイズを超えると,イベントサービスエラーログファイルは, 先頭から上書きされます。
値は,65,536~2,147,483,647までの10進数で指定します。省略すると,500,000バイトを仮定します。
保存する日数分のイベントサービスエラーログファイルの容量の計算式を次に示します。ファイルサイズを指定する際に参考にしてください。
a + (b × c) × d (バイト)
(p) trace-size ファイルサイズ
イベント転送トレースログファイル(trace.*)の最大容量(バイト数)を指定します。指定したサイズを超えると,イベント転送トレースログファイルは,先頭から上書きされます。値は,65,536~2,147,483,647までの10進数で指定します。省略すると,1,000,000バイトを仮定します。
保存する日数分のイベント転送トレースログファイルの容量の計算式を次に示します。ファイルサイズを指定する際には,ログの出力量および1日当たりのイベント取得件数も考慮に入れて設定してください。
a + (b + c + d) × e (バイト)
ログの出力量はイベントサービスの動作によって異なりますが,参考値としてのログの出力量を次に示します。
出力されるログの量(バイト) | ||
---|---|---|
イベント1件登録時 | イベント1件取得時※1 | イベント1件転送時※2(失敗時・イベント転送リトライ設定あり) |
約150※3 | 約150※3 | 約1,500 |
注※1 イベント取得とは,他アプリケーションによるJP1イベントの取得を含みます。参考値は,10件登録されているイベントデータベースの10件目のJP1イベント取得時のログ出力量となっています。また,イベントデータベースに登録されているJP1イベントの件数と,検索するJP1イベントの登録位置によって出力される量は変わります。
注※2 JP1イベント転送時にログ出力が最大になるのは,JP1イベントの転送に失敗し,リトライする場合です。
注※3 API設定ファイルで,通信タイプをcloseに設定した場合のログの量です。
イベント取得件数は,ユーザーアプリケーションやJP1シリーズのプログラムからイベント取得関数を使用してイベントを取得する件数です。JP1シリーズのプログラムの1日当たりのイベント取得件数は,次の計算式で求めた値を目安にしてください。
イベント取得回数※1 × イベントデータベースに登録されているイベント数 + 1日当たりのイベント登録件数※2
(q) evtlog-size ファイルサイズ
イベントサービストレースログファイル(imevterr.*)の最大容量(バイト数)を指定します。指定したサイズを超えると,イベントサービストレースログファイルは,先頭から上書きされます。値は,65,536~2,147,483,647までの10進数で指定します。省略すると,1,000,000バイトを仮定します。
保存する日数分のイベントサービストレースログの容量の計算式を次に示します。ファイルサイズを指定する際には,ログの出力量および1日当たりのイベント取得件数も考慮に入れて設定してください。
a + (b + c + d) × e (バイト)
ログの出力量はイベントサービスの動作によって異なりますが,参考値としてのログの出力量を次に示します。なお,イベントサービストレースログファイルは,log-levelパラメーターで設定されたログレベルに影響されません。
出力されるログの量(バイト) | ||
---|---|---|
イベント1件登録時 | イベント1件取得時※1 | イベント1件転送時※2(失敗時・イベント転送リトライ設定有り) |
約3,000 | 約7,000 | 約3,000 |
注※1 イベント取得とは,他アプリケーションによるJP1イベントの取得を含みます。参考値は,10件登録されているイベントデータベースの10件目のJP1イベント取得時のログ出力量となっています。また,イベントデータベースに登録されているJP1イベントの件数と,検索するJP1イベントの登録位置によって出力される量は変わります。
注※2 JP1イベント転送時にログ出力が最大になるのは,JP1イベントの転送に失敗し,リトライする場合です。
イベント取得件数は,ユーザーアプリケーションやJP1シリーズのプログラムからイベント取得関数を使用してイベントを取得する件数です。JP1シリーズのプログラムの1日当たりのイベント取得件数は,次の計算式で求めた値を目安にしてください。
イベント取得回数※1 × イベントデータベースに登録されているイベント数 + 1日当たりのイベント登録件数※2
(r) log-keep ログファイルの個数
イベントサービスエラーログファイル,イベント転送トレースログファイル,およびイベントサービストレースログファイルを最大で幾つ作成するかを指定します。ログファイルは,イベントサービスの起動時に作成されます。イベントサービスの起動時に,指定した数以上のファイルがある場合は,最も古いファイルから削除されます。
値は,0~50の10進数で指定します。省略すると,5を仮定します。0を指定するとログを保存しません。
(s) log-level レベル
06-51以前のJP1/Baseでは,syslog,イベントログ,イベントサービスエラーログファイル,およびイベント転送トレースログファイルへのログの出力レベルを指定できます。
値は,1~10の10進数で指定します。省略すると,1を仮定します。通常は,値を1にしてご利用ください。なお,2以上の値を設定した場合は,障害発生時や障害から回復した場合などの詳細なログが出力されるようになります。
06-71以降のJP1/Baseでは,値に関係なく詳細なログが出力されるため,設定する必要はありません。
(t) forward-timeout 待ち時間
JP1イベントを転送する場合に,転送先からの応答を待つ時間を秒単位で指定します。指定した時間内に応答がなかった場合は,転送失敗と見なします。
値は,10~600の10進数で指定します。省略すると,90秒を仮定します。
(u) retry-interval 転送リトライ間隔
JP1イベントの転送失敗時にリトライを行う間隔を秒単位で指定します。
値は,60~2,147,483,647の10進数で指定します。after-errorパラメーターよりも大きい値を指定してください。このパラメーターを省略すると,600秒を仮定します。
(v) repetition-noncheck-server { * | イベントサーバ名 } …
重複登録チェックを抑止するイベントサーバ名を指定します。
JP1/SESのプロトコルで発生したイベントを複数経路から転送する場合にイベントのロストを防ぐために使用します。
このパラメーターは複数指定でき,すべての指定の和が,重複登録チェックを抑止するイベントサーバとなります。このパラメーターを一つも指定しないと,すべての転送元イベントサーバからのJP1イベントの重複登録チェックを行います。
(w) restart 再起動回数 リトライ間隔 リセット時間
物理ホストのイベントサービスのプロセスが異常終了した場合に,再起動するための設定として,再起動回数,再起動のリトライ間隔および再起動回数のリセット時間を指定します。リセット時間で指定した期間内にプロセスが異常終了した回数が,再起動回数以下であれば,プロセスは再起動されます。再起動されると,回復したときにメッセージ(KAJP1072-I)を出力します。このメッセージはJP1イベント(イベントID:00003D04)としても通知されます。したがって,運用時にこのJP1イベントを監視すると,イベントサービスのプロセスが再起動されたことを検知できます。この指定はUNIX版のJP1/Baseだけで有効になり,Windows版のJP1/Baseでは無効になります。このパラメーターを省略した場合,イベントサービスのプロセスが異常終了しても,再起動されないため,イベントサービスは停止します。
なお,イベントサービスの再起動中は,転送元ホストから転送されるJP1イベントを受け付けられません。転送元ホストでJP1イベント転送のリトライを設定している場合は転送がリトライされますが,リトライ期間を過ぎると転送失敗となります。このような転送失敗を防ぐために,再起動回数xリトライ間隔の値は,転送元ホストのconfで指定するJP1イベント転送のリトライ期限(forward-limitパラメーター)の値より小さくなるよう設定してください。
推奨値である,再起動回数に4回,リトライ間隔に15秒,リセット時間に3,600秒を設定した場合の動作を次の図に示します。
図6-2 イベントサービスのプロセスが異常終了した場合の動作例
図の例では,再起動後,再起動回数のリセット時間で指定した3,600秒以内に異常終了しなかった場合,3,600秒の時点で再起動回数がリセットされます。次回異常終了したときには1回目からカウントされます。一方,再起動後,3,600秒以内に異常終了した場合は,再起動回数を引き継ぎます。再起動回数が指定した回数に達すると,次回異常終了時には再起動しません。
jevserviceプロセスの子プロセスには,次の6種類があります。
表6-1 イベントサービスのプロセス構成
親プロセス | 子プロセス | 概 要 |
---|---|---|
jevservice | jevservice(LogTrc) | syslogまたは統合トレースログなどへ記録されるメッセージを出力します。 |
jevservice(DBMngr) | イベントデータベースを管理します。 | |
jevservice(SESEmu) | SES互換機能です。optionsパラメーターにv5-unusedフラグを設定している場合は起動しません。 | |
jevservice(EvtAPI) | JP1イベントの登録要求または取得要求を受け付けます。 | |
jevservice(FwdRcv) | 転送されてきたJP1イベントを受信します。 | |
jevservice(FwdMgr) | JP1イベントを転送します。 |
(x) fwderr-size ファイルサイズ
イベントサービス転送エラーログファイル(fwderr.*)の最大容量(バイト数)を指定します。指定したサイズを超えると,イベントサービスエラーログファイルは,先頭から上書きされます。値は,65,536~2,147,483,647までの10進数で指定します。省略すると,1,000,000バイトを仮定します。
保存する転送失敗イベント数分の転送エラーログ容量の計算式を次に示します。
保存する転送失敗イベント数×( 150 + イベントサーバ名長 +送信先イベントサーバ名長)
送信先イベントサーバが複数ある場合,送信先イベントサーバ名長は,送信先イベントサーバの中で最も長い送信先イベントサーバ名長とします。
(4) 設定例
イベントサーバ設定ファイルの設定例を次に示します。