11.2.12 レポート定義ファイル

pavreportコマンドで出力するレポートの内容を定義します。

<この項の構成>
(1) 書式
(2) 定義内容
(3) 定義例

(1) 書式

[Dest Manager]
mgr_host=ホスト名またはIPアドレス
destport_alsd=分析用ポート番号

[Contents]
title=レポートタイトル

[Metric]
metric=オブジェクト名,メトリック名
metric=オブジェクト名,メトリック名

レポートに出力するメトリックの数だけ指定します。

[Data Class]
data_class={1|2}

[Option]
range_unity={Y|N}
threshold_line={Y|N}
threshold_linetype={LINE|COLOR}
graph_hscaletype={AUTO|FIX|DIV4}
graph_hscaleval=グラフの横軸目盛りの間隔
graph_hscaleunit={MIN|HOUR|DAY|MONTH}
graph_vscaletype={AUTO|FIX|DIV4}
graph_vscaleval=グラフの縦軸目盛りの間隔
graph_vscalemax=グラフの縦軸目盛りの上限
graph_vscalemin=グラフの縦軸目盛りの下限

[Graph Color]
bg_thre_critical=しきい値表示時の危険域のしきい値線または背景の色
bg_thre_warning=しきい値表示時の警戒域のしきい値線または背景の色
bg_thre_normal=しきい値表示時の正常域の背景の色
graph_line_color=グラフ線の色

[Instance]
instance=オブジェクト名,メトリック名
instance=オブジェクト名,メトリック
instance=オブジェクト名,メトリック名,インスタンス識別子
instance=オブジェクト名,メトリック名,インスタンス識別子

レポートに出力するインスタンスの数だけ指定します。

(2) 定義内容

Dest Managerセクション
接続先のPFM - Analysis Managerを定義します。PFM - Analysis Managerは一つだけ定義できます。

表11-35 Dest Managerセクションの定義内容

キー名必須指定する値
mgr_host
((255バイト以内))
接続先のPFM - Analysis Managerのホスト名またはIPアドレスを指定します。
destport_alsd
((1~65535))《20297》
接続先のPFM - Analysis Managerの分析用ポート番号を指定します。PFM - Analysis Manager動作条件定義ファイル(pam.conf)のsrvport_alsdに定義したポート番号を指定します。
(凡例)
○:必須項目
-:オプション項目

Contentsセクション
レポートに埋め込む情報を指定します。

表11-36 Contentsセクションの定義内容

キー名必須指定する値
title
((255バイト以内))《タイトルなし》
レポートのタイトルを指定します。PFM - Analysisを日本語環境で運用している場合は,日本語も指定できます。
(凡例)
-:オプション項目

Metricセクション
レポートに出力するメトリックを指定します。

表11-37 Metricセクションの定義内容

キー名必須指定する値
metric
((オブジェクト名,メトリック名とも,各63バイト以内の文字列))
レポート出力するオブジェクト名およびメトリック名を指定します。オブジェクト名とメトリック名は「,(コンマ)」で区切ってください。
なお,複数のメトリックを指定できます(複数行に指定)。ただし,出力するメトリックの数とインスタンスの数の合計が,グラフ線の最大表示本数より多く指定した場合は,先頭からグラフの表示本数分だけが出力されます。MetricセクションのmetricとInstanceセクションのinstanceを同時に省略することはできません。
(凡例)
○:必須項目

Data Classセクション
レポートに出力するメトリックの種別を指定します。

表11-38 Data Classセクションの定義内容

キー名必須指定する値
data_class
((1,2))
レポートに出力するメトリックが詳細メトリックの場合は「1」を,サマライズメトリックの場合は「2」を指定します。
(凡例)
○:必須項目

Optionセクション
レポートに関するオプションを指定します。

表11-39 Optionセクションの定義内容

キー名必須指定する値
range_unity
((YまたはN))《Y》
グラフでの縦軸のレンジを統一するかどうか指定します。レンジを統一する場合は「Y」を,統一しない場合は「N」を指定します。
出力するグラフが1本の場合にこの項目でYを指定してもエラーにはなりません。
threshold_line
((YまたはN))《N》
グラフでのしきい値表示をするかどうか指定します。しきい値表示をする場合は「Y」を,しない場合は「N」を指定します。この設定は,出力するメトリックを一つだけ指定した場合に限り有効になります。複数のメトリックを指定している場合,この設定は無視され常にしきい値は表示されません。
threshold_linetype
((LINEまたはCOLOR))《LINE》
グラフでのしきい値表示の方法を指定します。グラフ上にしきい値を示す線を表示させる場合は「LINE」を,警戒域,危険域および正常域をそれぞれ背景色を変えて表示させる場合は「COLOR」を指定します。この設定は,出力するメトリックを一つだけ指定し,かつthreshold_lineをYと指定している場合に限り有効になります。それ以外を指定している場合,この設定は無視されます。
graph_hscaletype
((AUTO,FIXまたはDIV4))《AUTO》
グラフの横軸目盛りの表示方法を指定します。グラフ全体の横軸の長さに基づいて最適な目盛り幅を自動設定する場合は「AUTO」を,指定した固定幅で目盛りを表示する場合は「FIX」を,横軸を4分割した目盛りを表示する場合は「DIV4」を指定します。FIXを指定した場合の目盛り幅は,graph_hscalevalで指定した値になります。
graph_hscaleval
((1~999))
グラフの横軸目盛りの間隔を指定します。
このパラメーターは,graph_hscaletypeでFIXを指定した場合に限り設定が必要になります。また,graph_hscaletypeがFIX以外の場合,設定は無視されます。
graph_hscaleunit
((MIN,HOUR,DAY,またはMONTH))
グラフの横軸目盛りの単位を指定します。分単位とする場合は「MIN」を,時間単位とする場合は「HOUR」を,日単位とする場合は「DAY」を,月単位とする場合は「MONTH」を指定します。
このパラメーターは,graph_hscaletypeでFIXを指定した場合に限り設定が必要になります。また,graph_hscaletypeがFIX以外の場合,設定は無視されます。
graph_vscaletype
((AUTO,FIXまたはDIV4))《AUTO》
グラフの縦軸目盛りの表示方法を指定します。グラフ全体の縦軸の長さに基づいて最適な目盛り幅を自動設定する場合は「AUTO」を,指定した固定幅で目盛りを表示する場合は「FIX」を,縦軸を4分割した目盛りを表示する場合は「DIV4」を指定します。FIXを指定した場合の目盛り幅は,graph_vscalevalで指定した値になります。
graph_vscaleval
((0より大きい倍精度実数の範囲))
グラフの縦軸目盛りの間隔を指定します。0より大きい正の倍精度実数の値を指定します。
このパラメーターは,graph_vscaletypeでFIXを指定した場合に限り設定が必要になります。また,graph_vscaletypeがFIX以外の場合,設定は無視されます。
graph_vscalemax
((倍精度実数の範囲))
グラフの縦軸目盛りの上限を指定します。倍精度実数の範囲で指定します。省略時は,表示データの値によって自動的に決定されるため,通常は指定する必要はありません。
なお,このパラメーターに値を設定した場合は,range_unityにYを指定したものとして扱われ,常にレンジ統一ありとして動作します。
このパラメーターを設定する場合,設定する値は,graph_vscaleminの値より大きい値である必要があります。
graph_vscalemin
((倍精度実数の範囲))
グラフの縦軸目盛りの下限を指定します。倍精度実数の範囲で指定します。省略時は,表示データの値によって自動的に決定されるため,通常は指定する必要はありません。
なお,このパラメーターに値を設定した場合は,range_unityにYを指定したものとして扱われ,常にレンジ統一ありとして動作します。
このパラメーターを設定する場合,設定する値は,graph_vscalemaxの値より小さい値である必要があります。
(凡例)
-:オプション項目

Graph Colorセクション
グラフで表示されるグラフ線の色を定義します。

表11-40 Graph Colorセクションの定義内容

キー名必須指定する値
bg_thre_critical
((0,0,0~255,255,255))《255,50,50》
しきい値表示時の危険域のしきい値線または背景色を指定します。RGBの値をR,G,Bの順にコンマで区切り,10進数で指定します。
bg_thre_warning
((0,0,0~255,255,255))
《255,255,0》
しきい値表示時の警戒域のしきい値線または背景色を指定します。RGBの値をR,G,Bの順にコンマで区切り,10進数で指定します。
bg_thre_normal
((0,0,0~255,255,255))
《64,64,64》
しきい値表示時の正常域の背景色を指定します。RGBの値をR,G,Bの順にコンマで区切り,10進数で指定します。なお,この項目の設定はthreshold_linetypeでCOLORを指定した場合に有効になります。
graph_line_color
((0,0,0~255,255,255))
メトリック値を表示するグラフ線の色を指定します。RGBの値をR,G,Bの順にコンマで区切り,10進数で指定します。
グラフ線の色は最大50個定義でき,このパラメーターに指定されている色を上から順に使用します。
なお,この項目の設定をすべて省略した場合は,次の設定が適用されます。

graph_line_color=0,255,0
graph_line_color=255,50,50
graph_line_color=255,255,0
graph_line_color=255,80,255
graph_line_color=83,100,255
graph_line_color=0,255,255
graph_line_color=160,160,160
graph_line_color=255,128,64

(凡例)
-:オプション項目

Instanceセクション
レポートに出力するインスタンスを指定します。指定したメトリックの全インスタンス出力または個別インスタンスの出力を指定できます。

表11-41 Instanceセクションの定義内容

キー名必須指定する値
instance
((オブジェクト名,メトリック名とも各63バイト以内。インスタンス識別子は1023バイト以内))
メトリックの全インスタンスをレポート出力する場合はオブジェクト名とメトリック名を「,(コンマ)」で区切って指定します。この場合,インスタンスフィルターの定義と関係なく,PAMDBに格納されている該当するメトリックの全インスタンスインデックスを出力対象にします。
個別にインスタンスを出力する場合はオブジェクト名,メトリック名とインスタンス識別子を「,(コンマ)」で区切って指定します。
なお,採取ツールがPFMで,かつ,キーフィールドが複数あるメトリックに対してインスタンスを指定する場合,各キーフィールドの値を「"(ダブルクォーテーション)」で囲み,「:(コロン)」で区切って指定します(例:"index1":"index2")。
複数のインスタンスを指定できます。(複数行に指定)。ただし,出力するメトリックの数とインスタンスの数の合計が,グラフ線の最大表示本数より多く指定された場合は,先頭からグラフの表示本数分だけが出力されます。MetricセクションのmetricとInstanceセクションのinstanceを同時に省略することはできません。また,両方を同時に指定した場合はMetricセクションのmetricが優先的に出力されます。
(凡例)
○:必須項目

(3) 定義例

レポート定義ファイルの定義例を次に示します。この定義例では,マネージャーサーバ「pamhost」のPAMDBに格納された,Webへのアクセス状況に関する情報を,レポートとして出力するよう定義しています。

[Dest Manager]
mgr_host=pamhost
destport_alsd=20297

[Contents]
title=アクセス状況

[Metric]
metric=HTTP01,転送時間
metric=HTTP01,セットアップ時間
metric=HTTP01,総応答時間

[Data Class]
data_class=1

[Option]
range_unity=Y
threshold_line=Y
threshold_linetype=LINE
graph_hscaletype=FIX
graph_hscaleval=3
graph_hscaleunit=HOUR
graph_vscaletype=DIV4

[Graph Color]
bg_thre_critical=255,50,50
bg_thre_warning=255,255,0
bg_thre_normal=64,64,64
graph_line_color=255,0,0
graph_line_color=0,255,0
graph_line_color=0,0,255

[Instance]
instance=WebServer01,ディスク使用率
instance=WebServer02,ディスク使用率
instance=AppServer01,ディスク使用率,C:¥
instance=AppServer01,ディスク使用率,E:¥