6.4.3 レポート用テンプレートファイル

レポート用テンプレートファイルは,Bottleneck Analyzerまたはpavreportコマンドからレポートを出力する場合の出力形式のテンプレートとして使用されるファイルです。テンプレートファイルは,XSL形式で記述され,必要に応じてユーザーがXSL形式の範囲内で背景色やタイトルの表示形式などをカスタマイズできます。ただし,カスタマイズ方法ついては,XSL関連のドキュメントを参照してください。また,カスタマイズによってレポートが正しく出力されない場合は,デフォルトのテンプレートファイルをそのまま使用してください。

レポート用テンプレートファイルは,Bottleneck Analyzerで出力する場合とpavreportコマンドで出力する場合とでファイルが異なります。

表6-1 レポート用テンプレートファイル

出力元ファイル名パス
Bottleneck Analyzerpavbarpttmpl.xslインストール先ディレクトリ¥view¥conf
pavreportコマンドpavrpttmpl.xsl
注意事項
レポート用テンプレートファイルは,XSL形式の範囲内で変更してください。レポート出力する上でテキストや画像の置き換えに必要な記述があるため,それらを不用意に変更するとレポートが正しく出力されないおそれがあります。
<この項の構成>
(1) テンプレートルール定義で使用される識別要素
(2) テキスト置換で使用される識別要素
(3) 表示を制御するための識別要素
(4) 分析結果やメトリック値リストを表示するための識別要素
(5) そのほかの識別要素

(1) テンプレートルール定義で使用される識別要素

<xsl:apply-templates select="XXX"/>または<xsl: template match="XXX">で,テンプレートルール定義として使用されます。テンプレートルール定義は,移動はできますが,削除はできません。削除したい場合は,テンプレートルール定義内の記述を削除してください。また,移動する場合は,テンプレートルール定義ごと移動してください。テンプレートルール定義で使用する識別要素を次の表に示します。

表6-2 テンプレートルール定義で使用される識別要素

識別要素説明
Reportレポート全体のテンプレートルール定義のパターン。
DangerAnalysis「危険度分析」出力用テンプレートルール定義で使用する要素名。
DangerEstimate「危険域到達時刻予測」出力用テンプレートルール定義で使用する要素名。
MetricAnalysis「メトリック値ランキング」出力用テンプレートルール定義で使用する要素名。
PluralMetricGraph「複数メトリックグラフ」出力用テンプレートルール定義で使用する要素名。
WarningMessage「警告メッセージ」出力用テンプレートルール定義で使用する要素名。
SystemComposition「システム構成」出力用テンプレートルール定義で使用する要素名。
StatusAnalysis「ステータス分析」出力用テンプレートルール定義で使用する要素名。
SingleMetricGraph「単数メトリックグラフ」出力用テンプレートルール定義で使用する要素名。
CorrelationAnalysis「相関分析」出力用テンプレートルール定義で使用する要素名。

(2) テキスト置換で使用される識別要素

次の表に示す識別要素は,<xsl: value-of select="XXX"/>で,テキスト置換に使用されます。これらの識別要素は,タグ単位で移動,削除などができます。タグが削除された項目は,レポート出力時に表示されなくなります。

表6-3 テキスト置換で使用される識別要素

識別要素説明
Titleタイトル
AnalysisRange分析範囲,対象期間
Valueメトリック値
MetricNameメトリック名
ObjectNameオブジェクト名
Subject現象メトリック,対象メトリック,対象,対象オブジェクト
Correlation相関
AnalysisTime分析時刻,対象時刻
ID警告メッセージのメッセージID
Time
  • Bottleneck Analyzer出力時:警告メッセージ発生時刻
  • pavreportコマンド出力時:作成日時
Message警告メッセージのメッセージ
StartTime開始時刻
EndTime終了時刻
SelectTime対象時刻
SearchRange原因候補メトリック
Unit単位
DispRange表示範囲
Importance重要度
SubjectMetric対象メトリック
SubjectObject対象オブジェクト
EstimateTime予測危険到達時刻
CollectionMethod集計方法
CollectedValue集計メトリック値
Statusステータス
CollectRange取得範囲

(3) 表示を制御するための識別要素

次の表に示す識別要素は,<xsl: if test="XXX">や<xsl: for-each select="XXX">などで,表示を制御するために使用されます。これらの識別要素は,タグ単位で移動,削除などができます。タグが削除された項目は,レポート出力時に表示されなくなります。

表6-4 表示を制御するための識別要素

識別要素説明
RangeUnityレンジ統一(レンジ統一した場合)
Trendトレンド表示
Forecast予測表示
Result/CorrelationInstance相関分析の結果表示
Result/DangerInstance危険度分析の結果表示
Result/EstimateInstance危険域到達時刻予測の結果表示
Result/StatusInstanceステータス分析の結果表示
Result/MetricInstanceメトリック値ランキングの結果表示

(4) 分析結果やメトリック値リストを表示するための識別要素

次の表に示す識別要素は,分析結果やメトリック値リストを表示するために使用されます。これらの識別要素は,タグ単位で移動,削除などができます。タグが削除された項目は,レポート出力時に表示されなくなります。

表6-5 分析結果やメトリック値リストを表示するための識別要素

識別要素説明
MetricListメトリック値リスト
MetricInfo
MetricInfoInstance
Danger分析結果の危険度
MessageInstance警告メッセージリスト

(5) そのほかの識別要素

次の表に示す識別要素は,テキスト置換,表示の制御,および分析結果やメトリック値リストの表示以外で使用されます。これらの識別要素は,タグ単位で移動,削除などができます。タグが削除された項目は,レポート出力時に表示されなくなります。

表6-6 そのほかの識別要素

識別要素説明
Supplementpavreportコマンドでの出力情報
Graphpavreportコマンド出力時のグラフルール
Imagepavreportコマンド出力時のイメージルール
NoImagepavreportコマンド出力時のイメージルール
(イメージが生成できなかった場合)
NoImage/NoMetricDataイメージ生成失敗の理由
(メトリック値が存在しない)
NoImage/InvalidGraphVscaleイメージ生成失敗の理由
(縦軸指定エラー)
NoImage/InvalidGraphVscaleValueイメージ生成失敗の理由
(縦軸目盛りの間隔指定エラー)
NoImage/InvalidGraphHscaleValueイメージ生成失敗の理由
(横軸目盛りの間隔指定エラー)
Literal危険度を表す文字列
Color危険度の色