B レポート・ファイル構成要素

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

この付録の内容は次のとおりです。

• レポート・ファイル・デプロイメント・ディスクリプタ
  
• レポート・ファイル要素リファレンス
  

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

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

レポート・ファイル・デプロイメント・ディスクリプタ・スキーマは、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-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形式であり、ランタイム環境にバイナリ形式でデプロイされることを確認してください。

B.2 レポート・ファイル要素リファレンス

この項では、次の項目について説明します。

• レポート・ファイル要素の索引
  
• column
  
• filter
  
• filters
  
• params
  
• query
  
• report
  
• report-config
  
• row
  

B.2.1 レポート・ファイル要素の索引

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

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

要素	使用場所
column	row
filter	filters
filters	report
params	filter、column
query	report、column
report	report-config
report-config	ルート要素
row	report-config

B.2.2 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	オプション	問合せで負の値が返されるかどうかを指定します。負の値は、Oracle Coherence MBeanではerrorまたはnot availableのコードであると見なされます。デフォルトでは、これらのコードではゼロが返されるため、列計算には影響しません。有効な値は、trueおよびfalseです。デフォルト値はfalseです。

B.2.3 filter

使用場所: filters

説明

filter要素は、レポートで使用するフィルタを定義します。filter要素では、フィルタを一意に識別するid属性の使用がサポートされています。IDは、filter-ref要素を持つフィルタを示すときに使用します。フィルタをparams要素およびquery要素内から参照できます。

要素

表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	オプション	引数列またはフィルタ参照を指定します

B.2.4 filters

使用場所: report

説明

filters要素には、任意の数のfilter要素が含まれます。

要素

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

表B-4 filtersのサブ要素

要素	必須/ オプション	説明
filter	オプション	レポートで使用するフィルタを定義します

B.2.5 params

使用場所: column、filter、query

説明

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

要素

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

表B-5 paramsのサブ要素

要素	必須/ オプション	説明
filter-ref	必須	フィルタIDへの参照を指定します。この参照によって、フィルタが引数として問合せまたは別のフィルタに渡されます。
column-ref	必須	列識別子への参照を指定します。この参照によって、列値が引数としてフィルタまたは別の列に渡されます。

B.2.6 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名のリストになることがあります。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>

要素

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

表B-6 queryのサブ要素

要素	必須/ オプション	説明
pattern	必須	レポートに含めるJMX問合せまたはオブジェクト名を指定します
filter-ref	オプション	フィルタIDへの参照を指定します。この参照によって、フィルタが引数として問合せまたは別のフィルタに渡されます。
params	オプション	引数列またはフィルタ参照を指定します

B.2.7 report

使用場所: report-config

説明

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

要素

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

表B-7 reportのサブ要素

要素	必須/ オプション	説明
description	オプション	関連付けられたレポートまたは列の説明的な見出しを指定します。
file-name	必須	生成されたレポートのファイル名を指定します。このファイル名は絶対パスか、対応するレポート・グループ・デプロイメント・ディスクリプタで指定されているディレクトリへの相対パスで指定します。指定したファイルが存在する場合、このファイルに新しいレポート行が追加されます。存在しない場合は、新しいレポート・ファイルが作成されます。 このファイル名には次の3つのマクロが含まれています。 {batch}: このマクロはカウンタ(順序番号)に置き換えられます。 {node}: このマクロはクラスタ・メンバーIDに置き換えられます。このマクロは、様々なクラスタ・メンバーのレポートを区別するために使用します。 {date}: このマクロは現在の日付(YYYYMMDD)に置き換えられます。 注意: レポータの実行プロセスには、レポートの出力ディレクトリへの読取り、書込みおよび作成の権限が必要です。
delim	オプション	列値または配列値を区切る文字を指定します。有効な値は{tab}、{space}または空白以外の文字です。
hide-headers	オプション	レポートに説明と列ヘッダーを含めるかどうかを指定します。有効な値は、trueおよびfalseです。
filters	オプション	レポートのフィルタ・グループを指定します
query	必須	レポートまたは列に情報を提供しているすべてのMBeanを検出する、JMX問合せを作成するために必要な情報を指定します
row	必須	レポート行を生成するための情報を指定します

B.2.8 report-config

ルート要素

説明

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

要素

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

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

要素	必須/ オプション	説明
report	必須	JMXベース・レポートを生成するために必要な情報を指定します

B.2.9 row

使用場所: report-config

説明

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

要素

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

表B-9 rowのサブ要素

要素	必須/ オプション	説明
column	必須	レポート列を生成する情報を指定します