アダプター構成ファイルの構造

アダプター構成ファイルには、汎用ログ・アダプターのランタイム・インスタンスによって実行される コンテキスト の集合が収められています。 各コンテキストは、単一のログ・ファイルの処理方法を表します。 アダプター構成ファイルにはこれらのコンテキストを数多く収めることができるので、 アダプターは同時に複数のログ・ファイルを処理することができます。

特定のログ・ファイルに関連付けられる各コンテキストは、 一連のコンポーネントから構成されています。 コンポーネントごとに、ログ・ファイルの処理で果たす役割があります。

• コンテキスト
• センサー
• 抽出
• パーサー
• フォーマッター
• アウトプッター

コンテキスト

コンテキストは、ログ・ファイル処理のために 1 つにチェーニングされているコンポーネントの順序付けグループを表します。 ログ・ファイルごとに個別のコンテキストがあり、 単一の構成で複数のコンテキストを定義することができます。 汎用ログ・アダプターには、以下の 1 つのコンテキストが用意されています。

• org.eclipse.hyades.logging.adapter.impl.BasicContext - 単一スレッドでそれぞれのコンポーネントを実行するコンテキストです。

コンテキストのプロパティーは以下のとおりです。

センサー

センサーは、処理する内容を読み取るメカニズムを提供します。 汎用ログ・アダプターには以下のセンサーが用意されています。

• SingleFileSensor: ローカル・ストレージ・メディアからファイルを読み取るセンサー。
  実行可能クラス: org.eclipse.hyades.logging.adapter.sensors.SingleOSFileSensor
• StaticParserSensor: Java ベースの実装によって実行される変換プログラムを統合するセンサー。 Java パーサーを直接呼び出し、その Java パーサーが生成する共通ベース・イベント・オブジェクトをエクスポートします。
  実行可能クラス: org.eclipse.hyades.logging.adapter.config.sensors.StaticParserSensor
  
• AdapterCBESensor: アダプターの実行をモニターするセンサー。 汎用ログ・アダプター内部で、汎用ログ・アダプターそのもののメッセージをログに記録する場合に使用されます。 アダプター内の内部ロギングはすべてこのセンサーに送られます。
  実行可能クラス: org.eclipse.hyades.logging.adapter.internal.util.AdapterSensor

以下の表に、センサー・タイプ間で共通の属性をリストします。

センサーの属性

属性名	型	振る舞い
センサー・タイプ	string	アダプターが使用するセンサー・タイプ。
説明 (必須)	string	センサーのテキスト記述。 この値は、アダプター構成エディターでのみ使用されます。
固有の ID (必須)	string	このコンポーネントの固有 ID。 センサーはこのストリングを参照してどのコンポーネント・インスタンスを使用するかを識別します。
最大ブロック化 (必須)	integer	処理のために抽出に転送するまでセンサーが読み取る最大行数。 StaticParserSensor タイプでは、このフィールドは、 処理のためにアウトプッターに転送するまで static パーサーが作成する共通ベース・イベント・オブジェクトの最大数を示します。
信頼性バッファー (Confidence Buffer)	integer	ファイルの最後の n バイトを保存し、 これを使用して、前回の読み取り以降にファイルに対して追加が発生したかどうかを判別します。
フッター・サイズ (Footer size)	integer	変数の内容を収めるファイルの n バイト。 ファイルのフッター部分は、前回のファイルの読み取り以降に追加が発生したかどうかの判別には使用されません。

以下の表に、 各センサー・タイプに固有のプロパティーをリストします。 以下のプロパティーはコンポーネント・コードで認識されるので、 コンポーネントで認識および使用されるように表のとおりに正確に入力してください。

抽出

抽出は、センサーから提供された入力行の集合を取得し、メッセージ境界でそれらを切り離します。

汎用ログ・アダプターには、以下の抽出が用意されています。

• org.eclipse.hyades.logging.adapter.extractors.RegularExpressionExtractor
  この抽出は、正規表現を使用してログ・ファイル内のメッセージの区切りを表します。
• org.eclipse.hyades.logging.adapter.extractors.SimpleExtractor.
  この抽出は、単純なストリング比較を使用して、 ログ・ファイル内のメッセージの区切りを表します。 この抽出は、正規表現の抽出に対するハイパフォーマンスの代替方法であり、 固定されたメッセージ区切り文字を含むログ・ファイルで使用されます。

抽出用の構成として、以下のプロパティーが用意されています。

パーサー

パーサーは、抽出で区切られたメッセージを取得して、 ストリング値のマッピング・セットをデータ構造にビルドします。 汎用ログ・アダプターの場合のデータ構造は共通ベース・イベント 1.0.1 です。

汎用ログ・アダプターには、以下のパーサー・クラスが用意されています。:

• org.eclipse.hyades.logging.adapter.parsers.Parser
  このパーサーは、正規表現を使用して値を構文解析し、共通ベース・イベント・オブジェクトをビルドします。 正規表現の処理には java.util.regex ライブラリーが使用されます。

このパーサーには 2 つの実行フェーズがあります。

1. グローバル処理フェーズ。 抽出から提供されたメッセージに対し、グローバルな正規表現セットが実行されます。
2. 属性処理フェーズ。 特定の置換規則セットが実行されて、 データ構造 (共通ベース・イベント 1.0.1) の各属性に割り当てる値が判別されます。

この 2 つの実行フェーズにより、 グローバル処理フェーズ時にメッセージを一連の属性値にトークン化し、 属性処理フェーズ時にその属性値を属性名または索引で参照することができます。

パーサーの一部として指定するグローバル・プロパティーは以下のとおりです。

共通ベース・イベントの個々の属性のプロパティーは以下のとおりです。

プロパティー	型	振る舞い
直前の一致置換をデフォルトとして使用する	boolean	この属性に対する現在の置換規則セットが正の一致を戻す場合、 その一致値を保管して、次のレコードを処理するときに正の一致がなかった場合のデフォルトとして使用することができます。
デフォルト値	string	この属性に対する置換規則のいずれも正の一致を提供しない場合、 またはこの属性に対する置換規則がない場合は、 ここで指定されているデフォルト値がこの属性に割り当てられます。 特定の属性ですべてのレコードに対し同じ値を必要とする場合は、 その属性のデフォルトの置換規則を作成する代わりにこのプロパティーを使用することができます。 保存された値がある場合は、「直前の一致置換をデフォルトとして使用する」が優先されることに留意してください。