ヘッダーをスキップ
Oracle® Coherenceマネージメント・ガイド
リリース3.7.1
B71690-01
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次
前
前 		 次
次		  

B レポート・ファイル構成リファレンス

この付録では、レポート・ファイル・デプロイメント・ディスクリプタの要素のリファレンスと、ディスクリプタの簡単な概要を示します。レポート・グループ・デプロイメント・ディスクリプタの要素の詳細は、付録C「レポート・グループ構成リファレンス」を参照してください。

この付録は、次の各項で構成されています。

B.1 レポート・ファイル・デプロイメント・ディスクリプタ

レポート・ファイル・デプロイメント・ディスクリプタは、Coherence MBeanに基づいた管理情報を表示するレポートを指定します。Coherenceには、大部分のMBeanの多くの事前定義されたレポートが含まれています。デフォルト・ファイルは、/reportsディレクトリのcoherence.jarファイルにあります。レポートは必要に応じて変更できるか、または新しいレポートを作成できます。デフォルトのレポートの詳細は、第6章「レポータの内容の分析」を参照してください。

レポート・ファイル・デプロイメント・ディスクリプタ・スキーマは、coherence-report-config.xsdファイルで定義されます。このファイルは、coherence.jarライブラリのルートおよび次のWeb URLにあります。

http://xmlns.oracle.com/coherence/coherence-report-config/1.0/coherence-report-config.xsd

<report-config>要素はデプロイメント・ディスクリプタのルート要素であり、通常はXSDリファレンス、Coherenceネームスペース・リファレンス、およびcoherence-report-config.xsdファイルの場所が含まれます。次に例を示します。

<?xml version='1.0'?>

<report-config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://xmlns.oracle.com/coherence/coherence-report-config"
   xsi:schemaLocation="http://xmlns.oracle.com/coherence/coherence-report-config
   coherence-report-config.xsd">

注意:

  • xsi:schemaLocation属性でWeb URLを参照した場合でも、coherence.jarライブラリにあるスキーマは必ず実行時に使用されます。

  • xsi:schemaLocation属性を省略してスキーマ検証を無効にできます。

  • デフォルトのキャラクタ・セットがASCIIではなくEBCDICである環境にCoherenceをデプロイする場合、このデプロイメント・ディスクリプタ・ファイルがASCII形式であり、ランタイム環境にバイナリ形式でデプロイされることを確認してください。

要素リファレンス

表B-1は、レポート・ファイル・デプロイメント・ディスクリプタのすべての非終端要素を示しています。

表B-1 レポート・ファイル・デプロイメント・ディスクリプタの非終端要素

要素 使用場所

column

row

filter

filters

filters

report

params

filter、column

query

report、column

report

report-config

report-config

ルート要素

row

report-config

column

使用場所: row

説明

column要素には、レポート列を生成するために必要な情報が含まれます。column要素では、列を一意に識別するid属性の使用がサポートされています。このIDは、column-ref要素内で使用されます。

要素

表B-2は、column要素のサブ要素を示しています。

表B-2 columnサブ要素

要素 必須/
オプション		 説明

type

オプション

XmlColumn実装を指定します。type要素は、レポートの列タイプを定義します。有効な値は次のとおりです。

  • attribute: (デフォルト)MBean属性からのデータを含む列。

  • key: MBeanのキー属性からの値を含む列。

  • method: MBeanのメソッド起動の結果を含む列。

  • function: 関数または集計の結果を含む列。後述のfunction-nameを参照してください。

  • global: どのMBeanにも関連していない値を含む列。グローバルな列名は{report-time}、{report-count}および{node-id}です。

  • constant: 数値の定数文字列を含む列。

  • property: Javaのシステム・プロパティの値を含む列。

name

オプション

MBeanの属性名またはメソッド名を指定します。複合データ型の場合、name要素にスラッシュ(/)区切りの名前を含められます。

header

オプション

列ヘッダーを指定します。この項目が省略された場合は、かわりにname要素の値を使用します。

delim

オプション

列値または配列値を区切るために使用する文字を指定します。有効な値は{tab}、{space}または空白以外の文字です。

query

オプション

レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します。

hidden

オプション

レポートの列値を非表示にするかどうかを指定します。有効な値は、trueとfalseです。

column-ref

オプション

列識別子への参照を指定します。この参照を使用して、列値を引数としてフィルタまたは別の列に渡します。

function-name

オプション

関連付けられているMBeanの属性値に適用する計算の名前を指定します。この要素は、type要素がfunctionである場合にのみ有効です。有効な値は次のとおりです。

  • sum: 取得したすべての属性値の合計。

  • avg: 取得したすべての属性値の平均値。

  • min: 取得したすべての属性値の最小数値。

  • max: 取得したすべての属性値の最大数値。

  • add: 2つの列参照の値の合計。

  • subtract: 2つの列参照の値の差異。

  • multiply: 2つの列参照の値の積。

  • divide: 2つの列参照の値の比率。

params

オプション

引数列またはフィルタ参照を指定します。

data-type

オプション

定数列のデータ型を指定します。有効な値はdoubleおよびstringです。

value

オプション

定数列の値を指定します。

group-by

オプション

この列を問合せのgroup by句に含めるかどうかを指定します。有効な値は、trueとfalseです。デフォルト値はfalseです。

subquery

オプション

この列を副問合せの一部として含めるかどうかを指定します。有効な値は、trueとfalseです。デフォルト値はfalseです。

return-neg

オプション

問合せで負の値が返されるかどうかを指定します。負の値は、Coherence MBeanではerrorまたはnot availableのコードであると見なされます。デフォルトでは、これらのコードはゼロとして返されるため、列計算に影響を与えません。有効な値は、trueとfalseです。デフォルト値はfalseです。

filter

使用場所: filters

説明

filter要素は、レポートで使用可能なフィルタのセットを定義します。filter要素では、フィルタを一意に識別するid属性の使用がサポートされています。このIDは、filter-ref要素内で使用します。

要素

表B-3は、filter要素のサブ要素を示しています。

表B-3 filterのサブ要素

要素 必須/
オプション		 説明

type

オプション

XmlFilter実装を指定します。type要素は、レポートに存在するフィルタのタイプを定義します。有効な値は次のとおりです。

  • equals: 2つ以上の列参照を比較して、その結果が等しいかどうかを調べるフィルタ。

  • greater: 2つの列参照を比較して、その結果のgreater than状態を調べるフィルタ。これらのいずれかの値がnullになる場合、評価結果はfalseになります(このアプローチは、SQLにおけるNULL値の処理と同様です)。

  • less: 2つの列参照を比較して、その結果のless than状態を調べるフィルタ。これらのいずれかの値がnullになる場合、評価結果はfalseになります

  • not: フィルタ参照の論理notを返すフィルタ。

  • and: 2つのフィルタ参照の論理andを返すフィルタ。

  • or: 2つのフィルタ参照の論理orを返すフィルタ。

params

オプション

引数列またはフィルタ参照を指定します。

filters

使用場所: report

説明

filters要素には、filter要素のグループが含まれます。

要素

表B-4は、filters要素のサブ要素を示しています。

表B-4 filtersのサブ要素

要素 必須/
オプション		 説明

filter

オプション

レポート内で使用可能なフィルタのセットを指定します。

params

使用場所: column、filter

説明

params要素は、引数列またはフィルタ参照を識別します。

要素

表B-5は、params要素のサブ要素を示しています。

表B-5 paramsのサブ要素

要素 必須/
オプション		 説明

filter-ref

必須

フィルタIDへの参照を指定します。この参照を使用して、フィルタを引数として問合せまたは別のフィルタに渡します。

column-ref

必須

列識別子への参照を指定します。この参照を使用して、列値を引数としてフィルタまたは別の列に渡します。

query

使用場所: column、report

説明

query要素には、レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報が含まれます。問合せは、<pattern>要素内に入力されます。

例

レポートまたは列にすべてのノードMBeanを含めるには、次のように指定します。

<query>
   <pattern>Coherence:type=Node,*</pattern>
</query>

レポートまたは列にクラスタMBeanのみを含めるには、次のように指定します。

<query>
   <pattern>Coherence:type=Cluster</pattern>
</query>

パターン文字列を使用すると、レポート列からのランタイム値をマクロにより代入できます。たとえば、問合せパターンにキャッシュ名を作成するには、reporter.cacheNameという名前のシステム・プロパティを定義して次の構成を使用します。

<report>
   ...
   <query>
      <pattern>Coherence:type=Cache,name={CacheName},*</pattern>
   </query>
   <row>
      <column id="CacheName">
         <type>property</type>
         <name>reporter.cacheName</name>
      </column>
   </row>
</report>

場合によって、問合せパターンの結果が、よく知られているキー属性を持つMBean名のリストになることがあります。関連付けられた(結合済の)MBeanから属性を取得するには、このキー属性を使用できます。たとえば、Coherence:type=Service,*パターンの結果は、Coherence:type=Service,nodeId=NNNフォーマットのMBeanになることが分かっているため、次の構成を使用して、MemberName属性を対応するNodeMBeanから出力するとともに、ServiceMBeanのServiceName属性も出力します。

<report>
   ...
   <query>
      <pattern>Coherence:type=Service,*</pattern>
      <params>
         <column-ref>MemberName</column-ref>
         <column-ref>NodeId</column-ref>
         <column-ref>ServiceName</column-ref>
      </params>
   </query>
   <row>
      <column id="MemberName">
         <type>attribute</type>
         <name>MemberName</name>
         <query>
            <pattern>Coherence:type=Node,nodeId={NodeId}</pattern>
         </query>
      </column>
      <column id="NodeId">
         <type>key</type>
         <name>nodeId</name>
      </column>
      <column id="ServiceName">
         <type>key</type>
         <name>name</name>
      </column>
   </row>
</report>

要素

表B-6は、query要素のサブ要素を示しています。

表B-6 queryのサブ要素

要素 必須/
オプション		 説明

pattern

必須

レポートに含めるJMX問合せまたはオブジェクト名を指定します。

filter-ref

オプション

フィルタIDへの参照を指定します。この参照を使用して、フィルタを引数として問合せまたは別のフィルタに渡します。

params

オプション

引数列またはフィルタ参照を指定します。

report

使用場所: report-config

説明

report要素には、JMXベース・レポートを生成するために必要な情報が含まれます。任意の数のレポート要素を含めることができますが、通常は各レポート・ファイルに1つのレポート定義が含まれます。

要素

表B-7は、report要素のサブ要素を示しています。

表B-7 reportのサブ要素

要素 必須/
オプション		 説明

description

オプション

レポートの説明的なヘッダーを指定します。

file-name

必須

生成されたレポートのファイル名を指定します。このファイル名は絶対パスか、対応するレポート・グループ・デプロイメント・ディスクリプタ内で指定されたディレクトリに対する相対パスのいずれになります。指定したファイルが存在する場合、このファイルに新しいレポート行が追加されます。存在しない場合は、新しいレポート・ファイルが作成されます。

このファイル名には、次の3つの特殊なマクロからいずれかを含むことができます。

  • {sequence}: このマクロは実行カウンタ(順序番号)と置き換えられ、これを使用して各レポート実行の新規ファイルを生成します。

  • {node}: このマクロは、レポート実行メンバーのメンバーIDと置き換えられます。このマクロを使用して、異なるクラスタ・メンバーで実行されたレポートの各種ファイルを作成します。

  • {date}: このマクロは現在の日付(YYYYMMDD)に置き換えられます。

注意: レポータの実行プロセスには、出力ファイルが作成される場所への読取り、書込みおよび作成のアクセス権が必要です。

delim

オプション

列値または配列値を区切るために使用する文字を指定します。有効な値は{tab}、{space}または空白以外の文字です。

hide-headers

オプション

説明と列ヘッダーをレポートに含めるかどうかを指定します。有効な値は、trueとfalseです。

filters

オプション

レポートのフィルタ・グループを指定します。

query

必須

レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します。

row

必須

レポート列を生成するための情報を指定します。

report-config

ルート要素

説明

report-config要素は、レポート構成デプロイメント・ディスクリプタのルート要素で、レポート定義が含まれています。

要素

表B-8は、report-config要素のサブ要素を示しています。

表B-8 report-configのサブ要素

要素 必須/
オプション		 説明

report

必須

JMXベース・レポートを生成するために必要な情報を指定します。

row

使用場所: report-config

説明

row要素には、レポートに組み込む列のリストが含まれます。

要素

表B-9は、row要素のサブ要素を示しています。

表B-9 rowのサブ要素

要素 必須/
オプション		 説明

column

必須

レポート列を生成するためにレポータが使用する情報を指定します。

  前
前 		 次
次
  ドキュメント・ライブラリへ移動
ライブラリ		 製品リストへ移動
製品		 目次へ移動
目次