7.3.21 レポート定義ファイル
レポート条件を定義します。レポート条件設定ウィンドウを使用して作成することもできます。GUIを使用した手順については,「4.8.3 レポート条件の設定」を参照してください。
(1) 書式
レポート定義ファイルの書式を,次に示します。
(2) レポートファイルの定義内容
レポートファイルの言語を定義します。レポート定義ファイルごとに一つ記述します。レポートファイルの定義内容は,次のように囲ってください。
head{ 定義内容 }
定義内容を次の表に示します。
キー名 |
値 |
---|---|
lang |
レポートファイルを出力する際の言語を,次の形式から指定します。
定義ファイルに指定したタイトルなどは,すべてこのパラメタに指定した言語に変換されて出力されます。レポート定義ファイルの文字エンコーディングは,ここで指定した文字エンコーディングに従う必要があります。 |
(3) レポート条件の定義内容
レポート条件を定義します。一つのレポートファイルに表示するレポートの数だけ繰り返し定義してください。定義できる個数は,ssorptd動作定義ファイルのmax-dataキーに設定した値です。それぞれのレポート条件は,次のように囲ってください。
data{ 定義内容 }
定義内容を,次の表に示します。
キー名 |
値 |
---|---|
title ((255バイト以内の文字列)) |
各レポートのタイトルを指定します。途中に空白を記述できます。 |
target |
レポートに出力する収集サーバ名,収集対象サーバ名および通し番号を,「,(コンマ)」で区切って指定します。
|
resource_id |
レポートに出力するリソースIDを指定します。 |
subresource_id※2 |
レポートに出力するサブリソースIDを指定します。省略した場合は,すべてのサブリソースをレポート対象にします。 |
instance ((255バイト以内の文字列)) |
レポートするインスタンス名を指定します。複数指定する場合は,このキーを複数指定します。省略した場合は,全インスタンスをレポート対象にします。先頭または末尾に空白文字を含むインスタンス名を指定することはできません。 |
format |
レポートタイプを指定します。 tableA:[サブリソース列−インスタンス行]の表形式で出力します。 tableB:[インスタンス列−サブリソース行]の表形式で出力します。 tableC:[インスタンス別表示]の表形式で出力します。 tableD:[サブリソース別表示]の表形式で出力します。 graph:折れ線グラフ形式で出力します。 graphB:ヒストグラム形式で出力します。 graphC:[サブリソース別表示]の集合縦棒グラフ形式で出力します。 graphD:[インスタンス別表示]の集合縦棒グラフ形式で出力します。 graphE:[サブリソース別表示]の積み上げ縦棒グラフ形式で出力します。 graphF:[インスタンス別表示]の積み上げ縦棒グラフ形式で出力します。 graphG:[サブリソース別表示]の円グラフ形式で出力します。 graphH:[インスタンス別表示]の円グラフ形式で出力します。 省略した場合はtableAが仮定されます。 |
plot_type 《1h》((5分〜31日)) |
グラフ形式で出力する際のプロットタイプを指定します。指定した時間の平均値をグラフにプロットします。単位には,「m(分)」,「h(時間)」,または「d(日)」を指定できます。
|
graph_xdivide 《4n》 ((1〜60)):分割数指定のとき ((1分〜365日)):時間指定のとき |
グラフ形式で出力する際の,時間軸の目盛線を指定します。なお,表形式のレポートの場合,この設定は無視されます。 数字の後ろに単位を付けて指定します。単位は「n(分割)」,「m(分)」,「h(時間)」,または「d(日)」を使用してください。 指定できる値の範囲は,分割数指定の場合(単位がn指定の場合),1〜60です。時間間隔の場合(単位がm,h,d指定の場合),1分〜365日です。 無効な値および単位を指定した場合,レポート作成時にエラーになり,レポートは作成できません。 |
graph_threshold_info 《*,off,off》 |
グラフ形式で出力する際の,しきい値情報の表示の有無を指定します。なお,表形式のレポートの場合,この設定は無視されます。
「*」とサブリソースIDの両方を指定した場合,「*」の指定が有効になります。 無効な値および文字列を指定した場合,レポート作成時にエラーになり,レポートは作成できません。 しきい値線の出力を設定した場合に,しきい値線の出力対象となるサブリソースおよびインスタンスのしきい値を監視していないとき,しきい値線は値0の線で出力します。 |
graph_blank 《off》 |
指定したデータ抽出期間内で,各プロットタイプで指定した時間間隔内にリソース収集データが存在しない場合の,グラフ線表示の有無を設定します。なお,表形式のレポートの場合,この設定は無視されます。
|
graph_legend_row 《10》((0〜100の整数)) |
グラフ凡例のインスタンス表示の列数を設定します。なお,表形式の出力時には無視されます。
|
graph_statistics_info |
グラフへの統計表示の設定をします。なお,表形式の出力時は無視されます。
|
graph_time_adjust 《off》 |
グラフ時間軸の開始時刻および終了時刻に,データ抽出期間に指定した時刻を設定します。なお,表形式の出力時はこの設定は無視されます。
データ抽出期間の開始時刻および終了時刻のどちらか,または両方を省略した場合で,値をonとしたとき,省略された側の時刻には,offを指定した場合と同じ時刻が設定されます。 無効な値および文字列を指定した場合,レポート作成時にエラーになり,レポートは作成できません。 |
graph_maxline 《64》((1〜1024)) |
集合縦棒グラフ,積み上げ縦棒グラフ,または円グラフの最大グラフ行数を指定します。 |
graph_piechart_std 《100》((1×10-2〜1.7976931348623157×10308)) |
円グラフ指定時に,指定した値を100%の値としてグラフ要素の値を計算し,円グラフを表示します。 |
graph_histo_num 《10》((4〜20)) |
ヒストグラム指定時に,データ区間の個数を設定します。 |
graph_max_min 《off,100.00,0.00》 ((-1.7976931348623157×10308〜1.7976931348623157×10308)) |
on,縦軸の最大値,縦軸の最小値を指定した場合,グラフの縦軸の最大値・最小値を設定します。ただし,グラフの値が縦軸の最大値を上回る場合や,縦軸の最小値を下回る場合は,縦軸が自動補正されます。同様に,しきい値が縦軸の最大値を上回る場合や,縦軸の最小値を下回る場合も,縦軸が自動補正されます。
off,縦軸の最大値,縦軸の最小値を指定した場合,on設定時の動作が無効になり,グラフの縦軸の最大値・最小値は自動設定となります。ただし,このキーで指定された最大値・最小値の妥当性をチェックします(作成されるグラフの縦軸の値の範囲はバージョン08-00と同じ)。 |
- 注※1
-
通し番号は,ssoextractlogコマンドを,-listオプションを指定して実行すると参照できます。
- 注※2
-
ユーザリソースのサブリソースに付与されるサブリソースIDについては,「7.3.14(6)(d) サブリソースIDについて」を参照してください。
SSOが提供しているリソースのサブリソースIDについては「付録G リソース一覧」を参照してください。
HTML形式のレポートとキー値の反映の可否の対応を,次の表に示します。
キー値 |
複数 |
省略 |
レポートの形式 |
|||||
---|---|---|---|---|---|---|---|---|
表 |
折れ線 |
ヒストグラム |
集合縦棒 |
積み上げ縦棒 |
円 |
|||
title |
× |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
target |
× |
× |
○ |
○ |
○ |
○ |
○ |
○ |
resource_id |
× |
× |
○ |
○ |
○ |
○ |
○ |
○ |
subresource_id |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
instance |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
format |
× |
○ |
○ |
○ |
○ |
○ |
○ |
○ |
plot_type |
× |
○ |
× |
○ |
× |
○ |
○ |
○ |
graph_xdivide |
× |
○ |
× |
○ |
× |
× |
× |
× |
graph_threshold_info |
○ |
○ |
× |
○ |
× |
× |
× |
× |
graph_blank |
× |
○ |
× |
○ |
× |
× |
× |
× |
graph_legend_row |
× |
○ |
× |
○ |
○ |
○ |
○ |
○ |
graph_statistics_info |
× |
○ |
× |
○ |
× |
○ |
○ |
○ |
graph_time_adjust |
× |
○ |
× |
○ |
× |
○ |
○ |
○ |
graph_maxline |
× |
○ |
× |
× |
× |
○ |
○ |
○ |
graph_piechart_standard |
× |
○ |
× |
× |
× |
× |
× |
○ |
graph_histo_num |
× |
○ |
× |
× |
○ |
× |
× |
× |
graph_max_min |
× |
○ |
× |
○ |
○ |
○ |
○ |
× |
○:キー値を反映する。
×:キー値を反映しない。
(4) 定義例
レポート定義ファイルの定義例を次に示します。
(5) 注意事項
レポート定義ファイルに無効となる記述をした場合,次のエラーが出力されます。
-
ssodemandrptコマンドによるレポート作成の場合
標準出力とログ出力で表示します。
-
GUI操作によるレポート作成の場合
エラーダイアログとログ出力で表示します。