モデルのパフォーマンス ビューの作成

内容
casp1032jp
内容
デフォルトでは、一部のモデル タイプは、一定期間にわたる属性(CPU やメモリの使用率など)の変化を示すパフォーマンス ビューを使用するように設定されています。OneClick では、このビューにはコンポーネント詳細画面の[パフォーマンス]タブをクリックしてアクセスします。
SPEC--perf_view
パフォーマンス ビューは、以下の 2 つの XML ファイルで構成されます。
  • パフォーマンス データ設定ファイル
    この XML ファイルは、[パフォーマンス]タブ内の任意のグラフに表示できるデータを指定します。通常、このデータには、関連するモデル タイプの属性が含まれます。
  • パフォーマンス ビュー設定ファイル
    この XML ファイルは、[パフォーマンス]タブ内で表示可能な各グラフの外観を定義します。各グラフには、パフォーマンス データ設定ファイルに定義されている任意の折れ線を表示できます。
いずれかのデフォルト パフォーマンス ビューのデータまたは形式が要件を満たしていない場合は、特定のモデル タイプまたはモデル クラス用にビューをカスタマイズできます。たとえば、デバイスでサポートされている他の MIB のサポートを
CA Spectrum
 で追加した場合は、その MIB で使用可能な一部のデータのグラフを表示するようにビューをカスタマイズできます。また、独自のカスタム パフォーマンス ビューを作成することもできます。
OneClick で現在選択されているモデル用にパフォーマンス ビューが設定されていない場合、[パフォーマンス]タブは無効になります。
新しいパフォーマンス ビューの作成
モデル タイプまたはモデル クラスのパフォーマンス ビューをゼロから作成する場合、
<$SPECROOT>
/custom/topo/config ディレクトリに、ビューを定義する設定ファイルを配置する必要があります。これにより、
CA Spectrum
のアップグレード中にそれらが上書きされなくなります。
ビューのパフォーマンス データ設定ファイルは、custom-app-config.xml という名前のファイルの該当する各モデル タイプまたはモデル クラスに関連付けます。これを行うには、<contents-registry> エレメントまたは <component-details-registry> エレメントのいずれかを使用できますが、ベスト プラクティスは、<component-details-registry> エレメントを使用することです。このエレメントでは、特定のモデル タイプまたはモデル クラス用のコンポーネント詳細画面のみを設定するためです。使用可能なさまざまなレジストリの説明については、第 5 章「モデル タイプまたはモデル クラスのサポートの追加」を参照してください。
新しいパフォーマンス ビューの作成方法
  1. <$SPECROOT>
    /custom/topo/config ディレクトリに、ビューでグラフ化されるデータを指定するパフォーマンス データ設定ファイルを作成します。
  2. <$SPECROOT>
    /custom/topo/config ディレクトリに、ビューの各グラフの外観を定義するパフォーマンス ビュー設定ファイルを作成します。
  3. custom-app-config.xml で、パフォーマンス データ設定ファイルを該当するモデル タイプまたはモデル クラスに関連付けます。
    1. ファイルが存在しない場合は、
      <$SPECROOT>
      /tomcat/webapps/spectrum/WEB-INF/console/config/
      custom-app-config.xml を 
      <$SPECROOT>
      /custom/console/config ディレクトリにコピーします。
      注:
       指定した場所にファイルをコピーしてください。
      CA Spectrum
      に同梱されているデフォルトの custom-app-config.xml ファイルは、新しいバージョンにアップグレードするときに上書きされるため、変更しないでください。
    2. custom-app-config.xml で、テキスト エディタを使用して以下の例のような XML コードのブロックを追加します。このコードは、パフォーマンス設定データ ファイルに該当するモデル タイプおよびモデル クラスをリンクします。
      以下の XML コードの例では、ID が 0x3250004 のモデル タイプを、
      <$SPECROOT>
      /custom/topo/config/
      performance-data-ciscovoiceapp-config.xml という名前のパフォーマンス データ設定ファイルに関連付けます。
         <component-details-registry>      <performance-config>performance-data-ciscovoiceapp-config</performance-config>      <model-type>0x3250004</model-type>      <!-- CiscoVoiceApp -->    </component-details-registry>
      注:
       複数のモデル クラスおよびモデル タイプはコンテンツまたはコンポーネント詳細レジストリ内で指定できます。また、パフォーマンス ビューは、1 つ以上の <contents-registry> エレメントで再利用できます。
    3. custom-app-config.xml ファイルを[保存して閉じる]。
  4. OneClick クライアントを再起動して変更を有効にします。
パフォーマンス データ設定ファイルの作成
パフォーマンス データ設定ファイル
は、[パフォーマンス]タブ内の任意のグラフに表示できるデータを指定します。この XML ファイルの推奨される命名規則は、performance-<descriptor>-data-config.xml です。
以下の表で説明されている XML エレメントを使用して、パフォーマンス データ設定ファイルを作成します。
エレメント
親エレメント
Description
performance-config
該当なし
最上位の親エレメントを表します。
パフォーマンス ビュー設定ファイルで <graph> エレメントの複数のインスタンスを使用して、パフォーマンス ビュー用の複数のグラフを指定します。
表示
performance-config
グラフ データを提示するためのビューを定義する XML ファイルを指定します。
この名前は、実際のパフォーマンス ビュー設定ファイルの名前に正確に一致する必要があります。
折れ線グラフ
performance-config
グラフ内の折れ線を定義します。
名前
折れ線グラフ
グラフに表示される、<line> 親エレメントによって定義される折れ線のラベル(名前)を指定します。名前の値は、パフォーマンス グラフ ビュー設定ファイルの対応する折れ線定義に一致する必要があります。
リスト属性をグラフ化する場合、名前エレメントの attr-id 属性も指定できます。これは、リスト内の各インスタンスの名前に追加される値を持つ属性 ID を指定します。指定しない場合、インスタンス番号がリストの各インスタンスの名前に追加されます。
以下の例では、属性 0x12ac6 は、<list-content> によって定義された複数の折れ線のラベルのリストを表します。
<line>
<name attr-id="0x12ac6">
     メモリ使用率
 </name>
 <list-content>
  <attribute>0x12ac6</attribute>
 </list-content>
</line>
コンテンツ
折れ線グラフ
<line> 親エレメントによって定義される単一の折れ線としてグラフ化されるスカラー データを指定します。例:
<content>
<attribute>0x2100cc</attribute>
</content>
list-content
折れ線グラフ
<line> 親エレメントによって定義される複数の折れ線としてグラフ化されるリスト データを指定します。
以下の例では、属性 0x12ac6 は、メモリ使用率を表す整数リスト属性です。リスト内の各インスタンスごとに別個の折れ線がグラフ化されます。
<line>
<name attr-id="0x12ac6">
  メモリ使用率
 </name>
 <list-content>
   <attribute>0x12ac6</attribute>
 </list-content>
</line>
attribute(属性)
content、
list-content
<line> 親エレメントによって定義される折れ線としてグラフ化される属性の ID を指定します。
content、
list-content
列の値を生成するための式を定義するために使用します。例:
(attrInt( 0xd054c ) + attrInt( 0xd054d ))/8
アプリケーション
折れ線グラフ
また、関連するアプリケーション モデルからデータをグラフ化することもできます。<applications> エレメント内で、<model-type> エレメントを使用して、関連するアプリケーション モデルのモデル タイプ ハンドルを指定します。コンテキスト内のモデルにこのタイプのアプリケーション モデルが関連付けられている場合、そのアプリケーション モデルからデータが取得されます。
<applications>
<model-type>0xc40043</model-type>
</applications>
model-type
アプリケーション
データの取得先となるアプリケーション モデルのモデル タイプ ハンドルです。コンテキスト内のモデルにこのタイプのアプリケーション モデルが関連付けられていない場合、折れ線は表示されません。
以下の例では、Cisco デバイスの一定期間にわたるアクティブな VoIP コールと合計 VoIP コールの変化を示す 2 線のパフォーマンス グラフに表示されるデータを指定します。
<performance-config id="performance-data-ciscovoiceapp-config"> <display>performance-ciscovoiceapp-config</display> <line> <name>Active VoIP Calls</name> <content>         <attribute>0x325012b</attribute><!-- VoIP_Current_Calls --> </content> </line> <line> <name>Total VoIP Calls</name> <content>         <attribute>0x3250129</attribute> <!-- VoIP_Total_Calls --> </content> </line> </performance-config>
注:
 パフォーマンス データ設定ファイルの他のより複雑な例については、
CA Spectrum
に含まれるパフォーマンス ビューのサポート ファイルを参照してください。これらのファイルを見つけるには、
<$SPECROOT>
/tomcat/webapps/spectrum/WEB-INF ディレクトリを参照して、perf* という名前のファイルを検索します。
パフォーマンス ビュー設定ファイルの作成
パフォーマンス ビュー設定ファイル
は、[パフォーマンス]タブ内で利用可能な各グラフの外観を定義します。この XML ファイルの推奨される命名規則は、performance-<descriptor>-view-config.xml です。
以下の表で説明されている XML エレメントを使用して、パフォーマンス ビュー設定ファイルを作成します。
エレメント
親エレメント
Description
performance-view
該当なし
最上位の親エレメントを表します。
graph
performance-view
パフォーマンス ビュー設定ファイル内では、複数のグラフを設定できます。各グラフは、この <graph> エレメントによって表されます。このエレメントの ID 属性はグラフのタイトルとして使用され、ビューのプルダウン メニュー(1 つのモデル用の複数のグラフ間の切り替えに使用する)に表示されます。
<graph id="CPU Utilization">
<y-axis-label>Utilization</y-axis-label>
<y-axis-units>%</y-axis-units>
<line>
    <name>CPU Utilization</name>
</line>
</graph>
y-axis-label
graph
Y 軸のラベルを指定します。
y-axis-units
graph
Y 軸の単位を指定します(% や bps など)。
折れ線グラフ
graph
グラフの折れ線を定義します。例:
<line color="#ffff00">
色属性を使用して、使用する色の 16 進数 RGB 値を指定します。
名前
折れ線グラフ
<line> 親エレメントによって定義される折れ線のラベルを指定します。
この値は、ビューのデータを定義するパフォーマンス データ設定ファイル内の同じ折れ線の値に一致する必要があります。
リスト属性をグラフ化する場合、名前エレメントの attr-id 属性も指定できます。これは、リスト内の各インスタンスの名前に追加される値を持つ属性 ID を表します。指定しない場合、インスタンス番号がリストの各インスタンスの名前に追加されます。
display-if
折れ線グラフ
<expression> 子エレメントで定義されている式が TRUE に評価された場合にのみ、グラフに折れ線を表示するように指定します。
display-if
折れ線をグラフ化するかどうかに関する複雑な条件を定義する式を定義するために使用します。
詳細については、第 9 章「すべてのカスタマイズ ファイル共通な XML の使用方法」を参照してください。
fill
折れ線グラフ
このエレメントが含まれている場合、折れ線の下の領域が色で塗りつぶされます。
以下の例では、Cisco デバイスの一定期間にわたるアクティブな VoIP コールと合計 VoIP コールの変化を示す 2 線のパフォーマンス グラフの形式を指定します。
注:
 これは、「パフォーマンス データ設定ファイルの作成」で定義したデータのサンプル グラフの形式です。
<performance-view id="performance-ciscovoiceapp-config"> <graph id="VoIP Calls Title"> <y-axis-label>Calls</y-axis-label> <y-axis-units>unit</y-axis-units> <line>    <name>Active VoIP Calls</name> </line> <line>     <name>Total VoIP Calls</name> </line> </graph> </performance-view>
注:
 パフォーマンス ビュー設定ファイルの他のより複雑な例については、
CA Spectrum
に含まれるパフォーマンス ビューのサポート ファイルを参照してください。これらのファイルを見つけるには、
<$SPECROOT>
/tomcat/webapps/spectrum/WEB-INF ディレクトリを参照して、perf* という名前のファイルを検索します。
既存のパフォーマンス ビューのカスタマイズ
一般に、既存のパフォーマンス ビューをカスタマイズするには、そのビューのデフォルト設定ファイルを、カスタマイズが含まれるバージョンで上書きします。
既存のパフォーマンス ビューをカスタマイズする方法
  1. カスタマイズするパフォーマンス ビューを定義するデフォルト設定ファイルを識別します。
    1. <$SPECROOT>
      /tomcat/webapps/spectrum/WEB-INF/topo/config/
      topo-app-config.xml ファイルを開き、該当するモデル タイプまたはモデル クラスの <contents-registry> または <component-details-registry> エレメントを見つけます。
      注:
       モデルがモデル タイプとモデル クラスの両方の登録に適格な場合、モデル タイプの登録が優先的に適用されます。また、コンテンツ レジストリとコンポーネント詳細レジストリの両方でパフォーマンス ビュー設定を定義できる場合でも、コンポーネント詳細レジストリが優先されます。コンテンツ レジストリは主にモデルの外観の定義に使用され、通常はモデル クラスのみに適用されます。
    2. <contents-registry> または <component-details-registry> エレメント内で <performance-config> エレメントを見つけ、指定されているパフォーマンス データ設定ファイルの名前をメモします。
      注:
      すべてのデフォルト パフォーマンス設定ファイル(データ設定ファイルとビュー設定ファイル)は、
      <$SPECROOT>
      /tomcat/webapps/spectrum/WEB-INF/*/config ディレクトリに存在します。
    3. ディレクトリ
      <$SPECROOT>
      /tomcat/webapps/spectrum/WEB-INF/topo/config を開き、前の手順で識別したパフォーマンス データ設定ファイルを開きます。
    4. <performance-config> エレメント内で <display> エレメントを見つけ、指定されているパフォーマンス ビュー設定ファイルの名前をメモします。
  2. 手順 1 で識別したパフォーマンス設定ファイルの一方または両方を、
    <$SPECROOT>
    /custom/topo/config ディレクトリにコピーします。ファイルをコピーする必要があるのは、カスタマイズが必要な場合のみです。
    注:
     ファクトリ デフォルトのパフォーマンス設定ファイルを上書きするには、コピーする(カスタマイズが含まれている)ファイルの名前が元のデフォルト ファイルと同じである必要があります。
  3. 必要に応じて、コピーしたパフォーマンス データ設定ファイルを要件に従って変更し、ファイルを[保存して閉じる]。
  4. 必要に応じて、コピーしたパフォーマンス ビュー設定ファイルを要件に従って変更し、ファイルを[保存して閉じる]。
  5. 必要に応じて、custom-app-config.xml で、パフォーマンス データ設定ファイルに関連付けられているモデル タイプまたはモデル クラスを変更します。
    1. ファイルが存在しない場合は、
      <$SPECROOT>
      /tomcat/webapps/spectrum/WEB-INF/console/config/
      custom-app-config.xml を 
      <$SPECROOT>
      /custom/console/config ディレクトリにコピーします。
      注:
       指定した場所にファイルをコピーしてください。
      CA Spectrum
      に同梱されているデフォルトの custom-app-config.xml ファイルは、新しいバージョンにアップグレードするときに上書きされるため、変更しないでください。
    2. custom-app-config.xml で、テキスト エディタを使用して以下の例のような XML コードのブロックを追加します。このコードは、パフォーマンス設定データ ファイルに該当するモデル タイプおよびモデル クラスをリンクします。
      以下の XML コードの例では、ID が 0x3250004 のモデル タイプを、
      <$SPECROOT>
      /custom/topo/config/
      performance-data-ciscovoiceapp-config.xml という名前のパフォーマンス データ設定ファイルに関連付けます。
         <component-details-registry>      <performance-config>performance-data-ciscovoiceapp-config</performance-config>      <model-type>0x3250004</model-type>      <!-- CiscoVoiceApp -->    </component-details-registry>
      注:
       複数のモデル クラスおよびモデル タイプはコンテンツまたはコンポーネント詳細レジストリ内で指定できます。また、パフォーマンス ビューは、1 つ以上の <contents-registry> エレメントで再利用できます。
      custom-app-config.xml 内の <component-details-registry> エレメントは、*-app-config.xml ファイル内のモデル タイプまたはモデル クラスの相当する登録を
      オーバーライド
      します。これらの登録は、
      <$SPECROOT>
      /tomcat/webapps/spectrum/WEB-INF/*/config/
      *-app-config.xml のファクトリ XML ファイルで使用されます。
    3. custom-app-config.xml ファイルを[保存して閉じる]。
  6. OneClick クライアントを再起動して変更を有効にします。