jpcrdef create
形式
jpcrdef create [-mx 最大ヒープサイズ] [-ms 初期ヒープサイズ] [-dateformat 日付フォーマットのパターン名] [-dateseparator 日付フォーマットのセパレーター名] 入力ファイル
機能
jpcrdef createコマンドは,PFM - Managerに接続し,レポート定義を新規作成するコマンドです。定義内容は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。1つのパラメーターファイルに複数のレポート定義を指定し,一括して作成できます。
コマンドを実行できるホスト
PFM - Web Console
実行権限
- Windowsの場合
-
Administrators権限を持つユーザー
- UNIXの場合
-
rootユーザー権限を持つユーザー
また,コマンドを実行するためには,事前にPerformance Managementに対する管理ユーザー権限または一般ユーザー権限※のユーザーアカウントで認証用のキーファイルを作成する必要があります。詳細については,「jpcmkkey」コマンドを参照してください。
- 注※
-
Performance ManagementユーザーまたはJP1ユーザーが必要とする,Performance Managementに対する実行権限です。
格納先ディレクトリ
- Windowsの場合
-
インストール先フォルダ\tools\
- UNIXの場合
-
/opt/jp1pcwebcon/tools/
引数
-mx 最大ヒープサイズ
java.exeの最大ヒープサイズをメガバイト単位で指定します。デフォルトは,128メガバイトです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-
1〜2,048の整数
-
「-mxの指定値 >= -msの指定値」
-ms 初期ヒープサイズ
java.exeの初期ヒープサイズをメガバイト単位で指定します。デフォルトは,32メガバイトです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。
-
1〜2,048の整数
-
「-mxの指定値 >= -msの指定値」
-dateformat 日付フォーマットのパターン名
指定したパターン名に対応する日付フォーマットで,入力ファイルの<expression>タグに記述した日付の形式を判定します。指定できる日付フォーマットのパターン名を次に示します。
-
pattern-ddMMyyyy
-
pattern-MMddyyyy
-
pattern-yyyyMMdd
-dateseparator 日付フォーマットのセパレーター名
指定したセパレーター名に対応するセパレーター文字列で,入力ファイルの<expression>タグに記述したセパレーターの形式を判定します。指定できる日付フォーマットのセパレーター名を次に示します。
-
space
-
slash
-
hyphen
-
period
入力ファイル
レポートを新規作成するためのXML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。
パラメーターファイルの形式
XMLタグ仕様
-
report-definitions
種別
説明
意味
レポート定義情報のルートタグ
指定可能値
なし
省略
不可
属性
なし
親要素
pr-cli-parameters
子要素
report-definition
-
report-definition
種別
説明
意味
1つのレポート定義を指定する。
指定可能値
なし
省略
不可
属性
name
1〜64文字(バイトではない)の全角文字または半角文字でレポート定義名を指定する。レポート定義名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。全角と半角文字が混在できる。すでにあるレポート定義名称を指定すると,エラーになる。parent-folder属性を指定して,name属性を省略した場合もエラーになる。レポート定義名の前後に半角空白を指定すると,前後の半角空白を除いた名称で登録される。
parent-folder
name属性のレポート定義を格納するディレクトリを指定する。1〜64文字(バイトではない)の全角文字または半角文字のディレクトリ名を最上位ディレクトリから「/」で区切って指定する。全角と半角文字が混在できる。パスの場合は,上位レベルのディレクトリ名から順に半角「/」で区切って指定する。ディレクトリ名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。システム定義のレポート定義ディレクトリは指定できない。ディレクトリがない場合は,作成する。省略するとエラーになる。ディレクトリ名の前後に半角空白を指定するとエラーになる。
例えば,ルートディレクトリ「User Reports」の配下にあるレポート定義名「PD define」のレポート定義をファイルに出力する場合,次のように指定する。
<report-definition name="PD define" parent-folder="/"/>
また,ルートディレクトリ「User Reports」配下のディレクトリ「Dir1」内のディレクトリ「Dir2」にある,すべてのレポート定義をファイルに出力する場合,次のように指定する。
<report-definition parent-folder="/Dir1/Dir2"/>
id
指定しても無視される。
read-only
「TRUE」の場合は,レポート定義の生成を中断して,次のreport-definition要素を処理する。省略または「FALSE」の場合は,レポート定義を作成する。
親要素
report-definitions
子要素
product-id
report-type
record
indication-settings
realtime-indication-settings
view-type
drilldown
-
product-id
種別
説明
意味
レポート情報を収集する製品の種別
指定可能値
プロダクトIDにデータモデルバージョン番号を付けたプロダクトコードを指定する。プロダクトIDは,エージェント製品を識別する半角英大文字。データモデルバージョンとは,エージェントが与える番号。プロダクトIDについては,各PFM - AgentまたはPFM - RMのマニュアルの,識別子について説明している個所を参照。
「レポートAのデータモデルバージョン ≧ レポートBのデータモデルバージョン」である場合,レポートAからレポートBにドリルダウンできる。
省略
不可
属性
なし
親要素
report-definition
子要素
なし
-
report-type
種別
説明
意味
レポート種別を指定する。
指定可能値
なし
省略
不可
属性
type
次に示す指定値を英字半角(小文字だけ,または大文字だけ)で指定する。
-
「履歴(1つのエージェント)レポート」の場合
「historical-single-agent」または
「HISTORICAL-SINGLE-AGENT」
-
「履歴(複数のエージェント)レポート」の場合
「historical-multiple-agents」または
「HISTORICAL-MULTIPLE-AGENTS」
-
「リアルタイム(1つのエージェント)レポート」の場合
「realtime-single-agent」または
「REALTIME-SINGLE-AGENT」
親要素
report-definition
子要素
なし
-
-
record
種別
説明
意味
レポート対象レコードを指定する。
指定可能値
なし
省略
不可
属性
id
レコードIDを指定する。省略できない。report-type設定値との組み合わせによって,指定できるレコード属性が決まる。詳細については,「表3-32 レポートに指定できるレコード属性とフィールドの組み合わせ」を参照。
親要素
report-definition
子要素
fields
condition-expression
-
fields
種別
説明
意味
レポート対象フィールドを1つ以上指定する。
指定可能値
なし
省略
不可
属性
なし
親要素
record
子要素
field
-
field
種別
説明
意味
レポート対象フィールドを1つ指定する。
指定可能値
選択したレコードのフィールドIDを指定する。すべてのfield要素のすべての属性(table/list/graph)を「FALSE」に指定できない。必ずtable/list/graphのどれか1つを「TRUE」に指定する。
すべてのfieldでtable/list/graphに「FALSE」を指定した場合はエラーとなる。また,fieldsタグ内で重複するフィールドIDを用いてfieldタグを指定した場合はエラーとなる。
フィールドの中には,履歴データとしてAgent StoreおよびRemote Monitor Storeに記録するときだけ追加収集され,計算されるxxxx(Total)などのフィールドがある。これらのフィールドは,リアルタイムレポートの場合には指定できない。指定した場合は,エラーとなる。詳細については,「表3-36 リアルタイムレポートで指定できないフィールド」を参照。
省略
不可
属性
table
表を表示する場合は「TRUE」,それ以外は「FALSE」を指定する。省略できない。
list
一覧を表示する場合は「TRUE」,それ以外は「FALSE」を指定する。省略できない。
graph
グラフを表示する場合は「TRUE」,それ以外は「FALSE」を指定する。省略できない。
テキスト形式のフィールドの場合は,「TRUE」を指定するとエラーになる。
display-name
24文字以内の全角または半角文字列でユーザー表示名を指定する。
省略した場合,空文字指定(display-name="")の場合,および半角空白文字指定(display-name=" ")の場合は,フィールド名を表示する。
親要素
fields
子要素
なし
-
condition-expression
種別
説明
意味
フィルターの条件式の論理演算を指定する。
指定可能値
なし
省略
可(省略時は設定しない)
属性
なし
親要素
record
ref-field
子要素
and
or
expression
-
expression
種別
説明
意味
条件式を指定する。
指定可能値
(1)フィルター条件に指定する場合
条件式は「フィールド 条件 ["値"]」の形式で指定する。フィールド・条件・値の区切りに空白は使用できない。
データ型がtime_tのフィールドは,値を省略しspecify-when-displayedを「TRUE」に設定した場合だけ指定できる。
フィールド
フィールドは,レコードに含まれるフィールドを「PFM - Manager名」で指定する。PFM - Manager名については,各PFM - AgentまたはPFM - RMマニュアルのレコードの説明を参照。
条件
条件に指定する値を次に示す。
-
「=」:フィールドの値と["値"]が等しい。
-
「<」:フィールドの値が["値"]より小さい。
-
「<=」:フィールドの値が["値"]より小さいか等しい。
-
「>」:フィールドの値が["値"]より大きい。
-
「>=」:フィールドの値が["値"]より大きいか等しい。
-
「<>」:フィールドの値と["値"]が異なる。
XMLの表記として「<」は「<」,「>」は「>」を指定する。
文字列フィールドの場合は,ASCIIコードの昇順に比較する。
["値"]
「"」で囲んで指定する。指定できるバイト数は,最大2,048バイト。
文字コード,データ長,データ形式は,左辺に指定するフィールドのデータ型に依存する。
specify-when-displayed属性を「TRUE」に設定している場合は,値を省略できる。
値に制御文字および「( ) [ ] < > = "」の文字は指定できない。指定した場合はエラーになる。
各PFM - AgentまたはPFM - RMマニュアルに記述されているフィールドのデータ型に合わせ指定する。次に示す設定範囲で指定する。
-
文字(指定値をそのまま設定)
-
整数(Integerで表現できる範囲の値)
-
小数(Doubleで表現できる範囲の値で,小数点以下が4桁以上の場合,IEEE754規格のRound to nearestの仕様※に従って4桁に丸める)
-
日付(dd MM yyyy,MM dd yyyy,yyyy MM ddのどれか。OSのロケールの設置値と同じ表示形式を指定する)
(時刻はHH:mm:ss固定)
日付の表示形式については,マニュアル「JP1/Performance Management 設計・構築ガイド」を参照。
(2)ドリルダウン対象のフィールドに指定する場合
条件式は,「フィールド 条件 ["値"]」または「フィールド 条件 フィールド」の形式で指定する。フィールド・条件・値の区切りに空白は使用できない。
フィールド
ドリルダウンレポートに指定したレコードに含まれるフィールドを指定する。
条件
「(1)フィルター条件に指定する場合」の条件を参照。
["値"]またはフィールド
-
右辺に値を指定する場合
指定する値については,「(1)フィルター条件に指定する場合」の["値"]を参照。
-
右辺にフィールドを指定する場合
レコードのフィールドID,DATETIMEフィールド,またはODBCキーフィールドを指定する。ODBCキーフィールドについては,各PFM - AgentまたはPFM - RMマニュアルを参照。
省略
可(condition-expressionを指定した場合は省略できない)
属性
specify-when-displayed
実行時に設定する場合は「TRUE」,それ以外は「FALSE」と指定する。省略時は,「FALSE」となる。要素値の論理式に値を指定しないで「FALSE」を指定すると,エラーになる。
親要素
condition-expression
and
or
子要素
なし
-
-
and
種別
説明
意味
expressionで指定した論理式のAND演算を指定する。
指定可能値
なし
省略
可(条件式の論理積を指定する場合に指定する)
属性
なし
親要素
and
or
condition-expression
子要素
expression
and
or
-
or
種別
説明
意味
expressionで指定した論理式のOR演算を指定する。
指定可能値
なし
省略
可(条件式の論理和を指定する場合に指定する)
属性
なし
親要素
and
or
condition-expression
子要素
expression
and
or
-
indication-settings
種別
説明
意味
レポート表示期間,レポート間隔,ピーク時間表示,および最大レコード数を指定する。
indication-settingsは,report-typeが「historical-single-agent」または「historical-multiple-agents」のときだけ指定できる。report-typeが「realtime-single-agent」のときに指定するとエラーになる。
指定可能値
なし
省略
可(省略時は子要素も含め,デフォルトとなる)
属性
specify-when-displayed
レポート表示時に指定する場合は「TRUE」,それ以外は「FALSE」と指定する。省略時は「FALSE」とする。
maximum-number-of-records
1〜2,147,483,647の整数でレポートに表示する最大レコード数を指定する。省略時は1,440とする。
親要素
report-definition
子要素
date-range
report-interval
peak-time
-
date-range
種別
説明
意味
レポート表示期間を指定する。
指定可能値
次の値を指定する。
-
過去1時間以内の場合「WITHIN_THE_PAST_HOUR」
-
過去1日(24時間)以内の場合「WITHIN_THE_PAST_24_HOURS」
-
過去7日以内の場合「WITHIN_THE_PAST_7_DAYS」
-
過去1か月以内の場合「WITHIN_THE_PAST_MONTH」
-
過去1年以内の場合「WITHIN_THE_PAST_YEAR」
-
レポート表示時に指定する場合「SPECIFY_WHEN_DISPLAYED」
大文字と小文字は区別しない。
省略
可(省略時は「SPECIFY_WHEN_DISPLAYED」となる)
属性
なし
親要素
indication-settings
子要素
なし
-
-
report-interval
種別
説明
意味
レポート間隔を指定する。
指定可能値
次の値を指定できる。大文字と小文字は区別しない。
-
分単位の場合「MINUTE」
-
時間単位の場合「HOUR」
-
日単位(24時間)以内の場合「DAY」
-
週単位の場合「WEEK」
-
月単位の場合「MONTH」
-
年単位の場合「YEAR」
PIレコード以外を指定した場合,エラーになる。
省略
可(省略時は「HOUR」となる)
属性
なし
親要素
indication-settings
子要素
なし
-
-
peak-time
種別
説明
意味
指定したフィールド値が最大となる時間だけレポート表示する。
指定可能値
recordで指定したレコードが単数インスタンスの場合,そのどれかのフィールドIDを指定する。1日の内でそのフィールドの値が最大となる時間のレコードだけを表示する。report-intervalが「HOUR」以外の場合,レコードが複数インスタンスの場合,またはreport-typeがHISTORICAL-MULTIPLE-AGENTSの場合は,エラーになる。
省略
可(省略時はpeak-timeにフィールドを設定しない)
属性
なし
親要素
indication-settings
子要素
なし
-
realtime-indication-settings
種別
説明
意味
リアルタイムレポートの更新間隔,ランキング表示を指定する。
realtime-indication-settingsは,report-typeが「realtime-single-agent」のときだけ指定できる。report-typeが「realtime-single-agent」以外のときに指定するとエラーになる。
指定可能値
なし
省略
可(省略時は子要素も含め,デフォルトとなる)
属性
specify-when-displayed
レポート表示時に指定する場合は「TRUE」,それ以外は「FALSE」と指定する。省略時は「FALSE」となる。
indicate-delta-value
デルタ値で表示する場合は「TRUE」,それ以外は「FALSE」と指定する。省略時は「TRUE」となる。
デルタ値の表示可否については,エージェントで収集される各フィールドによって異なる。詳細は,「表3-35 リアルタイムレポートのデルタ値の表示条件」を参照。
親要素
report-definition
子要素
refresh-interval
display-by-ranking
-
refresh-interval
種別
説明
意味
自動更新の有無,自動更新時の間隔の初期値(秒数),最小値(秒数)を指定する。
指定可能値
なし
省略
可(省略時は自動更新する)
属性
do-not-refresh-automatically
リアルタイムレポート表示データを自動更新しない場合は「TRUE」,自動更新する場合は「FALSE」を指定する。省略時は,「FALSE」となる。
initial-value
do-not-refresh-automaticallyが「FALSE」の場合,レポート表示データの自動更新間隔を「minimum-value指定値〜3,600秒」の整数で指定する。
do-not-refresh-automaticallyが「TRUE」の場合にinitial-valueを指定するとエラーになる。
initial-valueおよびminimum-valueを両方とも省略した場合,initial-value値は「60秒」となる。
minimum-valueを指定し,initial-valueを省略した場合,initial-value値は「minimum-value指定値」となる。
minimum-value
do-not-refresh-automaticallyが「FALSE」の場合,レポート表示データの自動更新間隔の変更できる最小値を「10〜3,600秒」の整数で指定する。
do-not-refresh-automaticallyが「TRUE」の場合にminimum-valueを指定するとエラーになる。
initial-valueおよびminimum-valueを両方とも省略した場合,minimum-value値は「60秒」となる。
initial-valueを指定し,minimum-valueを省略した場合,minimum-value値は「initial-value指定値」となる。
親要素
realtime-indication-settings
子要素
なし
-
display-by-ranking
種別
説明
意味
field属性で指定したフィールドを昇順または降順にソートして,先頭からdisplay-number属性で指定した件数をランキングデータとしてレポート表示する場合に指定する。
複数行のレコード(複数インスタンスレコード)の場合だけ指定できる。単一行のレコードの場合に指定するとエラーになる。
display-by-rankingとdisplay-keyの両方を指定した場合,display-by-rankingの条件で取得したデータをdisplay-keyの条件に従って表示する。
指定可能値
なし
省略
可(省略時はランキングを表示しない)
属性
field
ランキング表示するときの表示判定基準となるフィールドIDを指定する。省略時はエラーになる。
ランキング表示に指定できない属性のフィールドを指定した場合はエラーになる。
ランキング表示時に指定できるフィールドのデータ型は「表3-31 指定できるパラメーターの組み合わせ(リアルタイムレポートの場合)」を参照。
display-number
ランキング表示する件数を1〜100の整数で指定する。省略時は「10」となる。
in-descending-order
ランキング表示の判定基準となるフィールドIDを降順または昇順でソートし,先頭からdisplay-number属性で指定した件数分を表示する。
昇順でソートする場合は「TRUE」,降順でソートする場合は「FALSE」を指定する。省略時は「FALSE」となる。
親要素
realtime-indication-settings
子要素
なし
-
view-type
種別
説明
意味
レポートの表現形式を指定する。
指定可能値
なし
省略
可(display-keyとgraph-propertiesをすべてデフォルトに設定する)
属性
なし
親要素
report-definition
子要素
display-key
graph-properties
-
display-key
種別
説明
意味
レコードをソートするためのフィールドを指定する。display-keyを指定すると,graph-typeにLINE,AREA,STACKED_AREAは指定できない。
指定可能値
フィールドIDを指定する。
省略
可(省略時は時系列で表示する)
属性
in-descending-order
-
「TRUE」の場合,降順ソート。
-
「FALSE」または省略の場合,昇順ソート。
親要素
view-type
子要素
なし
-
-
graph-properties
種別
説明
意味
グラフ種別とグラフ書式を指定する。<field>タグでgraph=trueに設定されているフィールドがない場合に<graph-properties>タグを指定するとエラーになる。
指定可能値
なし
省略
可
属性
show-areas-of-missing-data
「TRUE」を指定した場合,エージェントが起動していなかったなどの原因でデータが欠落していると,グラフ種別が「LINE」,「AREA」,「STACKED_AREA」およびデータが複数のエージェントまたは複数インスタンスならば,その部分を表示しない。「FALSE」の場合は,その部分を補完する。
省略時は「FALSE」とする。
series-direction
表示グラフをレコード(行方向)単位にまとめる場合は「BY_ROW」,フィールド(列方向)単位にまとめる場合は「BY_COLUMN」を指定する。
graph-typeが「LINE」,「AREA」,または「STACKED_AREA」の場合は,指定値を無視する。graph-typeが「LINE」,「AREA」,または「STACKED_AREA」の場合で,複数行のレポートまたは複数のエージェントの場合は,「BY_COLUMN」を仮定し,それ以外は「BY_ROW」を仮定する。
graph-typeが「LINE」,「AREA」,または「STACKED_AREA」以外の場合で,省略時は「BY_ROW」とする。
親要素
view-type
レポート表示形式を規定する。
子要素
graph-type
axis-labels
data-label
-
graph-type
種別
説明
意味
グラフの種類を指定する。
指定可能値
次の値を指定する。
-
集合縦棒グラフの場合「COLUMN」
-
積み上げ縦棒グラフの場合「STACKED_COLUMN」
-
集合横棒グラフの場合「BAR」
-
積み上げ横棒グラフの場合「STACKED_BAR」
-
円グラフの場合「PIE」
-
折れ線グラフの場合「LINE」
-
面グラフの場合「AREA」
-
積み上げ面グラフの場合「STACKED_AREA」
大文字と小文字は区別しない。
省略
可(省略時は集合縦棒「COLUMN」とする)
属性
なし
親要素
graph-properties
子要素
なし
-
-
axis-labels
種別
説明
意味
グラフのX軸とY軸ラベルを指定する。<graph-type>タグで「PIE」を指定して,X軸ラベルまたはY軸ラベルを指定するとエラーになる。
指定可能値
なし
省略
可(省略時はX軸とY軸ラベルを表示しない)
属性
なし
親要素
graph-properties
子要素
x-axis
y-axis
-
x-axis
種別
説明
意味
グラフのX軸ラベルを指定する。
指定可能値
0〜40文字(全角も1文字と数える)で指定する。
省略
可(省略時はX軸ラベルを表示しない)
属性
なし
親要素
axis-labels
子要素
なし
-
y-axis
種別
説明
意味
グラフのY軸ラベルを指定する。
指定可能値
0〜40文字(全角も1文字と数える)で指定する。
省略
可(省略時はY軸ラベルを表示しない)
属性
なし
親要素
axis-labels
子要素
なし
-
data-label
種別
説明
意味
ラベル表示フィールドを指定する。レコードに単数インスタンスを指定し,report-typeに「historical-single-agent」およびgraph-typeに「LINE」,「AREA」,または「STACKED_AREA」を指定している場合,data-labelを指定すると,エラーになる。
指定可能値
なし
省略
可(省略時はデータラベルを表示しない)
属性
なし
親要素
graph-properties
子要素
data-label1
data-label2
-
data-label1
種別
説明
意味
データラベル1のラベル表示フィールドを指定する。データラベルにはさらにデータラベル2が指定できる。データラベル2に表示する値は,データラベル1の右に括弧で囲まれて表示される。
指定可能値
report-typeが「historical-single-agent」
単数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
DATETIMEフィールド
複数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
DATETIMEフィールド
-
レコード固有のODBCキーフィールド
report-typeが「historical-multiple-agents」
単数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
DATETIMEフィールド
-
DEVICEIDフィールド
-
PROD_INSTフィールド
report-typeが「realtime-single-agent」
単数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
RECORD_TIMEフィールド
複数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
RECORD_TIMEフィールド
-
レコード固有のODBCキーフィールド
ODBCキーフィールドについては,各PFM - AgentまたはPFM - RMマニュアルを参照。
省略
可(省略時はデータラベル1を設定しない)
属性
なし
親要素
data-label
子要素
なし
-
-
data-label2
種別
説明
意味
データラベル2のラベル表示フィールドをrecordに対応するフィールドIDで指定する。data-label1を指定しないでdata-label2を指定するとエラーとなる。
指定可能値
report-typeが「historical-single-agent」
単数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
DATETIMEフィールド
複数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
DATETIMEフィールド
-
レコード固有のODBCキーフィールド
report-typeが「historical-multiple-agents」
単数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
DATETIMEフィールド
-
DEVICEIDフィールド
-
PROD_INSTフィールド
report-typeが「realtime-single-agent」
単数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
RECORD_TIMEフィールド
複数インスタンスレコードの場合
-
fieldsタグで指定したフィールドID
-
RECORD_TIMEフィールド
-
レコード固有のODBCキーフィールド
ODBCキーフィールドについては,各PFM - AgentまたはPFM - RMマニュアルを参照。
省略
可(省略時はデータラベル2を設定しない)
属性
なし
親要素
data-label
子要素
なし
-
-
drilldown
種別
説明
意味
ドリルダウン対象のフィールドとレポートを指定する。
指定可能値
なし
省略
可(省略時はドリルダウンを設定しない)
属性
なし
親要素
report-definition
子要素
field-drilldown
report-drilldown
-
field-drilldown
種別
説明
意味
ドリルダウン対象のフィールドを指定する。
指定可能値
なし
省略
可(省略時はドリルダウン対象のフィールドを設定しない)
属性
なし
親要素
drilldown
子要素
ref-field
-
ref-field
種別
説明
意味
ドリルダウン対象のフィールドを指定する。
指定可能値
なし。子要素condition-expressionに指定できるexpressionの条件式の左辺に指定するフィールドは,子要素ref-reportで指定するドリルダウンレポートのフィールド。
省略
可(省略時はドリルダウン対象のフィールドを設定しない)
属性
id
recordで指定したレコードに対応するフィールドIDを指定する。同じidを指定してref-fieldの要素を重複指定すると,エラーとなる。省略すると,condition-expressionは指定できない。
親要素
field-drilldown
子要素
ref-report
condition-expression
-
report-drilldown
種別
説明
意味
ドリルダウン対象のレポートを指定する。
指定可能値
なし
省略
可(省略時はドリルダウン対象のレポートを設定しない)
属性
なし
親要素
drilldown
子要素
ref-report
ref-bookmark
-
ref-report
種別
説明
意味
1つのレポート定義を指定する。
指定可能値
なし
省略
可(省略時はドリルダウン対象のレポートを設定しない)
属性
pathname
ディレクトリパスとレポート定義名を「ディレクトリパス/レポート定義名」の形式で指定する。ディレクトリパスは,ルートディレクトリから順に半角「/」で区切って指定する。ディレクトリ名に「\」か「/」を含む場合,それぞれ「\\」「\/」と記述する。ディレクトリ名とレポート定義名は,1〜64文字(バイトではない)の全角文字または半角文字で全角・半角が混在できる。存在しないレポート定義やreport-definitionで指定しているレポート定義を指定するとエラーになる。「レポートAのデータモデルバージョン ≧ レポートBのデータモデルバージョン」である場合,レポートAからレポートBにドリルダウンできる。
親要素
ref-field
report-drilldown
子要素
なし
-
ref-bookmark
種別
説明
意味
1つのブックマークまたは複合ブックマークを指定する。
指定可能値
なし
省略
レポートドリルダウンを設定しない。
属性
pathname
フォルダパスとブックマーク名を「フォルダパス/ブックマーク名」の形式で指定する。フォルダパスは,ルートフォルダから順にフォルダ名を半角「/」で区切って指定する。フォルダ名に「\」または「/」を含む場合は,それぞれ「\\」または「\/」と記述する。
- (例)ルート下のフォルダ名My BookmarkのCPU Trendを指定する場合
-
/My Bookmark/CPU Trend
多階層の場合は,「/Folder1/Folder2...」のようにフォルダ名を「/」で連結したフォルダパスを指定する。
フォルダ名とブックマーク名は,1〜64文字(バイトではない)の全角文字と半角文字で指定する。全角文字と半角文字は混在してもかまわない。存在しないブックマークが指定されたときはエラーになる。
なお,関連づけられたレポート定義,エージェントなどのブックマークそのものの妥当性はチェックされない。
親要素
report-drilldown
子要素
なし
履歴レポートのパラメーターファイルの記述例を次に示します。
パラメーターファイル記述例(履歴レポートの場合)
<?xml version="1.0" encoding="UTF-8"?> <!-- Workload Status (Multi-Agent)レポート --> <!-- 最近24時間の複数のシステムについての --> <!-- 1時間ごとのワークロード関連データを表示します --> <!DOCTYPE pr-cli-parameters SYSTEM "rdef_create_params.dtd"> <pr-cli-parameters ver="0110"> <report-definitions> <report-definition name="Workload Status (Multi-Agent)" parent-folder="/HQ/Monthly/Windows/Operating System/Status Reporting/Daily Trend" read-only="FALSE"> <product-id>T3.0</product-id> <report-type type="historical-multiple-agents"/> <record id="PI"> <fields> <field table="true" list="false" graph="true">PROCESSES</field> <field table="true" list="false" graph="false">SERVER_SESSIONS</field> <field table="true" list="false" graph="false">CONTEXT_SWITCHES_PER_SEC</field> <field table="true" list="false" graph="false">SYSTEM_CALLS_PER_SEC</field> <field table="true" list="false" graph="false">PCT_TOTAL_PROCESSOR_TIME</field> <field table="true" list="false" graph="false">PROCESSOR_QUEUE_LENGTH</field> <field table="true" list="false" graph="false">BYTES_TOTAL_PER_SEC</field> </fields> </record> <indication-settings specify-when-displayed="false" maximum-number-of-records="1440"> <date-range>WITHIN_THE_PAST_24_HOURS</date-range> <report-interval>HOUR</report-interval> <peak-time/> </indication-settings> <view-type> <graph-properties show-areas-of-missing-data="false" series-direction="BY_COLUMN"> <graph-type>LINE</graph-type> <axis-labels> <x-axis/> <y-axis>Processes</y-axis> </axis-labels> <data-label> <data-label1>PROCESSES</data-label1> <data-label2/> </data-label> </graph-properties> </view-type> </report-definition> </report-definitions> </pr-cli-parameters> <!--Workload Status (Multi-Agent)レポート定義終了 -->
リアルタイムレポートのパラメーターファイルの記述例を次に示します。
パラメーターファイル記述例(リアルタイムレポートの場合)
<?xml version="1.0" encoding="UTF-8"?> <!-- CPU Usage - Top 10 Processesレポートは, --> <!-- CPU使用率が高いプロセスの上位10個をリアルタイムで表示します--> <!DOCTYPE pr-cli-parameters SYSTEM "rdef_create_params.dtd"> <pr-cli-parameters ver="0110"> <report-definitions> <report-definition name="CPU Usage - Top 10 Processes" parent-folder="/HQ/Monthly/Windows/Operating System/Troubleshooting/Real-Time" read-only="FALSE"> <product-id>T3.0</product-id> <report-type type="realtime-single-agent"/> <record id="PD_PDI"> <fields> <field table="false" list="false" graph="false">INSTANCE</field> <field table="true" list="false" graph="false">ID_PROCESS</field> <field table="false" list="false" graph="true">PCT_PROCESSOR_TIME</field> </fields> </record> <realtime-indication-settings specify-when-displayed="false" indicate-delta-value="false"> <refresh-interval do-not-refresh-automatically="false" initial-value="30" minimum-value="10"/> <display-by-ranking field="PCT_PROCESSOR_TIME" display-number="10" in-descending-order="false"/> </realtime-indication-settings> <view-type> <graph-properties show-areas-of-missing-data="false" series-direction="BY_COLUMN"> <graph-type>BAR</graph-type> <axis-labels> <x-axis>Program(PID)</x-axis> <y-axis>CPU %</y-axis> </axis-labels> <data-label> <data-label1>INSTANCE</data-label1> <data-label2>ID_PROCESS</data-label2> </data-label> </graph-properties> </view-type> </report-definition> </report-definitions> </pr-cli-parameters> <!-- CPU Usage - Top 10 Processesレポート定義終了 -->
注意事項
-
このコマンドは,実行時にPFM - Managerに対する認証が必要です。認証用のキーファイルを作成していない場合は,コマンドを実行する前に,jpcmkkeyコマンドで認証用のキーファイルを作成してください。
-
複数のレポート定義を連続登録中に例外が発生すると,コマンドはその定義の登録を中断し,ほかの定義があればそれを登録します。
-
<condition-expression>タグの<and>と<or>タグ下には2つの要素しか指定できません。
記述例を次に示します。
<and> <expression>式1</expression> <or> <expression>式2</expression> <or> <expression>式3</expression> <or> <expression>式4</expression> <expression>式5</expression> </or> </or> </or> </and>
<expression>タグに指定する式の記述例を次に示します。
<expression>SEGMENTS_RETRANSMITTED_PER_SEC>"100"</expression> <expression>RECORD_TIME>"2003 05 31 11:22:33"</expression>
-
定義できるレコード,フィールド名称,フィールドのデータ型については,各PFM - AgentまたはPFM - RMマニュアルを参照してください。
-
値を指定しなかったパラメーターは,デフォルトを適用してレポート定義を作成します。作成されたレポート定義のパラメーターをすべて確認するには,作成したパラメーターファイルを指定して出力コマンドを実行します。
-
パラメーター指定の組み合わせについては,次の表に示す制限があります。
表3‒30 指定できるパラメーターの組み合わせ(履歴レポートの場合) レポート種別
レコードタイプ
フィールドのデータ型
ピーク時間
フィールド表示形式
表
一覧
グラフ
display-key
履歴(1つのエージェント)レポート
単数インスタンス
string
×
○
○
×
○
char
×
○
○
×
○
time_t
×
○
○
×
○
timeval
×
○
○
○
○
utime
×
○
○
○
○
float
○
○
○
○
○
ulong
○
○
○
○
○
short
○
○
○
○
○
double
○
○
○
○
○
long
○
○
○
○
○
複数インスタンス
string
×
○
○
×
○
char
×
○
○
×
○
time_t
×
○
○
×
○
timeval
×
○
○
○
○
utime
×
○
○
○
○
float
×
○
○
○
○
ulong
×
○
○
○
○
short
×
○
○
○
○
double
×
○
○
○
○
long
×
○
○
○
○
履歴(複数のエージェント)レポート
単数インスタンス
string
×
○
○
×
×
char
×
○
○
×
×
time_t
×
○
○
×
×
timeval
×
○
○
○
×
utime
×
○
○
○
×
float
○
○
○
○
×
ulong
○
○
○
○
×
short
○
○
○
○
×
double
○
○
○
○
×
long
○
○
○
○
×
表3‒31 指定できるパラメーターの組み合わせ(リアルタイムレポートの場合) レポート種別
レコードタイプ
フィールドのデータ型
ランキング表示
フィールド表示形式
表
一覧
グラフ
display-key
リアルタイム(1つのエージェント)レポート
単数インスタンス
string
×
○
○
×
○
char(n)
×
○
○
×
○
time_t
×
○
○
×
○
timeval
×
○
○
○
○
utime
×
○
○
○
○
float
×
○
○
○
○
ulong
×
○
○
○
○
short
×
○
○
○
○
double
×
○
○
○
○
long
×
○
○
○
○
複数インスタンス
string
×
○
○
×
○
char(n)
×
○
○
×
○
time_t
×
○
○
×
○
timeval
○
○
○
○
○
utime
○
○
○
○
○
float
○
○
○
○
○
ulong
○
○
○
○
○
short
○
○
○
○
○
double
○
○
○
○
○
long
○
○
○
○
○
-
レポート種別には,「履歴(1つのエージェント)レポート」,「履歴(複数のエージェント)レポート」,および「リアルタイム(1つのエージェント)レポート」があります。レポートが扱うことのできるレコード属性には,単数インスタンスと複数インスタンスがあります。ただし,「履歴(複数のエージェント)レポート」が扱えるレコード属性は,単数インスタンスだけです。
また,graph-typeに「LINE」,「AREA」,「STACKED_AREA」を指定している場合,インスタンスとフィールドは同時に複数指定できません。その場合のレポートに指定できるレコード属性とフィールドの組み合わせを次の表に示します。
表3‒32 レポートに指定できるレコード属性とフィールドの組み合わせ レポート種別
レコード属性
1つのフィールド
複数のフィールド
履歴(1つのエージェント)レポート
単数インスタンス
○
○
複数インスタンス
○
×
履歴(複数のエージェント)レポート
単数インスタンス
○
×
リアルタイム(1つのエージェント)レポート
単数インスタンス
○
○
複数インスタンス
○
×
-
display-key指定がある場合,graph-typeに「LINE」,「AREA」,「STACKED_AREA」を指定するとエラーとなります。
-
time_t型のフィールドに対するフィルターの設定条件には,次の表に示す条件があります。
表3‒33 recordに設定するフィルターの設定条件 specify-when
-displayed設定
条件式
右辺
Date,Timeフィールド以外のtime_t型のフィールド
time_t型の中のDateフィールド
time_t型の中のTimeフィールド
TRUE
値
○
○
○
省略
○
○
○
FALSE
値
×
×
○
省略
×
×
×
表3‒34 ref-fieldに設定するフィルターの設定条件 specify-when
-displayed設定
条件式
右辺
Date,Timeフィールド以外のtime_t型のフィールド
time_t型の中のDateフィールド
time_t型の中のTimeフィールド
TRUE
フィールドID
×
×
×
値
×
×
○
省略
○
○
○
FALSE
フィールドID
○
○
○
値
×
×
○
省略
×
×
×
-
リアルタイムレポートのデルタ値は,PFM - AgentまたはPFM - RMで収集される各レコードの各フィールドによって異なります。デルタ値およびレコードのフィールドに,デルタ値が収集されるかどうかについては,各PFM - AgentまたはPFM - RMマニュアルのレコードについて説明している章(各レコードのフィールド一覧)を参照してください。
リアルタイムレポートのデルタ値の表示条件と表示内容を次の表に示します。また,PFM - AgentまたはPFM - RMによっては,表のとおりにならない場合があります。詳細は,各PFM - AgentまたはPFM - RMマニュアルで確認してください。
表3‒35 リアルタイムレポートのデルタ値の表示条件 realtime-indication-settingsのindicate-delta-value属性
各フィールドのデルタ属性
表示内容
TRUE
Yes
前回収集されたときから今回収集されるまでのパフォーマンスデータの変化量
No
収集された最新の値
FALSE
Yes
パフォーマンスデータの収集開始からの累積値
No
収集された最新の値
-
リアルタイムレポートに指定できないフィールドについて次の表に示します。
表3‒36 リアルタイムレポートで指定できないフィールド PFM - Web Consoleでの名称
Manager名
内容
Agent Host
DEVICEID
インスタンス名[ホスト名]またはホスト名
Agent Instance
PROD_INST
エージェントのインスタンス名
Agent Type
PROD_ID
エージェントのプロダクトID(1バイトの識別子)
Date
DATE
レコードが生成された日付(グリニッジ標準時間)
Date and Time
DATETIME
DateとTimeの組み合わせ
Drawer Type
DRAWER_TYPE
PIデータベース中の要約されている区分
GMT Offset
GMD_ADJUST
グリニッジ標準時間とローカル時間の差(秒)
Time
TIME
レコードが生成された時刻(グリニッジ標準時間)
xxxx(Total)
xxxx_TOTAL
PIレコードの場合,データの要約時に計算される合計値
xxxx_TOTAL_SEC(Total)
xxxx_TOTAL_SEC
データ要約期間内での合計値
xxxx_HI(Max)
xxxx_HI
データ要約期間内での最大値
xxxx_LO(Min)
xxxx_LO
データ要約期間内での最小値
xxxx_OV(OV)
xxxx_OV
データ要約期間内での合計で発生したオーバーフローの回数
-
通常,-mxオプションおよび-msオプションを設定する必要はありません。コマンド実行時に,メモリー不足を示すKAVJK0401-Eメッセージが出力された場合は,-mxオプションの最大ヒープサイズに64以上を指定して,再度実行してください。
-
ドリルダウンレポートには,コマンド実行時に定義済みのレポート定義だけを指定できます。これから定義しようとしているレポートをドリルダウンレポートに指定すると,KAVJK0125-Eメッセージが出力され,レポート定義に失敗します。
-
監視二重化の場合,セカンダリーのPFM - Managerに接続しているPFM - Web Consoleからの実行はできません。
-
登録するレポート自身を<ref-report>タグに指定できません。
戻り値
0 |
正常終了した。 |
1 |
コマンドラインの形式が不正である。 |
2 |
コマンドの実行権限がない。 |
3 |
出力ファイルの作成に失敗した。 |
5 |
DTDファイルと不整合のため,パラメーターが解析できない。 |
10 |
1件以上のレポート定義作成に失敗した。 |
11 |
PFM - Managerへの認証処理に失敗した。 |
12 |
監視二重化の場合に,セカンダリーのPFM - Managerに接続しているPFM - Web Consoleホストから実行しようとした。 |
100 |
環境が不正である。 |
200 |
メモリーエラーが発生した。 |
202 |
ファイルアクセスエラーが発生した。 |
222 |
通信処理でエラーが発生した。 |
255 |
予期しないエラーが発生した。 |
使用例
レポートの定義内容を記述したパラメーターファイル(rdef_create.xml)を新規に登録する場合のコマンド実行例を次に示します。
jpcrdef create rdef_create.xml
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「5. Performance Managementで出力するログ情報」を参照してください。
3つのレポート定義を指定し,1つのレポート定義がエラーとなった場合の標準出力形式を次に示します。
標準出力の出力例
jpcrdef create connected to vserv01 at 2006 03 20 15:00:55.282 create result OK : レポート定義ディレクトリパス1/レポート定義名1 create result OK : レポート定義ディレクトリパス2/レポート定義名2 create result ERR : レポート定義ディレクトリパス3/レポート定義名3 エラー要因 jpcrdef create disconnected at 2006 03 20 15:01:06.2