レポート定義ファイルは、レポートファイルに出力するデータをテーブルおよびカラムとして記載するためのxmlファイルで、以下のような構造を持ちます。レポート定義ファイルの設定例は、「7.3.2. レポート定義ファイルの設定例」を参照してください。
<report template="レポートテンプレートファイル名" type="レポート種別" culture="カルチャ情報" id="レポート定義ID">
<tables>
<table key="テーブル名" ...>
<columns>
<column key="カラム名">カラム表示名</column>
<column key="カラム名">カラム表示名</column>
...
</columns>
</table>
<table key="テーブル名" sourceTable="入力テーブル名" ...>
<sort targetColumn="ソート対象カラム名" .../>
<condition targetColumn="条件対象カラム名" .../>
<columns>
<column key="カラム名">カラム表示名</column>
<column key="カラム名">カラム表示名</column>
...
</columns>
</table>
<table key="テーブル名" sourceTable="入力テーブル名" ...>
<join/distribution/ratio/calculation .../>
<columns>
<column key="カラム名">カラム表示名</column>
<column key="カラム名">カラム表示名</column>
...
</columns>
</table>
...
</tables>
</report>
レポート定義ファイルの以下のタグについて説明します。
reportタグ(「(1)reportタグ」)
tablesタグ、tableタグ(「(2)tablesタグ、tableタグ」)
columnsタグ、columnタグ(「(3)columnsタグ、columnタグ」)
sortタグ(「(4)sortタグ」)
conditionタグ(「(5)conditionタグ」)
joinタグ(「(6)joinタグ」)
distributionタグ(「(7)distributionタグ」)
ratioタグ(「(8)ratioタグ」)
rangesタグ、rangeタグ(「(9)rangesタグ、rangeタグ」)
calculationタグ(「(10)calculationタグ」)
predictionタグ(「(11)predictionタグ」)
レポート定義ファイルの最上位のタグで、下位要素としてにtablesタグを1つ配置します。
reportタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
template (必須) | レポートテンプレートファイルの名前を指定します。ファイル名のみの場合は、レポート定義ファイルおよびレポートテンプレートファイルの格納用フォルダ(「7.3.1. レポートのカスタマイズ方法の概要」を参照)に存在するものとみなされます。レポート定義ファイルと異なるフォルダに存在するレポートテンプレートファイルを指定する場合は、絶対パスで指定してしください。 |
type (必須) | 対象とする運用グループ/マシンに応じてレポートファイルの種別を指定します。以下のいずれかの値を指定してください。
|
culture | レポート定義ファイルのカルチャ情報(en, ja など)を指定します。省略時は en とみなされます。 |
id | レポート定義ファイルのIDを設定します。IDを設定した場合、コマンド実行時にIDを使用してレポート定義ファイルを指定することができます。また、使用可能なレポート定義ファイルが複数存在し、その中から自動選択する場合、IDの若い順に優先的に選択されます。(IDが設定されているものは設定されていないものより優先されます) |
tablesタグには、下位要素として複数のtableタグを配置します。
tableタグでは、以下のいずれかの方法でテーブルを定義します。定義したテーブルと同名のテーブルをレポートテンプレートファイル内に配置することで、データの出力位置が決定されます。
「7.3.4. 組み込みテーブル」に記載されている組込テーブルのデータを出力する場合は、key属性に組込テーブルの名前を指定します。
他のテーブルを入力とした新しいテーブルを定義する場合は、sourceTable属性に入力テーブルの名前を、key属性に新しいテーブルの名前を指定します。この場合、下位要素のタグにより、入力テーブルのデータに対して集計・抽出・結合などを行った結果を新しいテーブルのデータとして出力することができます。
tableタグには、下位要素として下記のタグを指定することができます。
columnsタグ
sortタグ
conditionタグ
joinタグ
distributionタグ
ratioタグ
calculationタグ
predictionタグ
tableタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
key (必須) | テーブル名を指定します。レポートテンプレートファイル内に存在するテーブルを特定するために使用されます。 同じテーブル名を複数定義することはできません。
|
maxDataCount | テーブルの最大データ数を指定します。この値を超えた分のデータはテーブルに挿入されずに捨てられます。 |
fixDataRows | テーブルのデータ領域を固定化するかどうかを指定します。 省略時またはfalseの場合、テーブルのデータ領域は挿入されるデータ数に応じて拡大/縮小されます。trueの場合、テーブルのデータ領域は拡大/縮小されません。 |
fixOutside | テーブルより下にあるデータの位置を固定化するかどうかを指定します。データ挿入時にテーブルの末端に到達した場合の挙動を定義します。 省略時またはfalseの場合、テーブルの末端の次の行が空行のとき(セルのデータが存在しないとき)は行が挿入され、テーブルより下にあるデータは下にシフトされます。 trueの場合、テーブルの末端の次の行が空行であっても行の挿入は行われない(テーブルの範囲が下に拡張されるのみ)ため、テーブルより下にあるデータの位置は変わりません。テーブル範囲の拡張の際、データの存在するセルに衝突した場合、そこでテーブルの拡張が止まり、以降のデータは挿入されずに捨てられます。 |
sourceTable | 入力データとして使用する他のテーブルの名前を指定します。 指定する入力テーブルは、このテーブルよりも前のtableタグで定義されている必要があります。 |
perfIndicator | SystemMonitor性能監視から取得する性能情報の時系列テーブルを定義する場合に、性能情報のタイトルを指定します。 |
perfTargetType | SystemMonitor性能監視から取得する性能情報の時系列テーブルを定義する場合に、性能監視対象の種別(以下のいずれか)を指定します。(perfIndicator指定時のみ)
|
perfUnitConversion | SystemMonitor性能監視から取得する性能情報の時系列テーブルを定義する場合に、性能情報の単位変換方法(以下のいずれか)を指定します。省略時は単位変換は行われません。(perfIndicator指定時のみ)
|
perfCalculation | 時系列テーブルの各カラムのデータを集計・計算した時系列テーブルを作成する場合に、計算方法(以下のいずれか)を指定します。 sourceTable属性に時系列テーブルを指定するか、perfIndicator属性およびperfTargetType属性(およびperfUnitConversion属性)で性能データの種別を指定する必要があります。
|
perfSummary | 性能情報の時系列データのサマリテーブルを定義する場合に、入力となる時系列テーブルを指定します。 |
columnsタグには、下位要素として複数のcolumnタグを配置します。
columnタグでは、テーブルのカラムとその表示名を定義します。定義したカラムと同名のカラムをレポートテンプレートファイル内の同じテーブルに配置することで、データの出力位置が決定されます。また、レポートファイル生成時に、テーブルのカラム名が表示名に変換されます。以下のいずれかのカラムの名前をkey属性に指定します。
組込テーブルの場合(tableタグのkey属性に組込テーブルが指定されている場合)、「7.3.4. 組み込みテーブル」に記載のカラム名を指定します。
入力テーブルが指定されている場合(tableタグのsourceTable属性に他のテーブルが指定されている場合)、入力テーブルで定義されているカラムのうち、このテーブルに抽出するカラムの名前を指定します。
分布テーブルの場合(tableタグのsourceTable属性に他のテーブルが指定され、tableタグ下にdistributionタグが存在する場合)、集計範囲の表示用テキストを表示するためのカラム "Range" を指定することができます。
比率テーブルの場合(tableタグのsourceTable属性に他のテーブルが指定され、tableタグ下にratioタグが存在する場合)、集計結果の数を表示するためのカラム "Count"、または、集計結果の比率(%)を表示するためのカラム "Ratio" を指定することができます。
すべてのテーブルにおいて、テーブル内のインデックス(1以上)を表示するためのカラム "Index" を指定することができます。
columnタグでは、以下の属性およびテキスト値を指定します。
属性 | 説明 |
|---|---|
key (必須) | カラム名を指定します。レポートテンプレートファイル内に配置したテーブルのカラムとの対応付けを特定するために使用されます。 |
テキスト値 | カラム表示名を指定します。レポートファイル生成時、レポートテンプレートファイル内に配置したテーブルのカラム名(key属性で指定した名前)がテキスト値で指定した表示名に変換されます。 同一テーブル内において、カラム表示名を重複させることはできません。 |
perfIndicator | SystemMonitor性能監視から取得する性能情報のカラムを定義する場合に、性能情報のタイトルを指定します。(VMServerList/VMList/PMListテーブル下のカラムのみ) |
perfCalculation | SystemMonitor性能監視から取得する性能情報のカラムを定義する場合に、性能情報の計算方法(以下のいずれか)を指定します。(VMServerList/VMList/PMListテーブル下のカラムのみ、perfIndicator指定時のみ)
|
perfUnitConversion | SystemMonitor性能監視から取得する性能情報のカラムを定義する場合に、性能情報の単位変換方法(以下のいずれか)を指定します。省略時は単位変換は行われません。(VMServerList/VMList/PMListテーブル下のカラムのみ、perfIndicator指定時のみ)
|
テーブルのデータを特定のカラムの値でソートする場合に使用します。sortタグを複数指定することはできません。
sortタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
targetColumn (必須) | ソートの対象とするカラムを指定します。 |
descending | 降順かどうかを指定します。trueの場合、降順となります。省略時またはfalseの場合、昇順となります。 |
テーブルのデータから条件を満たすものを抽出する場合に使用します。以下のいずれかの方法で抽出条件を指定します。
単独のconditionタグにより、特定のカラムを対象とした条件を指定することができます。targetColumn属性に対象のカラムを、equal/notEqual/greaterThan/lessThan/greaterEqual/lessEqual/match属性に条件を指定します。条件の属性を複数指定した場合は、andとして解釈されます。
conditionタグを入れ子にすることにより、複合条件を指定することができます。上位のconditionタグのtype属性にand/or/notのいずれかを指定し、下位に条件を記述したconditionタグを配置します。下位のconditionタグに複合条件を指定することで、多段階の条件の組み合わせを記述することができます。
conditionタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
targetColumn | 抽出条件の対象となるカラムを指定します。 |
equal | 対象のカラムに対する条件(==)を指定します。数値/日時/文字列のいずれかを指定することができます。 以下の条件を満たすデータが抽出されます。
|
notEqual | 対象のカラムに対する条件(=)を指定します。数値/日時/文字列のいずれかを指定することができます。 以下の条件を満たすデータが抽出されます。
|
greaterThan | 対象のカラムに対する条件(>)を指定します。数値/日時/文字列のいずれかを指定することができます。 以下の条件を満たすデータが抽出されます。
|
lessThan | 対象のカラムに対する条件(<)を指定します。数値/日時/文字列のいずれかを指定することができます。 以下の条件を満たすデータが抽出されます。
|
greaterEqual | 対象のカラムに対する条件(>=)を指定します。数値/日時/文字列のいずれかを指定することができます。 以下の条件を満たすデータが抽出されます。
|
lessEqual | 対象のカラムに対する条件(<=)を指定します。数値/日時/文字列のいずれかを指定することができます。 以下の条件を満たすデータが抽出されます。
|
match | 対象のカラムに対する条件(正規表現)を指定します。.NET Framework でサポートされる正規表現を指定することができます。 以下の条件を満たすデータが抽出されます。
|
type | conditionタグを入れ子にすることによって複合条件を記述する場合、種別としてand/or/notのいずれかを指定します。 andの場合、下位のconditionタグで指定された各条件をand演算で結合します。 orの場合、下位のconditionタグで指定された各条件をor演算で結合します。 notの場合、下位のconditionタグで指定された条件を反転します。下位のconditionタグが複数存在する場合は各条件のand結果を反転します。
下位にconditionタグが存在しない場合、type属性のand/or指定は無視されます(not指定時は条件を反転します)。 下位にconditionタグが存在する場合、type以外の属性はすべて無視されます。 |
特定のカラムを結合キーとして2つのテーブルのデータを結合する場合に使用します。結合するテーブルのうちの1つをtableタグのsourceTable属性に、もう1つをjoinタグのtargetTable属性に指定します。また、結合キーとするカラムをjoinテーブルのsourceColumn/targetColumn属性に指定します。
joinタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
sourceColumn (必須) | 結合キーとして使用するカラム(sourceTable側)を指定します。 |
targetTable (必須) | 結合対象のもう1つのテーブルを指定します。 |
targetColumn (必須) | 結合キーとして使用するカラム(targetTable側)を指定します。 |
テーブルの特定のカラムに対して、指定した範囲ごとのデータ数を集計する場合に使用します。集計対象のテーブルをtableタグのsourceTable属性に指定します。また、集計対象のカラムおよび集計範囲を以下のように指定します。
集計対象のカラムおよび集計テーブルにおける表示名をcolumnタグのkey属性およびテキスト値に指定します。複数のカラムを集計対象として指定することができます。
集計範囲を表示するためのカラム "Range" とその表示名をcolumnタグのkey属性およびテキスト値に指定します。
集計範囲をdistributionタグ下のrangesタグまたはrangeタグで指定します。
distributionタグには、指定可能な属性はありません。
テーブルの特定のカラムに対して、値ごとまたは範囲ごとのデータ数および比率を集計する場合に使用します。集計対象のテーブルをtableタグのsourceTable属性に指定します。また、対象のカラムおよび集計範囲を以下のように指定します。
集計対象のカラムをratioタグのtargetColumn属性に指定します。
集計対象のカラムおよび集計テーブルにおける表示名をcolumnタグのkey属性およびテキスト値に指定します。
データ数を表示するためのカラム "Count"、比率を表示するためのカラム "Ratio" とそれらの表示名をcolumnタグのkey属性およびテキスト値に指定します。
集計範囲を指定する場合、ratioタグ下のrangesタグまたはrangeタグで指定します。省略した場合は値ごとのデータ数・比率が集計されます。
ratioタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
targetColumn (必須) | 集計の対象となるカラムを指定します。 |
distributionタグおよびratioタグにおける集計範囲を定義するために使用します。以下のいずれかの方法で集計範囲を定義します。
rangesタグの下にrangeタグを複数配置してそれぞれの範囲の開始点(from属性)と終了点(to属性)を指定します。
rangeタグを単独で配置して範囲の開始点(from属性)と幅(width属性)を指定します。
rangeタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
from | 範囲の開始点を指定します。 |
to | 範囲の終了点を指定します。rangesタグ下にrangeタグの複数配置する場合に使用します。 |
width | 範囲の幅を指定します。rangeタグを単独で配置する場合に使用します。 |
テキスト値 | データの範囲を表示するテキストの書式を定義します。記述形式は.NET Frameworkの書式指定文字列の形式に準拠します。 インデックス0には集計範囲の開始点、インデックス1には集計範囲の終了点が出力されます。 例."{0}-{1}%" |
他のテーブルのデータを入力とした計算(合計値/平均値/データ数のカウント)を行う場合に使用します。テーブルをtableタグのsourceTable属性に指定します。また、対象のカラムを以下のように指定します。
合計値/平均値を計算する場合、計算対象のカラムおよび計算テーブルにおける表示名をcolumnタグのkey属性およびテキスト値に指定します。複数のカラムを計算対象として指定することができます。
データ数を表示するためのカラム "Count" とその表示名をcolumnタグのkey属性およびテキスト値に指定します。
calculationタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
type (必須) | 計算の種別として、sum/average/countのいずれかを指定します。
|
時系列性能データを入力して、時系列性能予測データを生成するために使用します。tableタグのsourceTable属性に性能情報の時系列テーブルを指定します。
また、summary属性にtrueを指定し、tableタグのsourceTable属性に時系列性能予測テーブルを指定した場合は、時系列性能予測データのサマリ情報が出力されます。
predictionタグでは、以下の属性を指定します。
属性 | 説明 |
|---|---|
type | 予測モデルの種別として、以下のいずれかを指定します。(","区切りで複数指定可)
|
predictionPeriodPercent | 予測期間をレポート期間に対する割合(%)で指定します。1から100までの値を指定する必要があります。 省略時は既定値(25)が使用されます。 |
windowSize | 特異スペクトル解析におけるウィンドウサイズをデータ数で指定します。2以上の値を指定する必要があります。 省略時はwindowSizeHour属性の値が使用されます。 trainSizePercent属性から算出した訓練データ数がウィンドウサイズの倍未満の場合、ウィンドウサイズは (訓練データ数) / 2 - 1 の値が使用されます。 (type属性が "ssa" の場合のみ) |
windowSizeHour | 特異スペクトル解析におけるウィンドウサイズを時間(H)で指定します。 windowSize属性が指定されている場合は無視されます。 省略時は既定値(24)が使用されます。 trainSizePercent属性から算出した訓練データ数がウィンドウサイズの倍未満の場合、ウィンドウサイズは (訓練データ数) / 2 - 1 の値が使用されます。 (type属性が "ssa" の場合のみ) |
trainSizePercent | 特異スペクトル解析における訓練データのサイズをレポート期間に対する割合(%)で指定します。1から100までの値を指定する必要があります。 省略時は既定値(100)が使用されます。 (type属性が "ssa" の場合のみ) |
confidenceLevelPercent | 特異スペクトル解析における信頼区間の範囲(%)を指定します。 1から100までの値を指定した場合、時系列予測テーブルに信頼区間の上限・下限のカラムが追加されます。 省略時は信頼区間のデータは出力されません。 (type属性が "ssa" の場合のみ) |
limitPercent | 性能データの閾値(%)を指定します。1から100までの値を指定する必要があります。 時系列性能予測データのサマリ情報における、閾値超過が見込まれる日数/日付の算出に使用されます。 省略時は既定値(80)が使用されます。 |
limitColumn | 時系列予測テーブルに性能データの閾値(%)を出力するためのカラムを指定します。 省略時は閾値のデータは出力されません。 |
summary | 時系列性能予測データのサマリ情報を出力する場合はtrueを指定します。trueを指定した場合、他のすべての属性は無視されます。 tableタグのsourceTable属性に、元となる時系列予測テーブル(summary属性が未指定のpredictionタグが指定されたテーブル)を指定する必要があります。 |
predictionタグによって定義した時系列性能予測テーブルでは、以下のカラムが追加されます。
<対象名> : 対象の性能値(実測値)
予測値(<対象名>) : 対象の性能予測値 (type属性が "ssa" の場合)
信頼区間上限(<対象名>, xx%) : confidenceLevelPercent属性で指定された信頼区間の上限 (type属性が "ssa" の場合)
信頼区間下限(<対象名>, xx%) : confidenceLevelPercent属性で指定された信頼区間の下限 (type属性が "ssa" の場合)
回帰直線(<対象名>) : 最小二乗法によって求められた回帰直線の値 (type属性が "ols" の場合)
predictionタグ(summary属性:true)によって定義した時系列性能予測サマリテーブルでは、以下のカラムに値が出力されます。
TargetName : 対象名
DaysToLimit : 回帰直線が閾値を超過すると見込まれるまでの日数
LimitDate : 回帰直線が閾値を超過すると見込まれる日付
sortタグおよびconditionタグはjoin/distribution/ratio/calculationタグと組み合わせて指定することができます。
この場合、condition → join/distribution/ratio/calculation → sort の順に処理されます。
joinタグ・distributionタグ・ratioタグ・calculationタグは同時に指定することはできません。