37 レポート・バッチの変更方法

レポート・バッチの構成は、カスタム・レポートを作成するための手順の1つです。通常はレポート構成ファイルを作成した後に構成します。この構成ファイルは、Reporterで実行するレポートの種類、実行間隔および保存場所を指定します。1つのレポートを異なるパラメータで使用する場合は、それらのパラメータもレポート・バッチに構成します。レポート構成ファイルの詳細は、第36章「カスタム・レポートの作成方法」を参照してください。

レポート・バッチのデプロイメント・ディスクリプタ

レポート・バッチのデプロイメント・ディスクリプタを使用して、カスタム・レポートの作成に使用する各種オプションを指定します。

ドキュメントの場所

ディスクリプタのデフォルトの名前および場所はreport-group.xmlになります。このデフォルトのディスクリプタはcoherence.jarにパッケージ化されており、カスタム・ファイルがアプリケーションのクラスパスに検出されないかぎり使用されます。

ドキュメント・ルート

POFユーザー定義型のディスクリプタのルート要素はreport-groupです。カスタム・レポートの形式の指定はここから開始します。

システム・プロパティ

表37-1は、コマンドラインからレポート・バッチを制御する際に使用できるシステム・プロパティを示しています。

表37-1 レポート・バッチを制御するためのシステム・プロパティ

プロパティ	デフォルト	説明
`tangosol.coherence.management.report.configuration`	`reports/report-group.xml`	レポートのリストや実行間隔など、Reporterの構成設定を含むXMLファイル。
`tangosol.coherence.management.report.autostart`	`false`	ノードの起動時にReporterを自動的に起動するフラグ。
`tangosol.coherence.management.report.distributed`	`false`	Reporterを中央モデルで実行する(`false`)か、クラスタ内のすべてのノードで実行する(`true`)かを指定します。

ドキュメントの形式

レポート・バッチのディスクリプタは、次のDOCTYPE宣言から開始します。

<!DOCTYPE report-group SYSTEM "report-group.dtd">

レポート・バッチ・ドキュメントの要素のネストを例37-1に示します。

例37-1 レポート・バッチ構成ファイル(report-group.xml)の形式

<report group>
  <frequency/>
  <output-directory/>
  <report-list>
    <location/>
  <report-config>
    <init-params>
      <init-param>
      </init-param>
  <report-config/>
<report-group>

レポート・バッチの要素の索引

表37-2は、レポート・バッチの各要素の関係を示しています。

表37-2 レポート・バッチの要素

要素	使用場所
frequency	report-group
location	report-list
init-param	init-params
init-params	report-config
output-directory	report-group
param-name	init-param
param-type	init-param
param-value	init-param
report-config	report-group
report-group	ルート要素
report-list	report-group

frequency

使用場所: report-group

説明

必須。レポート・バッチの実行間隔を秒単位または分単位で示す数字を指定する文字列です。10sと指定すると、レポートは10秒ごとに実行されます。5mと指定すると、レポートは5分ごとに実行されます。実行間隔には適切な値を選択することが重要です。実行間隔が短かすぎると、Reporterで膨大な量のデータが生成され、ディスク領域が著しく消費される可能性があります。実行間隔が長すぎると、情報の有益性が低下します。Reporterを構成する前に、履歴情報のパージおよびアーカイブ処理について計画を立てることをお薦めします。

location

使用場所: report-list

説明

必須。レポート構成ファイルのパスです。このファイルの詳細は、第36章「カスタム・レポートの作成方法」を参照してください。

init-param

使用場所: init-params

説明

init-param要素には、レポートの初期化パラメータを記述します。このパラメータは、パラメータ名(またはパラメータ・タイプ)とその値で構成されます。

init-params

使用場所: report-config

説明

オプション。init-params要素には、初期化パラメータのリストを記述します。

output-directory

使用場所: report-group

説明

オプション。レポート構成ファイルの出力ファイル名の先頭に付加するディレクトリ・パスです。ノードを実行するユーザー名には、このパスに対する読取り/書込みアクセスを付与する必要があります。

param-name

使用場所: init-param

説明

param-name要素は、初期化パラメータの名前を指定します。

param-type

使用場所: init-param

説明

param-type要素は、初期化パラメータのJavaタイプを指定します。サポートされているタイプは次のとおりです。

string: 値がjava.lang.Stringであることを示します。
long: 値がjava.lang.Longであることを示します。
double: 値がjava.lang.Doubleであることを示します。

param-value

使用場所: init-param

説明

param-value要素は、初期化パラメータの値を指定します。この値は、パラメータの型に固有の形式にします。

report-config

使用場所: report-group

説明

report-configには、レポートの構成ファイル名および初期化パラメータを記述します。

report-group

使用場所: ルート要素

説明

レポート・リスト、実行間隔、レポート・パラメータおよびバッチの出力ディレクトリを記述します。

report-list

使用場所: report-group

説明

必須。バッチに含めるレポートのリストです。この要素には、<report-config>サブ要素を記述します。