形式
jpcrdef create [-dateformat <日付フォーマットのパターン名>]
[-dateseparator <日付フォーマットのセパレーター名>]
<入力ファイル>
機能
jpcrdef createコマンドは,PFM - Managerに接続し,レポート定義を新規作成します。定義内容は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。1つのパラメーターファイルに複数のレポート定義を指定し,一括して作成できます。
実行権限
格納先ディレクトリ
オプション
jpcrdef createコマンド引数のオプションを次の表に示します。
表12-6 jpcrdef createコマンド引数のオプション
オプション | 必須 任意 | 目的 | 備考 |
---|---|---|---|
-dateformat <日付フォーマットのパターン名> | 任意 | 指定したパターン名に対応する日付フォーマットで,入力ファイルの<expression>タグに記述した日付の形式を判定します。指定できる日付フォーマットのパターン名を次に示します。
| なし |
-dateseparator <日付フォーマットのセパレーター名> | 任意 | 指定したセパレーター名に対応するセパレーター文字列で,入力ファイルの<expression-value>,<start-time>,<end-time>,<baseline-start-time>タグに記述したセパレーターの形式を判定します。また,出力ファイルのセパレーターの形式を決定します。指定できる日付フォーマットのセパレーター名を次に示します。
| なし |
<入力ファイル> | 必須 | レポートを新規作成するためのXML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。 | なし |
パラメーターファイルの形式
XMLタグ仕様
表12-7 report-definitions
種別 | 説明 |
---|---|
意味 | レポート定義情報のルートタグ |
指定可能値 | なし |
省略 | 不可 |
属性 | なし |
親要素 | pr-cli-parameters |
子要素 | report-definition |
表12-8 report-definition
種別 | 説明 | |
---|---|---|
意味 | 1つのレポート定義を指定します。 | |
指定可能値 | なし | |
省略 | 不可 | |
属性 | name | 1~64文字(バイトではない)の全角文字または半角文字でレポート定義名を指定します。レポート定義名に「¥」か「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。全角文字と半角文字が混在できます。すでに存在するレポート定義名称を指定すると,エラーになります。parent-folder属性を指定して,name属性を省略した場合もエラーになります。レポート定義名の前後に半角空白を指定すると,前後の半角空白を除いた名称で登録されます。 |
parent-folder | name属性のレポート定義を格納するディレクトリを指定します。1~64文字(バイトではない)の全角文字または半角文字のディレクトリ名を最上位ディレクトリから「/」で区切って指定します。全角文字と半角文字が混在できます。パスの場合は,上位レベルのディレクトリ名から順に半角「/」で区切って指定します。ディレクトリ名に「¥」か「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。システム定義のレポート定義ディレクトリは指定できません。ディレクトリが存在しない場合は,作成します。省略するとエラーとなります。ディレクトリ名の前後に半角空白を指定するとエラーになります。 | |
id | 指定しても無視します。 | |
read-only | 「TRUE」の場合は,レポート定義の生成を中断して,次のreport-definition要素を処理します。省略または「FALSE」の場合は,レポート定義を作成します。 | |
親要素 | report-definitions | |
子要素 | product-id | |
report-type | ||
record | ||
indication-settings | ||
realtime-indication-settings | ||
view-type | ||
drilldown |
表12-9 product-id
種別 | 説明 |
---|---|
意味 | レポート情報を収集する製品の種別 |
指定可能値 | プロダクトIDにデータモデルバージョン番号を付加したプロダクトコードを指定します。プロダクトIDは,エージェント製品を識別する半角英大文字です。データモデルバージョンとは,エージェントが付与する番号です。例として,Windowsは「T」,UNIXは「U」,Oracleは「O」,Dominoは「L」,SAP R/3は「M」です。Windowsのデータモデルバージョン「3.0」のプロダクトコードは「T3.0」です。 「レポートAのデータモデルバージョン ≧ レポートBのデータモデルバージョン」である場合,レポートAからレポートBにドリルダウンできます。 |
省略 | 不可 |
属性 | なし |
親要素 | report-definition |
子要素 | なし |
表12-10 report-type
種別 | 説明 | |
---|---|---|
意味 | レポート種別を指定します。 | |
指定可能値 | なし | |
省略 | 不可 | |
属性 | type | 次に示す指定値を英字半角(小文字だけ,または大文字だけ)で指定します。
|
親要素 | report-definition | |
子要素 | なし |
表12-11 record
種別 | 説明 | |
---|---|---|
意味 | レポート対象レコードを指定します。 | |
指定可能値 | なし | |
省略 | 不可 | |
属性 | id | レコードIDを指定します。省略できません。report-type設定値との組み合わせによって,指定できるレコード属性が決まります。「表12-43 レポートに指定できるレコード属性とフィールドの組み合わせ」を参照してください。 |
親要素 | report-definition | |
子要素 | fields | |
condition-expression |
表12-12 fields
種別 | 説明 |
---|---|
意味 | レポート対象フィールドを1つ以上指定します。 |
指定可能値 | なし |
省略 | 不可 |
属性 | なし |
親要素 | record |
子要素 | field |
表12-13 field
種別 | 説明 | |
---|---|---|
意味 | レポート対象フィールドを1つ指定します。 | |
指定可能値 | 選択したレコードのフィールドIDを指定します。すべてのfield要素のすべての属性(table/list/graph)を「FALSE」に指定できません。必ずtable/list/graphのどれか1つを「TRUE」に指定してください。 すべてのfieldでtable/list/graphに「FALSE」を指定した場合はエラーとなります。また,fieldsタグ内で重複するフィールドIDを用いてfieldタグを指定した場合はエラーとなります。 フィールドの中には,履歴データとしてAgent Storeに記録するときだけ追加収集され,計算されるxxxx(Total)などのフィールドがあります。これらのフィールドは,リアルタイムレポートの場合には指定できません。指定した場合は,エラーとなります。詳細は,「表12-47 リアルタイムレポートで指定できないフィールド」を参照してください。 | |
省略 | 不可 | |
属性 | table | 表を表示する場合は「TRUE」,それ以外は「FALSE」を指定します。省略時は,「FALSE」となります。 |
list | 一覧を表示する場合は「TRUE」,それ以外は「FALSE」を指定します。省略時は,「FALSE」となります。 | |
graph | グラフを表示する場合は「TRUE」,それ以外は「FALSE」を指定します。省略時は,「FALSE」となります。 テキスト形式のフィールドの場合は,「TRUE」を指定するとエラーになります。 | |
display-name | 24文字以内の全角文字列または半角文字列でユーザー表示名を指定します。 省略した場合,空文字指定(display-name="")の場合,および半角空白文字指定(display-name=" ")の場合は,フィールド名を表示します。 | |
親要素 | fields | |
子要素 | なし |
表12-14 condition-expression
種別 | 説明 |
---|---|
意味 | フィルターの条件式の論理演算を指定します。 |
指定可能値 | なし |
省略 | 可(省略時は設定しません) |
属性 | なし |
親要素 | record |
ref-field | |
子要素 | and |
or | |
expression |
表12-15 expression
種別 | 説明 | |
---|---|---|
意味 | 条件式を指定します。 | |
指定可能値 | (1)フィルター条件に指定する場合 条件式は「<フィールド> <条件> "<値>"」の形式で指定します。フィールド・条件・値の区切りに空白は使用できません。 データ型がtime_tのフィールドは,値を省略しspecify-when-displayedを「TRUE」に設定した場合だけ指定できます。 <フィールド> フィールドは,レコードに含まれるフィールドを「PFM - Manager名」で指定します。PFM - Manager名については,各PFM - Agentマニュアルのレコードの説明を参照してください。 <条件> 条件に指定する値を次に示します。
文字列フィールドの場合は,ASCIIコードの昇順に比較します。大文字と小文字は区別されます。 "<値>" 比較対象となる値を,「"」で囲んで指定します。指定できる値は,整数値,小数値,または2,048バイト以内の全角文字,半角文字です。 文字コード,データ長,データ形式は,左辺に指定するフィールドの形式に依存します。 specify-when-displayed属性を「TRUE」に設定している場合は,値を省略できます。 文字列を指定する場合は,ワイルドカード文字を使用できます。 使用できるワイルドカード文字を次に示します。
各PFM - Agentのマニュアルに記述されているフィールドの形式に合わせ指定します。次に示す設定範囲で指定します。
条件式は,「<フィールド> <条件> "<値>"」または「<フィールド> <条件> <フィールド>」の形式で指定します。フィールド・条件・値の区切りに空白は使用できません。 <フィールド> ドリルダウンレポートに指定したレコードに含まれるフィールドを指定します。 <条件> (1)の条件を参照してください。 "<値>"または<フィールド>
| |
省略 | 可(condition-expressionを指定した場合は省略不可) | |
属性 | specify-when-displayed | 実行時に設定する場合は「TRUE」,それ以外は「FALSE」と指定します。省略時は,「FALSE」となります。要素値の論理式に値を指定しないで「FALSE」を指定すると,エラーになります。 |
親要素 | condition-expression | |
and | ||
or | ||
子要素 | なし |
表12-16 and
種別 | 説明 |
---|---|
意味 | expressionで指定した論理式のAND演算を指定します。 |
指定可能値 | なし |
省略 | 可(条件式の論理積を指定する場合に指定します) |
属性 | なし |
親要素 | and |
or | |
condition-expression | |
子要素 | expression |
and | |
or |
表12-17 or
種別 | 説明 |
---|---|
意味 | expressionで指定した論理式のOR演算を指定します。 |
指定可能値 | なし |
省略 | 可(条件式の論理和を指定する場合に指定します) |
属性 | なし |
親要素 | and |
or | |
condition-expression | |
子要素 | expression |
and | |
or |
表12-18 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 |
表12-19 date-range
種別 | 説明 |
---|---|
意味 | レポート表示期間を指定します。 |
指定可能値 | 次の値を指定できます。
|
省略 | 可(省略時は「SPECIFY_WHEN_DISPLAYED」となります) |
属性 | なし |
親要素 | indication-settings |
子要素 | なし |
表12-20 report-interval
種別 | 説明 |
---|---|
意味 | レポート間隔を指定します。 |
指定可能値 | 次の値を指定できます。大文字と小文字は区別しません。
|
省略 | 可(省略時は「HOUR」となります) |
属性 | なし |
親要素 | indication-settings |
子要素 | なし |
表12-21 peak-time
種別 | 説明 |
---|---|
意味 | 指定したフィールド値が最大となる時間だけレポート表示します。 |
指定可能値 | recordで指定したレコードが単数インスタンスの場合,そのどれかのフィールドIDを指定します。1日の内でそのフィールドの値が最大となる時間のレコードだけを表示します。report-intervalが「HOUR」以外の場合,レコードが複数インスタンスの場合,またはreport-typeがHISTORICAL-MULTIPLE-AGENTSの場合は,エラーになります。 |
省略 | 可(省略時はpeak-timeにフィールドを設定しません) |
属性 | なし |
親要素 | indication-settings |
子要素 | なし |
表12-22 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」となります。 デルタ値の表示可否については,エージェントで収集される各フィールドによって異なります。詳細は,「表12-46 リアルタイムレポートのデルタ値の表示条件」を参照してください。 | |
親要素 | report-definition | |
子要素 | refresh-interval | |
display-by-ranking |
表12-23 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 | |
子要素 | なし |
表12-24 display-by-ranking
種別 | 説明 | |
---|---|---|
意味 | field属性で指定したフィールドを昇順または降順にソートして,先頭からdisplay-number属性で指定した件数をランキングデータとしてレポート表示する場合に指定します。 複数行のレコード(複数インスタンスレコード)の場合だけ指定できます。単一行のレコードの場合に指定するとエラーになります。 display-by-rankingとdisplay-keyの両方を指定した場合,display-by-rankingの条件で取得したデータをdisplay-keyの条件に従って表示します。 | |
指定可能値 | なし | |
省略 | 可(省略時はランキングを表示しません) | |
属性 | field | ランキング表示するときの表示判定基準となるフィールドIDを指定します。省略時はエラーになります。 ランキング表示に指定できない属性のフィールドを指定した場合はエラーになります。 ランキング表示時に指定できるフィールドのデータ型は「表12-42 指定できるパラメーターの組み合わせ(リアルタイムレポートの場合)」を参照してください。 |
display-number | ランキング表示する件数を1~100の整数で指定します。省略時は「10」となります。 | |
in-descending-order | ランキング表示の判定基準となるフィールドIDを降順または昇順でソートし,先頭からdisplay-number属性で指定した件数分を表示します。 昇順でソートする場合は「TRUE」,降順でソートする場合は「FALSE」を指定します。省略時は「FALSE」となります。 | |
親要素 | realtime-indication-settings | |
子要素 | なし |
表12-25 view-type
種別 | 説明 |
---|---|
意味 | レポートの表現形式を指定します。 |
指定可能値 | なし |
省略 | 可(display-keyとgraph-propertiesをすべてデフォルトに設定します) |
属性 | なし |
親要素 | report-definition |
子要素 | display-key |
graph-properties |
表12-26 display-key
種別 | 説明 | |
---|---|---|
意味 | レコードをソートするためのフィールドを指定します。display-keyを指定すると,graph-typeにLINE,AREA,STACKED_AREAを指定できません。 | |
指定可能値 | フィールドIDを指定します。 | |
省略 | 可(省略時は時系列で表示します) | |
属性 | in-descending-order |
|
親要素 | view-type | |
子要素 | なし |
表12-27 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 |
表12-28 graph-type
種別 | 説明 |
---|---|
意味 | グラフの種類を指定します。 |
指定可能値 | 次の値を指定します。
|
省略 | 可(省略時は集合縦棒「COLUMN」です) |
属性 | なし |
親要素 | graph-properties |
子要素 | なし |
表12-29 axis-labels
種別 | 説明 |
---|---|
意味 | グラフのX軸とY軸ラベルを指定します。<graph-type>タグで「PIE」を指定して,X軸ラベルまたはY軸ラベルを指定するとエラーになります。 |
指定可能値 | なし |
省略 | 可(省略時はX軸とY軸ラベルを表示しません) |
属性 | なし |
親要素 | graph-properties |
子要素 | x-axis |
y-axis |
表12-30 x-axis
種別 | 説明 |
---|---|
意味 | グラフのX軸ラベルを指定します。 |
指定可能値 | 0~40文字(全角文字も1文字と数える)で指定します。 |
省略 | 可(省略時はX軸ラベルを表示しません) |
属性 | なし |
親要素 | axis-labels |
子要素 | なし |
表12-31 y-axis
種別 | 説明 |
---|---|
意味 | グラフのY軸ラベルを指定します。 |
指定可能値 | 0~40文字(全角文字も1文字と数える)で指定します。 |
省略 | 可(省略時はY軸ラベルを表示しません) |
属性 | なし |
親要素 | axis-labels |
子要素 | なし |
表12-32 data-label
種別 | 説明 |
---|---|
意味 | ラベル表示フィールドを指定します。レコードに単数インスタンスを指定し,report-typeに「historical-single-agent」およびgraph-typeに「LINE」,「AREA」,または「STACKED_AREA」を指定している場合,data-labelを指定すると,エラーになります。 |
指定可能値 | なし |
省略 | 可(省略時はデータラベルを表示しません) |
属性 | なし |
親要素 | graph-properties |
子要素 | data-label1 |
data-label2 |
表12-33 data-label1
種別 | 説明 |
---|---|
意味 | データラベル1のラベル表示フィールドを指定します。データラベルにはさらにデータラベル2が指定できます。データラベル2に表示する値は,データラベル1の右に括弧で囲まれて表示されます。 |
指定可能値 |
|
省略 | 可(省略時はデータラベル1を設定しません) |
属性 | なし |
親要素 | data-label |
子要素 | なし |
表12-34 data-label2
種別 | 説明 |
---|---|
意味 | データラベル2のラベル表示フィールドをrecordに対応するフィールドIDで指定します。data-label1を指定しないでdata-label2を指定するとエラーとなります。 |
指定可能値 |
|
省略 | 可(省略時はデータラベル2を設定しません) |
属性 | なし |
親要素 | data-label |
子要素 | なし |
表12-35 drilldown
種別 | 説明 |
---|---|
意味 | ドリルダウン対象のフィールドとレポートを指定します。 |
指定可能値 | なし |
省略 | 可(省略時はドリルダウンを設定しません) |
属性 | なし |
親要素 | report-definition |
子要素 | field-drilldown |
report-drilldown |
表12-36 field-drilldown
種別 | 説明 |
---|---|
意味 | ドリルダウン対象のフィールドを指定します。 |
指定可能値 | なし |
省略 | 可(省略時はドリルダウン対象のフィールドを設定しません) |
属性 | なし |
親要素 | drilldown |
子要素 | ref-field |
表12-37 ref-field
種別 | 説明 | |
---|---|---|
意味 | ドリルダウン対象のフィールドを指定します。 | |
指定可能値 | なし。子要素condition-expressionに指定できるexpressionの条件式の左辺に指定するフィールドは,子要素ref-reportで指定するドリルダウンレポートのフィールドです。 | |
省略 | 可(省略時はドリルダウン対象のフィールドを設定しません) | |
属性 | id | recordで指定したレコードに対応するフィールドIDを指定します。同じidを指定してref-fieldの要素を重複指定するまたは,省略すると,エラーとなります。 |
親要素 | field-drilldown | |
子要素 | ref-report | |
condition-expression |
表12-38 report-drilldown
種別 | 説明 |
---|---|
意味 | ドリルダウン対象のレポートを指定します。 |
指定可能値 | なし |
省略 | 可(省略時はドリルダウン対象のレポートを設定しません) |
属性 | なし |
親要素 | drilldown |
子要素 | ref-report |
ref-bookmark |
表12-39 ref-report
種別 | 説明 | |
---|---|---|
意味 | 1つのレポート定義を指定します。 | |
指定可能値 | なし | |
省略 | 可(省略時はドリルダウン対象のレポートを設定しません) | |
属性 | pathname | ディレクトリパスとレポート定義名を「ディレクトリパス/レポート定義名」の形式で指定します。ディレクトリパスは,ルートディレクトリから順に半角「/」で区切って指定します。ディレクトリ名に「¥」か「/」を含む場合,それぞれ「¥¥」「¥/」と記述します。ディレクトリ名とレポート定義名は,1~64文字(バイトではない)の全角文字または半角文字で指定します。全角文字と半角文字が混在できます。存在しないレポート定義を指定するとエラーになります。「レポートAのデータモデルバージョン ≧ レポートBのデータモデルバージョン」である場合,レポートAからレポートBにドリルダウンできます。 |
親要素 | ref-field | |
report-drilldown | ||
子要素 | なし |
表12-40 ref-bookmark
種別 | 説明 | |
---|---|---|
意味 | 1つのブックマークまたは複合ブックマークを指定します。 | |
指定可能値 | なし | |
省略 | 可(省略時はドリルダウン対象のレポートを設定しません) | |
属性 | pathname | フォルダパスとブックマーク名を「フォルダパス/ブックマーク名」の形式で指定します。フォルダパスは,ルートフォルダから順にフォルダ名を半角「/」で区切って指定します。フォルダ名に「¥」または「/」を含む場合は,それぞれ「¥¥」または「¥/」と記述します。
フォルダ名とブックマーク名は,1~64文字(バイトではない)の全角文字と半角文字で指定します。全角文字と半角文字は混在してもかまいません。存在しないブックマークが指定されたときはエラーになります。 なお,関連づけられたレポート定義,エージェントなどのブックマークそのものの妥当性はチェックされません。 |
親要素 | report-drilldown | |
子要素 | なし |
注意:このタグを指定する場合は,pr-cli-parameters のver属性を「0110」にしてください。
履歴レポートのパラメーターファイル記述例を次に示します。
パラメーターファイル記述例(履歴レポートの場合)
<?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="0100">
<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="0100">
<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レポート定義終了 -->
また,パラメーターの記述を定義するDTDファイル(rdef_create_params.dtd)を次に示します。
パラメーターの記述を定義するDTDファイル(rdef_create_params.dtd)
<!ENTITY % BOOL_VALUE "(true|false|TRUE|FALSE)">
<!ENTITY % COND_CHILD "(expression|or|and)">
<!ELEMENT pr-cli-parameters (report-definitions)>
<!ATTLIST pr-cli-parameters
ver (0100|0110) #REQUIRED>
<!ELEMENT report-definitions (report-definition+)>
<!ELEMENT report-definition (product-id,
report-type,
record,
(indication-settings?|realtime-indication-settings?),
view-type?,
drilldown?)>
<!ATTLIST report-definition
name CDATA #REQUIRED
parent-folder CDATA #REQUIRED
id CDATA #IMPLIED
read-only %BOOL_VALUE; "FALSE">
<!ELEMENT product-id (#PCDATA)>
<!ELEMENT report-type EMPTY>
<!ATTLIST report-type
type (historical-multiple-agents |
HISTORICAL-MULTIPLE-AGENTS |
historical-single-agent |
HISTORICAL-SINGLE-AGENT |
realtime-single-agent |
REALTIME-SINGLE-AGENT) #REQUIRED>
<!ELEMENT record (fields,condition-expression?)>
<!ATTLIST record
id CDATA #REQUIRED>
<!ELEMENT fields (field+)>
<!ELEMENT field (#PCDATA)>
<!ATTLIST field
table %BOOL_VALUE; "FALSE"
list %BOOL_VALUE; "FALSE"
graph %BOOL_VALUE; "FALSE"
display-name CDATA #IMPLIED>
<!ELEMENT condition-expression %COND_CHILD;>
<!ELEMENT expression (#PCDATA)>
<!ATTLIST expression
specify-when-displayed %BOOL_VALUE; "FALSE">
<!ELEMENT and (%COND_CHILD;,%COND_CHILD;)>
<!ELEMENT or (%COND_CHILD;,%COND_CHILD;)>
<!ELEMENT indication-settings
(date-range?,report-interval?,peak-time?)>
<!ATTLIST indication-settings
specify-when-displayed %BOOL_VALUE; #IMPLIED
maximum-number-of-records NMTOKEN #IMPLIED>
<!ELEMENT date-range (#PCDATA)>
<!ELEMENT report-interval (#PCDATA)>
<!ELEMENT peak-time (#PCDATA)>
<!ELEMENT realtime-indication-settings
(refresh-interval?,display-by-ranking?)>
<!ATTLIST realtime-indication-settings
specify-when-displayed %BOOL_VALUE; "FALSE"
indicate-delta-value %BOOL_VALUE; "TRUE">
<!ELEMENT refresh-interval EMPTY>
<!ATTLIST refresh-interval
do-not-refresh-automatically %BOOL_VALUE; "FALSE"
initial-value NMTOKEN #IMPLIED
minimum-value NMTOKEN #IMPLIED>
<!ELEMENT display-by-ranking EMPTY>
<!ATTLIST display-by-ranking
field CDATA #REQUIRED
display-number NMTOKEN #IMPLIED
in-descending-order %BOOL_VALUE; "FALSE">
<!ELEMENT view-type (display-key?,graph-properties?)>
<!ELEMENT display-key (#PCDATA)>
<!ATTLIST display-key
in-descending-order %BOOL_VALUE; "FALSE">
<!ELEMENT graph-properties
(graph-type?,axis-labels?,data-label?)>
<!ATTLIST graph-properties
series-direction
(by_row|by_column|BY_ROW|BY_COLUMN) "BY_ROW"
show-areas-of-missing-data %BOOL_VALUE; "FALSE">
<!ELEMENT graph-type (#PCDATA)>
<!ELEMENT axis-labels (x-axis?,y-axis?)>
<!ELEMENT x-axis (#PCDATA)>
<!ELEMENT y-axis (#PCDATA)>
<!ELEMENT data-label (data-label1?,data-label2?)>
<!ELEMENT data-label1 (#PCDATA)>
<!ELEMENT data-label2 (#PCDATA)>
<!ELEMENT drilldown (report-drilldown?,field-drilldown?)>
<!ELEMENT report-drilldown (ref-report|ref-bookmark)*>
<!ELEMENT ref-report EMPTY>
<!ATTLIST ref-report
pathname CDATA #REQUIRED>
<!ELEMENT ref-bookmark EMPTY>
<!ATTLIST ref-bookmark
pathname CDATA #REQUIRED>
<!ELEMENT field-drilldown (ref-field*)>
<!ELEMENT ref-field (ref-report,condition-expression?)>
<!ATTLIST ref-field
id CDATA #REQUIRED>
注意事項
<and>
<expression><式1></expression>
<or>
<expression><式2></expression>
<or>
<expression><式3></expression>
<or>
<expression><式4></expression>
<expression><式5></expression>
</or>
</or>
</or>
</and>
<expression>SEGMENTS_RETRANSMITTED_PER_SEC>"100"</expression>
<expression>RECORD_TIME>"2003 05 31 11:22:33"</expression>
表12-41 指定できるパラメーターの組み合わせ(履歴レポートの場合)
レポート種別 | レコードタイプ | フィールドのデータ型 | ピーク時間 | フィールド表示形式 | |||
---|---|---|---|---|---|---|---|
表 | 一覧 | グラフ | 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 | ○ | ○ | ○ | ○ | × |
表12-42 指定できるパラメーターの組み合わせ(リアルタイムレポートの場合)
レポート種別 | レコードタイプ | フィールドのデータ型 | ランキング表示 | フィールド表示形式 | |||
---|---|---|---|---|---|---|---|
表 | 一覧 | グラフ | 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 | ○ | ○ | ○ | ○ | ○ |
表12-43 レポートに指定できるレコード属性とフィールドの組み合わせ
レポート種別 | レコード属性 | 1つのフィールド | 複数のフィールド |
---|---|---|---|
履歴(1つのエージェント)レポート | 単数インスタンス | ○ | ○ |
複数インスタンス | ○ | × | |
履歴(複数のエージェント)レポート | 単数インスタンス | ○ | × |
リアルタイム(1つのエージェント)レポート | 単数インスタンス | ○ | ○ |
複数インスタンス | ○ | × |
表12-44 recordに設定するフィルターの設定条件
specify-when -displayed設定 | 条件式 右辺 | Date,Timeフィールド以外のtime_t型のフィールド | time_t型の中のDateフィールド | time_t型の中のTimeフィールド |
---|---|---|---|---|
TRUE | 値 | ○ | ○ | ○ |
省略 | ○ | ○ | ○ | |
FALSE | 値 | × | × | ○ |
省略 | × | × | × |
表12-45 ref-fieldに設定するフィルターの設定条件
specify-when -displayed設定 | 条件式 右辺 | Date,Timeフィールド以外のtime_t型のフィールド | time_t型の中のDateフィールド | time_t型の中のTimeフィールド |
---|---|---|---|---|
TRUE | フィールドID | × | × | × |
値 | × | × | ○ | |
省略 | ○ | ○ | ○ | |
FALSE | フィールドID | ○ | ○ | ○ |
値 | × | × | ○ | |
省略 | × | × | × |
表12-46 リアルタイムレポートのデルタ値の表示条件
realtime-indication-settingsのindicate-delta-value属性 | 各フィールドのデルタ属性 | 表示内容 |
---|---|---|
TRUE | Yes | 前回収集されたときから今回収集されるまでのパフォーマンスデータの変化量 |
No | 収集された最新の値 | |
FALSE | Yes | パフォーマンスデータの収集開始からの累積値 |
No | 収集された最新の値 |
表12-47 リアルタイムレポートで指定できないフィールド
Performance Reporterでの名称 | 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 | データ集約期間内での合計で発生したオーバーフローの回数 |
戻り値
0 | 正常終了しました。 |
1 | コマンドライン形式不正です。 |
2 | コマンドを実行したOSユーザーに実行権限がありません。 |
3 | 出力ファイルの作成に失敗しました。 |
5 | DTDファイルと不整合のため,パラメーターを解析できません。 |
10 | 1件以上のレポート定義作成に失敗しました。 |
100 | 環境が不正です。 |
200 | メモリーエラーが発生しました。 |
202 | ファイルアクセスエラーが発生しました。 |
222 | 通信処理でエラーが発生しました。 |
255 | 予期しないエラーが発生しました。 |
使用例
レポートの定義内容を記述したパラメーターファイル(rdef_create.xml)を新規に登録する場合のコマンド実行例を次に示します。
jpcrdef create rdef_create.xml
出力例
コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については,マニュアル「Hitachi Command Suite Tuning Manager Software 運用管理ガイド」を参照してください。
3つのレポート定義を指定し,1つのレポート定義がエラーとなった場合の標準出力形式を次に示します。
標準出力の出力例
jpcrdef create connected to vserv01 at 2003 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 2003 03 20 15:01:06.2