この付録では、レポート・ファイル・デプロイメント・ディスクリプタの要素のリファレンスと、ディスクリプタの簡単な概要を示します。レポート・グループ・デプロイメント・ディスクリプタの要素の詳細は、付録C「レポート・グループ構成リファレンス」を参照してください。
この付録は、次の各項で構成されています。
レポート・ファイル・デプロイメント・ディスクリプタは、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">
注意:
|
表B-1は、レポート・ファイル・デプロイメント・ディスクリプタのすべての非終端要素を示しています。
使用場所: row
説明
column
要素には、レポート列を生成するために必要な情報が含まれます。column要素では、列を一意に識別するid
属性の使用がサポートされています。このIDは、column-ref
要素内で使用されます。
要素
表B-2は、column
要素のサブ要素を示しています。
表B-2 columnサブ要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
オプション |
|
|
オプション |
MBeanの属性名またはメソッド名を指定します。複合データ型の場合、name要素にスラッシュ( |
|
オプション |
列ヘッダーを指定します。この項目が省略された場合は、かわりに |
|
オプション |
列値または配列値を区切るために使用する文字を指定します。有効な値は |
|
オプション |
レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します。 |
|
オプション |
レポートの列値を非表示にするかどうかを指定します。有効な値は、 |
|
オプション |
列識別子への参照を指定します。この参照を使用して、列値を引数としてフィルタまたは別の列に渡します。 |
|
オプション |
関連付けられているMBeanの属性値に適用する計算の名前を指定します。この要素は、
|
|
オプション |
引数列またはフィルタ参照を指定します。 |
|
オプション |
定数列のデータ型を指定します。有効な値は |
|
オプション |
定数列の値を指定します。 |
|
オプション |
この列を問合せの |
|
オプション |
この列を副問合せの一部として含めるかどうかを指定します。有効な値は、 |
|
オプション |
問合せで負の値が返されるかどうかを指定します。負の値は、Coherence MBeanでは |
使用場所: filters
説明
filter
要素は、レポートで使用可能なフィルタのセットを定義します。filter要素では、フィルタを一意に識別するid
属性の使用がサポートされています。このIDは、filter-ref
要素内で使用します。
要素
表B-3は、filter
要素のサブ要素を示しています。
表B-3 filterのサブ要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
オプション |
|
|
オプション |
引数列またはフィルタ参照を指定します。 |
使用場所: report
説明
filters
要素には、filter要素のグループが含まれます。
要素
表B-4は、filters
要素のサブ要素を示しています。
説明
params
要素は、引数列またはフィルタ参照を識別します。
要素
表B-5は、params
要素のサブ要素を示しています。
表B-5 paramsのサブ要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
必須 |
フィルタIDへの参照を指定します。この参照を使用して、フィルタを引数として問合せまたは別のフィルタに渡します。 |
|
必須 |
列識別子への参照を指定します。この参照を使用して、列値を引数としてフィルタまたは別の列に渡します。 |
説明
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のサブ要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
必須 |
レポートに含めるJMX問合せまたはオブジェクト名を指定します。 |
|
オプション |
フィルタIDへの参照を指定します。この参照を使用して、フィルタを引数として問合せまたは別のフィルタに渡します。 |
|
オプション |
引数列またはフィルタ参照を指定します。 |
使用場所: report-config
説明
report
要素には、JMXベース・レポートを生成するために必要な情報が含まれます。任意の数のレポート要素を含めることができますが、通常は各レポート・ファイルに1つのレポート定義が含まれます。
要素
表B-7は、report
要素のサブ要素を示しています。
表B-7 reportのサブ要素
要素 | 必須/ オプション |
説明 |
---|---|---|
|
オプション |
レポートの説明的なヘッダーを指定します。 |
|
必須 |
生成されたレポートのファイル名を指定します。このファイル名は絶対パスか、対応するレポート・グループ・デプロイメント・ディスクリプタ内で指定されたディレクトリに対する相対パスのいずれになります。指定したファイルが存在する場合、このファイルに新しいレポート行が追加されます。存在しない場合は、新しいレポート・ファイルが作成されます。 このファイル名には、次の3つの特殊なマクロからいずれかを含むことができます。
注意: レポータの実行プロセスには、出力ファイルが作成される場所への読取り、書込みおよび作成のアクセス権が必要です。 |
|
オプション |
列値または配列値を区切るために使用する文字を指定します。有効な値は |
|
オプション |
説明と列ヘッダーをレポートに含めるかどうかを指定します。有効な値は、 |
|
オプション |
レポートのフィルタ・グループを指定します。 |
|
必須 |
レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します。 |
|
必須 |
レポート列を生成するための情報を指定します。 |
ルート要素
説明
report-config
要素は、レポート構成デプロイメント・ディスクリプタのルート要素で、レポート定義が含まれています。
要素
表B-8は、report-config
要素のサブ要素を示しています。
使用場所: report-config
説明
row
要素には、レポートに組み込む列のリストが含まれます。
要素
表B-9は、row
要素のサブ要素を示しています。