レポート・ファイル構成リファレンスは、レポート・ファイルのデプロイメント・ディスクリプタ要素の詳細な説明を提供します。
この付録の内容は次のとおりです。
coherence.jar/reports
ディレクトリには、多くの事前定義済レポート・ファイルが含まれます。レポート内容の分析を参照してください。これらのレポートを変更するか、必要に応じて新しいレポートを作成します。レポート・ファイル・デプロイメント・ディスクリプタ・スキーマは、coherence-report-config.xsd
ファイルで定義されます。このファイルは、coherence.jar
ライブラリのルートおよび次のWeb URLにあります。
http://xmlns.oracle.com/coherence/coherence-report-config/1.1/coherence-report-config.xsd
<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">
注意:
coherence.jar
ライブラリにあるスキーマは、xsi:schemaLocation
属性がWeb URLを参照する場合であっても、常に実行時に使用されます。
スキーマ検証を無効にするには、xsi:schemaLocation
属性を省略します。
デフォルトの文字セットがASCIIではなくEBCDICである環境にOracle Coherenceをデプロイする場合、デプロイメント・ディスクリプタ・ファイルがASCII形式であり、ランタイム環境にバイナリ形式でデプロイされることを確認してください。
使用場所: row
説明
column
要素には、レポート列を生成するために必要な情報が含まれます。column要素では、列を一意に識別するid
属性の使用がサポートされています。このIDは、column-ref
サブ要素内で使用されます。
要素
表B-1は、column
要素のサブ要素を示しています。
表B-1 columnサブ要素
要素 | 必須/ オプション | 説明 |
---|---|---|
|
オプション |
|
|
オプション |
MBeanの属性名またはメソッド名を指定します。複合データ型の場合、 |
|
オプション |
列ヘッダーを指定します。この項目が省略された場合、 |
|
オプション |
列値または配列値を区切る文字を指定します。有効な値は |
オプション |
レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します。 |
|
|
オプション |
レポートの列値を非表示にするかどうかを指定します。有効な値は、 |
|
オプション |
列識別子への参照を指定します。この参照によって、列値が引数としてフィルタまたは別の列に渡されます。 |
|
オプション |
関連付けられているMBeanの属性値に適用する計算の名前を指定します。この要素は、
|
オプション |
引数列またはフィルタ参照を指定します |
|
|
オプション |
定数列のデータ型を指定します。有効な値は |
|
オプション |
定数列の値を指定します |
|
オプション |
この列を問合せの |
|
オプション |
この列を副問合せの一部として含めるかどうかを指定します。有効な値は、 |
|
オプション |
問合せで負の値が返されるかどうかを指定します。負の値は、Oracle Coherence MBeanでは |
使用場所: filters
説明
filter
要素は、レポートで使用するフィルタを定義します。filter要素では、フィルタを一意に識別するid
属性の使用がサポートされています。IDは、filter-ref
要素を持つフィルタを示すときに使用します。フィルタをparams
要素およびquery
要素内から参照できます。
要素
表B-2は、filter
要素のサブ要素を示しています。
表B-2 filterのサブ要素
要素 | 必須/ オプション | 説明 |
---|---|---|
|
オプション |
|
オプション |
引数列またはフィルタ参照を指定します |
説明
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名のリストになることがあります。key
属性を使用して、関連付けられた(結合済の)MBeanから属性を取得してください。たとえば、Coherence:type=Service,*
パターンの結果は、Coherence:type=Service,nodeId=NNN
フォーマットのMBeanになることがわかっているため、次の構成では、対応するNodeMBean
のMemberName
属性を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>
使用場所: report-config
説明
report
要素には、JMXベース・レポートを生成するために必要な情報が含まれます。レポートには任意の数のreport
要素を含められますが、レポート・ファイルには通常、単一のレポート定義が含まれます。
要素
表B-6は、report
要素のサブ要素を示しています。
表B-6 reportのサブ要素
要素 | 必須/ オプション | 説明 |
---|---|---|
|
オプション |
関連付けられたレポートまたは列の説明的な見出しを指定します。 |
|
必須 |
生成されたレポートのファイル名を指定します。このファイル名は絶対パスか、対応するレポート・グループ・デプロイメント・ディスクリプタで指定されているディレクトリへの相対パスで指定します。指定したファイルが存在する場合、このファイルに新しいレポート行が追加されます。存在しない場合は、新しいレポート・ファイルが作成されます。 このファイル名には次の3つのマクロが含まれています。
注意: レポータの実行プロセスには、レポートの出力ディレクトリへの読取り、書込みおよび作成の権限が必要です。 |
|
オプション |
列値または配列値を区切る文字を指定します。有効な値は |
|
オプション |
レポートに説明と列ヘッダーを含めるかどうかを指定します。有効な値は、 |
オプション |
レポートのフィルタ・グループを指定します |
|
必須 |
レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します |
|
必須 |
レポート行を生成するための情報を指定します |