（オプション）<ComponentReconciliation> セクションの追加

Web サービスの使用 › カスタムメトリックファミリを作成する方法 › カスタムメトリックファミリの XML ファイルの作成 › （オプション）<ComponentReconciliation> セクションの追加

（オプション）<ComponentReconciliation> セクションの追加

<ComponentReconciliation> セクション内で、カスタムメトリックファミリに対して照合アルゴリズムを定義できます。照合アルゴリズムは、監視対象デバイスの設定変更をサポートするために使用します。デバイスが、あるメトリックファミリをどのようにサポートするのかは、その設定と考えることができます。たとえば、インターフェースの数およびその設定は、デバイスが［インターフェース］メトリックファミリをサポートする方法を表しています。デバイスのインターフェースに対する変更が発生した場合、Data Aggregator は監視が最新のものであることを保証するために、これらのインターフェースの表現を更新する必要があります。照合アルゴリズムは、この設定の更新中に適用されます。

特定のメトリックファミリのサポートでは、個々のコンポーネントアイテムが Data Aggregator で作成されます。これらのコンポーネントアイテムは、特定のメトリックファミリをサポートするデバイス設定を表します。 Data Aggregator は、例のように［インターフェース］メトリックファミリを使用して、ポートのコンポーネントアイテムを作成して、デバイスの各ネットワークインターフェースを表します。

最初のディスカバリおよびコンポーネントアイテムの作成は、デバイスコレクションを通してデバイスに監視プロファイルが適用されたときに発生します。監視対象デバイスの変更のサポートが必要であれば、続いてコンポーネントのディスカバリが発生します。以降のコンポーネントディスカバリでは、一連のコンポーネントアイテムを更新するのに必要な変更を決定するために、照合アルゴリズムが適用されます。

デバイスの設定が変更された場合には、判断が必要な 4 つのシナリオがあります。

新規コンポーネント - このような新規コンポーネントアイテムが Data Aggregator で必要なため、デバイスが変更されました。
変更されないコンポーネント - あるデバイスの設定変更によって、既存のいくつかのコンポーネントは変わらなかったため、これらのコンポーネントアイテムは変更されていません。
変更されたコンポーネント - デバイス設定が一部のコンポーネントを変更しましたが、未だ存在しています。 Data Aggregator 内のコンポーネントアイテムは、新しい設定を反映するために更新する必要があります。
削除されたコンポーネント - あるデバイスは、デバイスに存在していない 1 つ以上のコンポーネントを変更します。これらのコンポーネントアイテムは削除または廃止できます。

照合アルゴリズムは、既存のコンポーネントアイテムと新規のディスカバリ結果を比較することができる属性のセットを定義します。属性の値が比較され、既存のコンポーネントアイテムと一致する新規のディスカバリ結果が判断され、また、新規または変更済みのコンポーネントが表示されます。この比較によって以下の結果が生じます。

ディスカバリ結果が既存のコンポーネントアイテムと一致しない場合は、新規コンポーネントアイテムが作成されます。
ディスカバリ結果が既存のコンポーネントアイテムのすべての属性と一致する場合は、コンポーネントアイテムは変更されません。
ディスカバリ結果の一部が一致し、いくつかの属性値が異なる場合、既存のコンポーネントアイテムは新しい属性値に更新されます。
ディスカバリの結果により、既存のいくつかのコンポーネントアイテムが新しい結果と一致しない、と判断されることがあります。この場合、これらのコンポーネントはデバイスに存在しないと判断され、削除また廃棄することができます。

照合アルゴリズムでは、一致の 2 つのタイプとして ExactMatch と BestofMatch を定義できます。

ExactMatch: ディスカバリ結果が、指定したコンポーネントアイテムのすべての属性と一致する必要があることを指します。

例：ExactMatch 照合アルゴリズム

以下の例は、ExactMatch 一致タイプを定義する照合アルゴリズムを示しています。

<ComponentReconciliation>
     <MatchAlgorithmList>
          <MatchAlgorithm>
               <AlgorithmType>Exact</AlgorithmType>
               <MatchAttributeList>
                    <MatchAttribute>
                         <Name>{http://im.ca.com/core}Item.Name</Name>
                    </MatchAttribute>
                    <MatchAttribute>
                         <Name>{http://im.ca.com/inventory}Process.Path</Name>
                    </MatchAttribute>
                    <MatchAttribute>
                         <Name>{http://im.ca.com/inventory}Process.Arguments</Name>
                    </MatchAttribute>
               </MatchAttributeList>
          </MatchAlgorithm>
     </MatchAlgorithmList>
</ComponentReconciliation>

このアルゴリズムは、ディスカバリの結果が既存コンポーネントアイテムの 3 つのすべての属性と一致した場合のみ完全一致になることを示しています。完全一致にならない場合は、以下のいずれかの状態に応じて結果が生じます。

3 つの属性値のいずれかが異なる場合は、新規コンポーネントアイテムが作成されます。
3 つの属性値が一致し、その他の属性値が異なる場合は、既存のコンポーネントアイテムが新しい属性値で更新されます。

BestofMatch: 既存のコンポーネントアイテムの属性と同じ数だけ一致する必要がある属性の最小数を指定します。各属性には 1 つの「必須」キーが含まれています。「必須」キーが［true］に設定されていれば、その属性は一致属性のうちの 1 つです。

例：BestofMatch 照合アルゴリズム

以下の例は、BestofMatch 一致タイプを定義する照合アルゴリズムを示しています。

<ComponentReconciliation>
     <MatchAlgorithmList>
          <MatchAlgorithm>
               <AlgorithmType>BestOf</AlgorithmType>
               <LeastMatchCount>2</LeastMatchCount>
               <MatchAttributeList>
                    <MatchAttribute>
                         <Required>true</Required>
                         <Name>{http://im.ca.com/core}Item.Name</Name>
                    </MatchAttribute>
                    <MatchAttribute>
                         <Name>{http://demo/custom}Process.Path</Name>
                    </MatchAttribute>
                    <MatchAttribute>
                         <Name>{http://demo/custom}Process.Arguments</Name>
                    </MatchAttribute>
               </MatchAttributeList>
          </MatchAlgorithm>
     </MatchAlgorithmList>
</ComponentReconciliation>

このアルゴリズムは以下の要件を定めています。

ディスカバリ結果が BestofMatch 一致になるには、一覧表示された属性の少なくとも 2 つと既存のコンポーネントアイテムが一致する必要があります。 BestofMatch 一致にならない場合は、以下の状態に応じて結果が生じます。
- 2 つ未満の属性が一致した場合、新しいコンポーネントアイテムが作成されます。
- 少なくとも 2 つの属性値が一致し、その他の属性値が異なる場合は、既存のコンポーネントアイテムが新しい属性値で更新されます。
  注：一致させる属性値のうちの 1 つは必須属性である必要があります。
Name 属性の「必須」キーは［true］に設定されます。これは、一致させる 3 つの属性うちの 1 つが Name 属性である必要があることを意味します。

BestOf 一致アルゴリズムが照合定義に含まれている場合、以下の結果が発生します。

ディスカバリ結果が既存の 1 つのコンポーネントアイテムにのみ一致する場合、結果は一致です。
ディスカバリ結果が既存の複数のコンポーネントアイテムに一致する場合、一致する属性の数が考慮されます。最もよく一致する属性を持った既存のコンポーネントが、ディスカバリ結果に一致すると見なされます。
注：一致属性の数が複数のコンポーネントで同じ場合、一致するコンポーネントアイテムはランダムで選択されます。結果として、karaf ログは、この条件に関する警告を記録します。

ユーザは複数の一致アルゴリズムを照合定義に追加することができます。複数の一致アルゴリズムが追加された場合は、一致の優先順位があります。 MatchAlgorithmList の一番上の一致アルゴリズムの優先順位が最も高くなります。一番下の一致タイプの優先順位が最も低くなります。

照合定義に複数の一致タイプが含まれている場合は、以下の結果が生じます。

ディスカバリ結果が既存の 1 つのコンポーネントアイテムのみに一致する場合、結果は一致です。アルゴリズムの優位性は重要ではありません。
ディスカバリ結果が、既存の複数のコンポーネントアイテムに一致する場合は、最も高い優位性を持つアルゴリズムが優先されます。最も高い優位性のアルゴリズムに起因するコンポーネントアイテムが一致となります。
例：

アルゴリズム 1 がより高い優位性を持っているため、ディスカバリ結果 A はコンポーネント 1 一致します。
複数のディスカバリ結果が、既存の 1 つのコンポーネントアイテムに一致する場合は、最も高い優位性を持つアルゴリズムが優先されます。最も高い優位性のアルゴリズムの結果として一致したコンポーネントアイテムが一致となります。
例：

アルゴリズム 1 がより高い優位性を持っているため、ディスカバリ結果 A はコンポーネント 1 に一致します。

例：

この例では、ディスカバリ結果 B は、コンポーネント 2 よりも多くの属性を持つコンポーネント 1 に一致します。 2.ディスカバリ結果 A はコンポーネント 1 に一致します。これは、より優位性の高いアルゴリズムで一致するためです。このため、コンポーネント 1 の一致はディスカバリ結果 A となり、ディスカバリ結果 B はコンポーネント 2. 2 に一致します。

注：照合アルゴリズムを定義していない場合、Data Aggregator は Item.Name 属性を使用してコンポーネントを照合します。

詳細：

カスタムメトリックファミリの XML ファイルの作成