付録J.4 JP1/SESイベントをJP1イベントに変換する
JP1/SESイベントには基本属性(イベントIDやメッセージなど)だけがあり,拡張属性(重大度,ユーザー名,プロダクト名,オブジェクトタイプなど)がありません。
イベントをJP1/IMの[イベントコンソール]画面に表示するには,イベントに拡張属性が設定されている必要があります。そのため,拡張属性マッピング設定ファイルを使用してJP1/SESイベントに重大度などの拡張属性を付加します。このように,JP1/SESイベントに拡張属性を付加してJP1イベントに変換することを,JP1/SESイベントの変換といいます。
JP1/SESイベントの変換の概要を次の図に示します。
- 〈この項の構成〉
(1) JP1/SESイベントを変換する手順
JP1/SESイベントに拡張属性を付加してJP1イベントに変換します。なお,必要であれば,拡張属性とともにメッセージも付加できます。
作業の流れは次のとおりです。
-
対象イベント,付加する拡張属性,メッセージを決める
-
定義ファイルを作成する
JP1/Baseがインストールされたマシン上に,次の定義ファイルを作成します。
-
拡張属性マッピング設定ファイル
-
-
イベントサービス(JP1/Base)を再起動する
JP1/IMが起動している場合は,JP1/IMを終了させてからJP1/Baseを再起動してください。このあと,必要であればJP1/IMを起動してください。
(a) 対象イベント,付加する拡張属性,メッセージを決める
まず,どのJP1/SESイベントをJP1イベントに変換するのかを決めます。対象イベントは,イベントIDや発行元サーバ名などでフィルタリングできます。そのため,特定のイベントIDを持つJP1/SESイベントや,特定のサーバから発行されたJP1/SESイベントだけをJP1イベントに変換できます。
次に,JP1/SESイベントに付加する拡張属性およびメッセージを決めます。JP1/IMでイベント監視をするためには,そのイベントに少なくとも拡張属性「SEVERITY」を付加しなければなりません。それ以外の拡張属性やメッセージは,JP1/IMでイベント監視をするために有用なものを付加します。拡張属性を設定する際の指針としては,マニュアル「JP1/Base 関数リファレンス」を参照してください。
(b) 定義ファイルを作成する
JP1/SESイベントに拡張属性およびメッセージを付加するためには,拡張属性マッピング設定ファイルを作成します。
■ 定義する内容
拡張属性マッピング設定ファイルには,対象となるJP1/SESイベントを絞り込むためのイベントフィルター,およびJP1/SESイベントに付加する拡張属性とメッセージを定義します。
■ 格納場所
拡張属性マッピング設定ファイルは,JP1/Baseがインストールされたマシン上の次のディレクトリに作成します。
- Windowsの場合
イベントサーバインデックスで指定されたディレクトリ\sesmap\
初期設定のイベントサーバインデックスでは次のようになります。
インストール先フォルダ\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ディレクトリには,定義ファイル以外のファイルは格納しないでください。
バックアップファイルやモデルファイルを格納している場合,それらのファイルにより変換が行われることがあります。
■ 形式
拡張属性マッピング設定ファイルは,マッピング設定ブロックの集合体です。マッピング設定ブロックの形式を次に示します。
[コメント] map [フィルターブロック] [メッセージ指定] [拡張属性指定1] [拡張属性指定2] : [拡張属性指定n] end-map [コメント]
コメントは,「#」で開始する改行を含まない行です。コメントは,マッピング設定ブロックとマッピング設定ブロックの間に記述できますが,マッピング設定ブロックの内部には記述できません。
「map」および「end-map」は,それぞれ,マッピング設定ブロックの開始および終了を宣言します。
マッピング設定ブロックを構成するほかの要素について,次に説明します。
• フィルターブロック
フィルターブロックには,JP1イベントに変換するJP1/SESイベントを絞り込むためのフィルターを設定します。フィルターブロックの形式を次に示します。
filter イベントフィルター end-filter
フィルターブロックを省略した場合は,すべてのJP1/SESイベントが変換の対象となります。イベントフィルターの指定形式に関しては,「16. 定義ファイル」の「イベントフィルターの文法」を参照してください。
• メッセージ指定
JP1/SESイベントのイベント情報にメッセージを付加する場合に指定します。形式を次に示します。
B.MESSAGE区切り文字 メッセージ文字列
「B.MESSAGE」に続く区切り文字の後ろからその行末の改行までの間に存在する文字列が,メッセージとして付加されます。指定を省略した場合,メッセージは付加されません。
イベント情報に最初からメッセージがある場合は,このパラメーターで指定されたメッセージ文字列に置き換えられます。ただし,このメッセージ文字列を付加することによって,元から設定してある詳細情報との合計サイズが1,024バイトを超える場合には,メッセージは付加されません。
• 拡張属性指定
イベント情報に拡張属性を付加する場合に指定します。形式を次に示します。
E.拡張属性名 区切り文字 拡張属性値
「E.」に続けて,付加する拡張属性の名称を指定します。区切り文字の後ろから行末の改行までの間にある文字列が,拡張属性の値として扱われます。拡張属性値を空(NULL文字列)にした指定はできません。また,改行を含む値も指定できません。
一つのJP1/SESイベントに複数の拡張属性を付加する場合は,この指定を複数回繰り返します。ただし,一つのマッピング設定ブロックで,同一名称を持つ拡張属性は指定できません。また,一つのJP1/SESイベントに付加できる拡張属性の数は最大100個で,すべての拡張属性値の合計サイズは10,000バイトに制限されます。これらの制限に反した場合は,そのマッピング設定ブロック全体が無視されます。
■ 注意事項
-
拡張属性マッピング設定ファイルでは,1レコードが最大1,024バイトに制限されます。
-
フィルターブロック,メッセージ指定,拡張属性指定はそれぞれ省略できますが,指定する場合はこの順番に指定してください。誤った順番で指定した場合,または拡張属性指定以外のブロックを2回以上指定した場合は,そのマッピング設定ブロック全体が無効になります。
-
フィルターブロックで定義するフィルターに日本語文字列を指定した場合,その文字コードとJP1/SES形式で登録されたイベントの文字コードが異なると,そのイベントは変換されません。
-
拡張属性マッピング設定ファイルでは,除外条件はサポートされていません。フィルターブロックで定義するフィルターに除外条件を指定しないでください。