JP1/Performance Management リファレンス

[目次][索引][前へ][次へ]


jpcrdef create

形式

jpcrdef create    [-mx 最大ヒープサイズ]
                  [-ms 初期ヒープサイズ]
                  [-dateformat 日付フォーマットのパターン名]
                  [-dateseparator 日付フォーマットのセパレーター名入力ファイル

機能

jpcrdef createコマンドは,PFM - Managerに接続し,レポート定義を新規作成するコマンドです。定義内容は,コマンドライン引数として指定されたXML形式のパラメーターファイルから取得します。一つのパラメーターファイルに複数のレポート定義を指定し,一括して作成できます。

コマンドを実行できるホスト

PFM - Web Console

実行権限

Windowsの場合
  • OSのユーザー権限:Administrators権限を持つユーザー
  • Performance Managementのユーザー権限:一般ユーザー権限,または管理ユーザー権限を持つユーザー

UNIXの場合
  • OSのユーザー権限:rootユーザー権限を持つユーザー
  • Performance Managementのユーザー権限:一般ユーザー権限,または管理ユーザー権限を持つユーザー

格納先ディレクトリ

Windowsの場合
インストール先フォルダ\tools\

UNIXの場合
/opt/jp1pcwebcon/tools/

引数

-mx 最大ヒープサイズ

java.exeの最大ヒープサイズをMB単位で指定します。デフォルトは,64MBです。実際に取得できる最大サイズは,システムに依存します。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。

-ms 初期ヒープサイズ

java.exeの初期ヒープサイズをMB単位で指定します。デフォルトは,32MBです。指定する値が次の条件を満たさない場合は,コマンドライン形式不正となります。指定値の条件を次に示します。

-dateformat 日付フォーマットのパターン名

指定したパターン名に対応する日付フォーマットで,入力ファイルの<expression>タグに記述した日付の形式を判定します。指定できる日付フォーマットのパターン名を次に示します。

-dateseparator 日付フォーマットのセパレーター名

指定したセパレーター名に対応するセパレーター文字列で,入力ファイルの<expression>タグに記述したセパレーターの形式を判定します。指定できる日付フォーマットのセパレーター名を次に示します。

入力ファイル

レポートを新規作成するためのXML形式のパラメーターファイルを指定します。このパラメーターファイルは,後述の「パラメーターファイルの形式」に基づいて作成されたファイルです。絶対ファイルパス名,相対ファイルパス名,ファイル名が指定でき,絶対ファイルパス名以外の場合,カレントディレクトリを基点とします。

パラメーターファイルの形式

XMLタグ仕様

履歴レポートのパラメーターファイルの記述例を次に示します。

パラメーターファイル記述例(履歴レポートの場合)

 
<?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レポート定義終了 -->

パラメーターの記述を定義する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>

注意事項

リアルタイムレポートに指定できないフィールドについて次の表に示します。

表2-24 リアルタイムレポートで指定できないフィールド

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 データ要約期間内での合計で発生したオーバーフローの回数

戻り値

0 正常終了した。
1 コマンドラインの形式が不正である。
2 コマンドの実行権限がない。
3 出力ファイルの作成に失敗した。
5 DTDファイルと不整合のため,パラメーターが解析できない。
10 1件以上のレポート定義作成に失敗した。
11 PFM - Managerへの認証処理に失敗した。
100 環境が不正である。
200 メモリーエラーが発生した。
202 ファイルアクセスエラーが発生した。
222 通信処理でエラーが発生した。
255 予期しないエラーが発生した。

使用例

レポートの定義内容を記述したパラメーターファイル(rdef_create.xml)を新規に登録する場合のコマンド実行例を次に示します。

 
jpcrdef  create  rdef_create.xml

出力例

コマンド処理の詳細情報を標準出力,標準エラー出力,トレースログファイルに出力します。ログ仕様については「3. ログ情報」を参照してください。

三つのレポート定義を指定し,一つのレポート定義がエラーとなった場合の標準出力形式を次に示します。

標準出力の出力例

 
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

[目次][前へ][次へ]


[他社商品名称に関する表示]

All Rights Reserved. Copyright (C) 2006, 2008, Hitachi, Ltd.