属性付加設定ファイル

〈このページの構成〉

形式
パラメーターの分類
ファイル名
格納先ディレクトリ
説明
定義の反映時期
記述内容
注意事項
推奨する定義方法
定義例

形式

# コメント

add

filter

イベントフィルター

end-filter

E.拡張属性名 属性値

　：

end-add [exit]

　：

ページの先頭へ

パラメーターの分類

必須パラメーター: なし
選択パラメーター: なし

ページの先頭へ

ファイル名

recv_add_extattr（転送受信用の属性付加設定ファイル）

send_add_extattr（イベント登録用の属性付加設定ファイル）

add_extattr.model（属性付加設定ファイルのモデルファイル）

ページの先頭へ

格納先ディレクトリ

Windowsの場合

イベントサーバインデックスファイルで指定されたフォルダ\

共有フォルダ\jp1base\event\（クラスタ運用時）

初期設定のイベントサーバインデックスファイル（index）では，インストール先フォルダ\conf\event\servers\default\となっています。

UNIXの場合

イベントサーバインデックスファイルで指定されたディレクトリ/

共有ディレクトリ/event/（クラスタ運用時）

初期設定のイベントサーバインデックスファイル（index）では，/etc/opt/jp1base/conf/event/servers/default/となっています。

ページの先頭へ

説明

任意の拡張属性を付加するJP1イベントの条件，および付加する拡張属性名と拡張属性値を設定するファイルです。属性付加設定ファイルには，転送受信用の属性付加設定ファイル（recv_add_extattr）とイベント登録用の属性付加設定ファイル（send_add_extattr）があります。

属性付加設定ファイルは，「推奨する定義方法」を参考に定義してください。初期設定では提供されません。

転送受信用の属性付加設定ファイル（recv_add_extattr）を定義すると，転送されたJP1イベントを受信する際に，定義に従った拡張属性が付加されます。イベント登録用の属性付加設定ファイル（send_add_extattr）を定義すると，JP1イベントをイベントDBに登録する際に，定義に従った拡張属性が付加されます。

各定義ファイルで拡張属性を付加する対象となるJP1イベントを次の表に示します。

定義ファイル	対象となるJP1イベント^※1
転送受信用の属性付加設定ファイル（`recv_add_extattr`）	他イベントサーバから自イベントサーバあてに発行されたイベント^※2（JP1イベントの登録要因：3）。転送設定の指定による他イベントサーバから自イベントサーバへ転送されたイベント（JP1イベントの登録要因：4）。
イベント登録用の属性付加設定ファイル（`send_add_extattr`）	自イベントサーバから自イベントサーバあてに発行されたイベント（JP1イベントの登録要因：1）。自イベントサーバから他イベントサーバあてに発行されたイベント^※2（JP1イベントの登録要因：2）。

注※1　JP1/SESイベントは対象外となります。

注※2　jevsendコマンドまたはjevsenddコマンドの-dオプションで送信先イベントサーバを指定した場合，登録元のイベント登録用の属性付加設定ファイルと送信先の転送受信用の属性付加設定ファイルの両方の定義が有効になります。

ページの先頭へ

定義の反映時期

イベントサービスを起動もしくは再起動するか，またはjevextreloadコマンドを実行して属性付加設定ファイルをリロードすると，設定が有効になります。jevextreloadコマンドの詳細については，「15.　コマンド」の「jevextreload」を参照してください。なお，イベントサービスを再起動する場合は，イベントサービスを前提とするサービスの再起動も必要です。

ページの先頭へ

記述内容

属性付加設定ファイル（recv_add_extattr，send_add_extattr）には，次に示す規則があります。

1行1,023バイト以内のテキストファイルです。
パラメーターの各単語は，半角スペース（0x20）またはタブ（0x09）で区切ります。
各行の先頭のパラメーター名および#（0x23）の前には，空白などは入れられません。
行の先頭に#（0x23）を指定すると，その行はコメント行になります。
英字の大文字小文字は区別されます。

add〜end-add [exit]

add〜end-addが属性付加設定ブロックになります。属性付加設定ブロック内にフィルターブロックおよび任意の拡張属性を定義します。属性付加設定ブロックは複数定義できます。属性付加設定ブロックを複数定義した場合は，上位に定義した順に処理されます。end-addのあとにexitがあると，該当の属性付加設定ブロックの条件が成立した場合，それ以降の属性付加設定ブロックは処理されません。フィルターブロックを省略した場合も条件が成立と見なします。ただし，フィルターブロックと拡張属性の指定の両方を省略することはできません。

filter〜end-filter

filter〜end-filterがフィルターブロックになります。任意の拡張属性を付加するJP1イベントを絞り込むためのフィルターを定義します。フィルターブロックの形式を次に示します。

filter
イベントフィルター
end-filter

フィルターブロックを省略した場合は，すべてのJP1イベントが変換の対象となります。イベントフィルターには除外条件も指定できます。イベントフィルターの記述形式については，「イベントフィルターの文法」を参照してください。

E.拡張属性名 拡張属性値

拡張属性指定パラメーターです。JP1イベントに付加する任意の拡張属性（固有情報）の属性名および属性値を指定します。拡張属性指定パラメーターを複数定義することで，一つのJP1イベントに対して複数の拡張属性を複数付加できます。JP1イベントは100個まで拡張属性（共通情報と固有情報の合計）を持てます。また，JP1イベントに定義できる拡張属性値の長さの合計は，10,000バイトまでです。これらの制限を超える場合は，拡張属性は付加されません。なお，一つの属性付加設定ブロック内で，同一の拡張属性名は指定できません。

拡張属性指定パラメーターは省略できます。そのため，拡張属性を付加する必要がないJP1イベントに対しては，そのJP1イベントの条件をイベントフィルターに定義した上で，属性付加設定ブロックのend-addのあとにexitを指定することで，拡張属性を付加する必要がないJP1イベントを除外する指定ができます。

E.拡張属性名: 「E.」に続けて，付加する拡張属性の名称を32バイトまでの英数字（英字は大文字）またはアンダーラインで指定します。ただし，拡張属性名の先頭の7バイトの文字列は「JP1ADD_」で固定です。したがって，「E.JP1ADD_」に続く25バイトまでの文字列を任意に指定できます。
拡張属性値: E.拡張属性名に対応する属性の内容を1〜255バイトの文字列で指定します。拡張属性値を空（NULL文字列）にした指定はできません。また，改行を含む値も指定できません。

ページの先頭へ

注意事項

JP1イベントにすでに同名の拡張属性がある場合，指定した拡張属性値が再設定されます。
拡張属性を付加したJP1イベントを転送した場合，付加した拡張属性も一緒に転送されます。

ページの先頭へ

推奨する定義方法

属性付加はエージェントホストでも設定できますが，どのイベントに属性付加するか一元管理するために，マネージャーホストで設定することを推奨します。
属性付加の処理は「属性付加設定ブロックの数×イベント件数」に比例してイベント登録性能に影響を与えます。そのため，属性付加設定ファイルは，次のことを考慮して定義することを推奨します。なお，属性付加の処理では，JP1イベント１件ごとに属性付加設定ブロックを先頭から順に処理します。
- JP1/IM - Managerを3階層以上の階層構成で運用している場合，拠点マネージャーまたはサブマネージャーで属性付加設定ファイルを設定してください。
- 拡張属性を付加しないJP1イベントを対象とする条件を含む属性付加設定ブロックを先頭に定義することで，属性付加の処理を減らすことができます。
- すべてのJP1イベントに対する条件，または発生頻度が高いJP1イベントに対する条件を属性付加設定ファイルの上位に定義してください。
- 一つのJP1イベントに対して条件ごとに異なる属性を付加する場合を除いて，各属性付加設定ブロックではend-addのあとにexitを指定してください。
- 属性付加設定ファイルに定義する属性付加設定ブロックの総数は，2,500件以内にしてください。2,500件を超えて属性付加設定ブロックを定義した場合でもエラーにはなりませんが，イベント登録性能が劣化して運用に影響を与えるおそれがあります。

ページの先頭へ

定義例

次に示すシステム構成で，マネージャー側で受信したJP1イベントにエージェントホストが所属する業務グループ名を拡張属性として付加する場合の定義例を示します。

表16‒16　定義例のシステム構成
ホスト名	ホスト種別
jp1-mgr	統合マネージャー
jp1-agt001〜jp1-agt100	エージェント（業務グループ1）
jp1-agt101〜jp1-agt200	エージェント（業務グループ2）

統合マネージャー（jp1-mgr）の属性付加条件

重大度（SEVERITY）が「Information」または「Notice」以外のJP1イベントに拡張属性を付加する。
業務グループ1のエージェント（jp1-agt001〜jp1-agt100）から転送されたイベントに対して，業務グループ名「jp1-grp1」を拡張属性名「JP1ADD_GROUPNAME」として付加する。

業務グループ2のエージェント（jp1-agt101〜jp1-agt200）から転送されたイベントに対して，業務グループ名「jp1-grp2」を拡張属性名「JP1ADD_GROUPNAME」として付加する。

図16‒5　定義例のJP1イベント転送の流れ

統合マネージャー（jp1-mgr）の転送受信用の属性付加設定ファイル（recv_add_extattr）の定義例

# SEVERITYがInformationまたはNoticeであるJP1イベントを属性付加の対象から除外する
add
filter
E.SEVERITY IN Information Notice
end-filter
end-add exit
# エージェント(jp1-agt001〜jp1-agt100)から転送されたJP1イベントに対して
# 業務グループ名jp1-grp1を拡張属性JP1ADD_GROUPNAMEとして付加する
add
filter
B.SOURCESERVER RANGE jp1-agt001 jp1-agt100
end-filter
E.JP1ADD_GROUPNAME jp1-grp1
end-add exit
# エージェント(jp1-agt101〜jp1-agt200)から転送されたJP1イベントに対して
# 業務グループ名jp1-grp2を拡張属性JP1ADD_GROUPNAMEとして付加する
add
filter
B.SOURCESERVER RANGE jp1-agt101 jp1-agt200
end-filter
E.JP1ADD_GROUPNAME jp1-grp2
end-add exit

ページの先頭へ