JP1/Base 機能拡張
JP1/SES形式のイベントに拡張属性およびメッセージを付加するためには,定義ファイル(拡張属性マッピング設定ファイル)を作成する必要があります。次に,拡張属性マッピング設定ファイルの作成方法について説明します。
- <この項の構成>
- (1) 定義する内容
- (2) 格納場所
- (3) 形式
- (4) 注意事項
- (5) 定義例
(1) 定義する内容
拡張属性マッピング設定ファイルには,対象となるJP1/SES形式のイベントを絞り込むためのフィルター,およびJP1/SES形式のイベントに付加する拡張属性とメッセージを定義します。
(2) 格納場所
拡張属性マッピング設定ファイルは,JP1/Baseがインストールされたマシン上の次のディレクトリに作成します。
- Windowsの場合
イベントサーバインデックスで指定されたディレクトリ\sesmap\- デフォルトのイベントサーバインデックスでは次のようになります。
Baseパス\conf\event\servers\default\sesmap\
- UNIXの場合
イベントサーバインデックスで指定されたディレクトリ/sesmap/- デフォルトのイベントサーバインデックスでは次のようになります。
/etc/opt/jp1base/conf/event/servers/default/sesmap/sesmapディレクトリは,標準インストールの状態では存在しません。まずsesmapディレクトリを作成し,その直下に,次の形式のファイル名を持つテキストファイルを作成してください。
会社名_製品名_map.conf「製品名」は,「シリーズ名_製品名」とすることもできます。JP1イベント発行時の「PRODUCT_NAME」に指定する値の「/」を「_」に変更してファイル名に使用することをお勧めします。また,標準提供ファイル名称用に「hitachi」を使用しているため,「会社名」には「hitachi」以外の名称を使用してください。
なお,拡張属性マッピング設定ファイルは複数作成することもできます。sesmapディレクトリの直下に異なる名称の複数の拡張属性マッピング設定ファイルを作成すれば,それらのファイルの定義に基づいて,該当するJP1/SES形式のイベントが変換されます。複数の拡張属性マッピング設定ファイルを作成した場合,それらの定義は,ファイル名によって昇順に解析されます。
- 注意事項
- sesmapディレクトリには,定義ファイル以外のファイルは格納しないでください。
- バックアップファイルやモデルファイルを格納している場合,それらのファイルにより変換が行われることがあります。
(3) 形式
拡張属性マッピング設定ファイルは,マッピング設定ブロックの集合体です。マッピング設定ブロックの形式を次に示します。
[コメント] map [フィルターブロック] [メッセージ指定] [拡張属性指定1] [拡張属性指定2] : [拡張属性指定n] end-map [コメント]nは,最大100です。
コメントは,「#」で開始する改行を含まない行です。コメントは,マッピング設定ブロックとマッピング設定ブロックの間に記述できますが,マッピング設定ブロックの内部には記述できません。
「map」および「end-map」は,それぞれ,マッピング設定ブロックの開始および終了を宣言します。
マッピング設定ブロックを構成するほかの要素について,次に説明します。
(a) フィルターブロック
フィルターブロックには,JP1イベントに変換するJP1/SES形式のイベントを絞り込むためのフィルターを設定します。フィルターブロックの形式を次に示します。
filter イベントフィルター end-filterフィルターブロックを省略した場合は,すべてのJP1/SES形式のイベントが変換の対象となります。
イベントフィルターの指定形式に関しては,マニュアル「JP1/Base 運用ガイド」の,フィルターの文法の項を参照してください。
(b) メッセージ指定
JP1/SES形式のイベントのイベント情報にメッセージを付加する場合に指定します。形式を次に示します。
B.MESSAGE区切り文字 メッセージ文字列「B.MESSAGE」に続く区切り文字の後ろからその行末の改行までの間に存在する文字列が,メッセージとして付加されます。
イベント情報に最初からメッセージがある場合は,このパラメーターで指定されたメッセージ文字列に置き換えられます。ただし,このメッセージ文字列を付加することによって,元から設定してある詳細情報との合計サイズが1,024バイトを超える場合には,メッセージは付加されません。
この指定を省略した場合,メッセージは付加されません。
(c) 拡張属性指定
イベント情報に拡張属性を付加する場合に指定します。形式を次に示します。
E.拡張属性名 区切り文字 拡張属性値「E.」に続けて,付加する拡張属性の名称を指定します。区切り文字の後ろから行末の改行までの間にある文字列が,拡張属性の値として扱われます。この指定では,拡張属性値の指定は必須です。値を空(NULL文字列)にした拡張属性の指定はできません。また,拡張属性値には,改行を含む値は指定できません。
一つのJP1/SES形式のイベントに複数の拡張属性を付加する場合は,この指定を複数回繰り返します。ただし,一つのマッピング設定ブロックで,同一名称を持つ拡張属性は指定できません。また,一つのJP1/SES形式のイベントに付加できる拡張属性の数は最大100個で,すべての拡張属性値の合計サイズは10,000バイトに制限されます。これらの制限に反した場合は,そのマッピング設定ブロック全体が無視されます。
(4) 注意事項
- 拡張属性マッピング設定ファイルでは,1レコードが最大1,024バイトに制限されます。
- フィルターブロック,メッセージ指定,拡張属性指定はそれぞれ省略できますが,指定する場合はこの順番に指定しなければなりません。誤った順番で指定した場合,または拡張属性指定以外のブロックを2回以上指定した場合は,そのマッピング設定ブロック全体が無効になります。
- フィルターブロックで定義するフィルターに日本語文字列を指定した場合,その文字コードとJP1/SES形式で登録されたイベントの文字コードが異なると,そのイベントは変換されません。
- 拡張属性マッピング設定ファイルでは,除外条件はサポートされていません。フィルターブロックで定義するフィルターに除外条件を指定しないでください。
(5) 定義例
(a) 単一のマッピング設定
ここでは,「raysol」という名前のホストで稼働しているJP1/SESから自ホストに転送されたJP1/SES形式のイベントのうち,イベントIDが111のものを対象にして,拡張属性「SEVERITY」を「Information」に設定し,「Informational Message」というメッセージを付加する例を示します。
テキストエディターを使って,「company_sample_map.conf」という名前の拡張属性マッピング設定ファイルを作成します。この拡張属性マッピング設定ファイルでの定義を次に示します。
図3-2 拡張属性マッピング設定ファイルの定義例(単一のマッピング)
(b) 複数のマッピング設定
一つの拡張属性マッピング設定ファイルに,複数のマッピング定義を記述することもできます。
例えば,「(a) 単一のマッピング設定」で設定した定義に,イベントIDが222のJP1/SES形式のイベントの重大度を「Warning」にするという設定を追加できます。その場合の定義は次のようになります。
図3-3 拡張属性マッピング設定ファイルの定義例(複数のマッピング)
なお,一つの拡張属性マッピング設定ファイルに複数のマッピングを定義した場合には,ファイル内で上位に定義されたものから順に解析されます。
All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.