初期設定ファイルは,PFM - Web Consoleの動作環境を設定するXML形式のファイルで,PFM - Web Consoleの起動時に読み込まれます。
初期設定ファイル(config.xml)の格納先ディレクトリを次に示します。
(1) 初期設定ファイル(config.xml)の設定項目
初期設定ファイル(config.xml)の設定する項目について次の表に示します。
表E-1 初期設定ファイル(config.xml)の設定する項目
項目 | 内容 | 編集の可否 | ||
---|---|---|---|---|
logDir | PFM - Web Consoleのログファイルを出力するディレクトリを指定します。 デフォルトのディレクトリを次に示します。
指定しない場合は,デフォルトが設定されます。 | ○ | ||
logFileNumber | PFM - Web Consoleが出力するログファイルの面数を整数で指定します。
| ○ | ||
logFileSize | 一つのログファイルのサイズをMB単位で指定します。
| ○ | ||
logFileRetention | ログファイルを保持する日数を整数で指定します。この指定でjpcrptコマンドが出力するログファイルの保持期間が設定されます。
| ○ | ||
lineSeparator | Export機能で出力する行の終端記号を指定します。指定値を次に示します。
指定値以外を指定すると,デフォルトが設定されます。 | ○ | ||
characterCode | Export機能で出力するファイルの文字コードを指定します。指定値を次に示します。
指定値以外を指定すると,デフォルトが設定されます。 | ○ | ||
csvFileName | Export機能で出力するファイル名を指定します。ファイル名に指定できる文字は,100文字以内とします。次に示す文字が指定できます。
指定値以外を指定すると,デフォルトが設定されます。 | ○ | ||
host | 接続するPFM - Managerのホスト名またはIPアドレスを指定します。 ホスト名の場合,次に示す文字が指定できます。
指定を省略すると,「localhost」が設定されます。 | ○ | ||
port | 接続するPFM - Managerのポート番号を指定します。
| ○ | ||
maxFetchCount (<vsa>タグ配下) | PFM - Managerから取得する最大レコード件数を整数で指定します。
| ○ | ||
displayCountPerPage | レポート画面のテーブル表示時に1ページ当たり表示するレコード数を整数で指定します。
| ○ | ||
maxRealtimeCache | 一つのリアルタイムレポートに対して,データをキャッシュに保存する最大レコード数を整数で指定します。
| ○ | ||
realtimeCacheInterval ※1 | リアルタイムレポートを自動更新するリクエスト間隔の制限時間(ミリ秒)を指定します。自動更新のリクエスト間隔が制限時間を超えたとき,サーバやエージェントは,通知なくレポートが終了したと判断し,処理を終了します。ただし,リクエスト間隔が制限時間を超えているかどうかは10秒ごとに判断されます。 例えば,制限時間が61,000ミリ秒に設定されている場合,制限時間として61,000ミリ秒~70,000ミリ秒が設定されていることになります。
| ○ | ||
selectFormat | 日付の表示形式を指定します。指定値を次に示します。
指定値以外を指定すると,デフォルトが設定されます。 | ○ | ||
bookmarkRepository ※1 | ブックマーク機能の定義情報を保存するリポジトリ※2の格納先を絶対パスで指定します。 指定したディレクトリがない場合は,PFM - Web Consoleのサービス起動時にディレクトリが作成されます。
| ○ | ||
columnBar (<graph-time-correction>タグ配下) | 履歴レポート(複合レポート含む)のグラフを集合縦棒または集合横棒で表示する場合の時刻補正方法を指定します。 指定可能な値は,NONE(無効)またはSECOND(有効)です。 SECONDを指定した場合,秒単位で時刻を補正します。 デフォルト値はNONEです。指定可能な値以外を指定または省略時の場合は,デフォルト値が設定されます。 | ○ | ||
stackedColumnBar (<graph-time-correction>タグ配下) | 履歴レポート(複合レポート含む)のグラフを積み上げ縦棒または積み上げ横棒で表示する場合の時刻補正方法を指定します。 指定可能な値はNONE(無効)またはSECOND(有効)です。 SECONDを指定した場合,秒単位で時刻を補正します。 デフォルト値はNONEです。指定可能な値以外を指定または省略時の場合は,デフォルト値が設定されます。 | ○ | ||
pie (<graph-time-correction>タグ配下) | 履歴レポートのグラフを円グラフで表示する場合の時刻補正方法を指定します。 指定可能な値はNONE(無効)またはSECOND(有効)です。 SECONDを指定した場合,秒単位で時刻を補正します。 デフォルト値はNONEです。指定可能な値以外を指定または省略時の場合は,デフォルト値が設定されます。 | ○ | ||
line (<graph-time-correction>タグ配下) | 履歴レポート(複合レポート含む)のグラフを線グラフで表示する場合の時刻補正方法を指定します。 指定可能な値はNONE(無効)またはSECOND(有効)です。 SECONDを指定した場合,秒単位で時刻を補正します。 デフォルト値はNONEです。指定可能な値以外を指定または省略時の場合は,デフォルト値が設定されます。 | ○ | ||
area (<graph-time-correction>タグ配下) | 履歴レポート(複合レポート含む)のグラフを面グラフで表示する場合の時刻補正方法を指定します。 指定可能な値はNONE(無効)またはSECOND(有効)です。 SECONDを指定した場合,秒単位で時刻を補正します。 デフォルト値はNONEです。指定可能な値以外を指定または省略時の場合は,デフォルト値が設定されます。 | ○ | ||
stackedArea (<graph-time-correction>タグ配下) | 履歴レポート(複合レポート含む)のグラフを積み上げ面グラフで表示する場合の時刻補正方法を指定します。 指定可能な値はNONE(無効)またはSECOND(有効)です。 SECONDを指定した場合,秒単位で時刻を補正します。 デフォルト値はNONEです。指定可能な値以外を指定または省略時の場合は,デフォルト値が設定されます。 | ○ | ||
exponentialDisplayMode | グラフの縦軸目盛の指数表示について有効の有無を指定します。 指定可能な値はtrue(有効)かfalse(無効)です。 true(有効)を指定した場合,グラフの縦軸の目盛の値が10の7乗以上または0.001未満の場合にグラフの縦軸の目盛を指数表示します。 デフォルト値は,true(有効)です。指定可能な値以外を指定または省略時の場合はデフォルト値が設定されます。 | ○ | ||
updateInterval | 自動更新の更新間隔を指定します。
| ○ | ||
maxFetchCount (<command>タグ配下) | jpcrptコマンドで出力するレポートについてView Serverから取得する最大レコード件数を整数で指定します。
| ○ | ||
ownPort※1 | PFM - Web Console(Webサーバ)がView Serverサービスとの通信で使用するポート番号を指定します。
ファイアウォール環境の場合,この設定が必要です。詳細は「付録C.2 ファイアウォールの通過方向」を参照してください。 | ○ | ||
ownCmdPort※1 | PFM - Web Console(コマンド)がView Serverサービスとの通信で使用するポート番号を指定します。
ファイアウォール環境の場合,この設定が必要です。詳細は「付録C.2 ファイアウォールの通過方向」を参照してください。 | ○ | ||
ownHost※1 | PFM - Web ConsoleがView Serverサービスとの通信時に,View Serverサービスからのコールバック先として使用するホスト名またはIPアドレスを指定します。PFM - Web Consoleが動作するホスト名を指定する必要があります。 次に示す文字が指定できます。先頭文字は英数字だけ指定できます。
| ○ | ||
condExpValueUlongExtension | ulongのデータ型を使った条件式の定義で指定可能な範囲を設定します。
指定値以外の値を指定すると,デフォルトが設定されます。 PFM - Web ConsoleとPFM - Viewが混在したシステム環境で運用する際は, condExpValueUlongExtensionパラメーターを"false"に設定してください。 | ○ | ||
blockTransferMode | 分割送信モードの有無を指定します。 指定可能な値は,true(有効)かfalse(無効)です。デフォルト値は,true(有効)です。 指定可能な値以外を指定または省略時の場合はデフォルトが設定されます。 分割送信モードはcsv形式でのレポート出力だけ有効であり,HTML出力では無効となります。 | ○ | ||
maxSeriesLabelLength | レポートグラフの凡例ラベルに表示できる最大文字数を指定します。指定できる文字数は,1~1,024です。整数値で指定します。デフォルト値は30です。省略時,または範囲外の値や不正値が指定されたときは,デフォルト値が設定されます。 | ○ | ||
sessionTimeout※3 | ユーザー操作や自動更新されないまま一定時間が経過した場合に自動ログアウトするためのタイムアウト時間を秒単位で指定します。
| ○ | ||
priority | エージェント階層でヘルスチェックのアイコンを伝播させる方法を指定します。伝播させる方法は次の2種類から選択できます。 | ○ | ||
設定値 | 伝播時の優先度 | 備考 | ||
HOST | H6 > H5 > H4 > H3 > H2 > H1 | ホスト稼働状態監視 | ||
AGNET | H5 > H4 > H3 > H6 > H2 > H1 | エージェント稼働状態監視 | ||
デフォルト値はHOSTです。省略時または不正値を指定するとデフォルト値を仮定します。 | ||||
validate | プロパティ定義ファイルに指定したチェックルールを有効,無効にします。 on:有効(デフォルト) off:無効 | ○ | ||
firstDayOfWeek | 一週間の開始曜日を指定します。指定可能な値は,次の8個です。
| ○ |
(2) 初期設定ファイル(config.xml)に指定する日付の形式
日付の表示形式は,ブラウザーの「ロケール設定」(設定されていなければ,サーバOSの「言語と地域設定」)によってデフォルトの日付フォーマットが設定されています。この日付フォーマットは,表示形式のパターン,セパレーター,ロケールを初期設定ファイル(config.xml)のformatタグ内に記述することで変更できます。
ロケールに対応した日付の表示形式のパターンとフォーマットを次の表に示します。
表E-2 ロケールに対応した日付の表示形式のパターンとフォーマット
ロケール | パターン | フォーマット |
---|---|---|
en_US | pattern-MMddyyyy | MM△dd△yyyy |
en | pattern-ddMMyyyy | dd△MM△yyyy |
ja | pattern-yyyyMMdd | yyyy△MM△dd |
上記以外のロケール | pattern-ddMMyyyy | dd△MM△yyyy |
(a) 日付の表示形式のタグ指定
日付の表示形式を初期設定ファイル(config.xml)に設定する場合,次の表に示すタグを使用します。
表E-3 日付の表示形式のタグ一覧
タグ | 属性 | 内容 |
---|---|---|
format | - | 日付の表示形式を指定するルートタグを示します。 |
locale-format | - | ロケールと,ロケールに対応するパターン,セパレーターを指定します。 locale-formatタグ内では,次のタグが使用できます。
|
modify-format | - | 指定したロケールに対するパターン,セパレーターを変更する場合に指定します。 modify-formatタグ内では,次のタグが使用できます。
|
date-format | - | パターンとセパレーターを指定します。 formatタグ直下でdate-formatタグとselectFormatタグを両方指定している場合は,date-formatタグの指定が優先されます。 |
pattern | 指定値を次に示します。
| |
separator | 指定値を次に示します。
| |
export-separator | 指定値は,separatorと同じです。 | |
locale | - | ロケールを指定します。 |
(b) 日付フォーマット指定の記述例
各タグを使用したconfig.xmlの記述例を次に示します。
<format>
<param name="selectFormat" value="pattern-MMddyyyy"/>
</format>
<format>
<date-format pattern="pattern-MMddyyyy" separator="slash"/>
</format>
<format>
<param name="selectFormat" value="pattern-MMddyyyy"/>
<date-format export-separator="hyphen"/>
</format>
<format>
<date-format pattern="pattern-MMddyyyy" separator="slash"/>
<locale-format>
<date-format pattern="pattern-ddMMyyyy"/>
<locale>en</locale>
</locale-format>
</format>
<format>
<modify-format>
<date-format pattern="pattern-ddMMyyyy"
export-separator="period"/>
<locale>ja</locale>
<locale>en</locale>
<locale>de</locale>
</modify-format>
</format>
(3) ブックマークの定義情報を保存するリポジトリ
ブックマークやブックマークフォルダの構成情報は,OSのファイルシステム上にフラットファイルとして保管されます。これをリポジトリと呼びます。インストール時に作成されるデフォルトのリポジトリの格納先を次に示します。
インストール先フォルダ¥bookmarks
(a) ブックマークのリポジトリ格納先ディレクトリの変更
ブックマークのリポジトリ(ブックマークの定義情報)を保存するディレクトリは,初期設定ファイル(config.xml)のbookmarkRepositoryで変更できます。変更した値を有効にするためには,PFM - Web Consoleのサービスを再起動する必要があります。
PFM - Web Consoleのサービス起動時に初期設定ファイル(config.xml)で指定したディレクトリがない場合,そのディレクトリが自動で作成されます。
config.xmlのbookmarkRepositoryの記述例を次に示します。
<bookmark>
<!-- The directory where bookmark repository is stored.
Default : <install directory>¥bookmarks
-->
<param name="bookmarkRepository" value="c:¥user1¥bookmarks"/>
</bookmark>
(4) 初期設定ファイル(config.xml)のファイル例
初期設定ファイル(config.xml)のファイル例を次に示します。
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE application SYSTEM "config.dtd">
<!--
* Title: PFM - Web Console Configuration File
* Copyright: Copyright (C) 2006, 2007, Hitachi,Ltd.
* Licensed Material of Hitachi, Ltd. Reproduction, use, modification or disclosure
otherwise than permitted in the License Agreement is strictly prohibited.
-->
<application name="PerformanceReporter">
<logging>
<!-- Path of log files directory -->
<param name="logDir" value=""/>
<!-- Maximum number of log files
Specifiable values: 1 to 16
Default : 10
-->
<param name="logFileNumber" value="10"/>
<!-- Size of a log file (unit: MB=1024x1024byte)
Specifiable values: 1 to 100
Default : 10
-->
<param name="logFileSize" value="1"/>
<!-- Logging level of a log file
Specifiable values: FATAL/WARN/DEBUG/TRACE
Default : DEBUG
-->
<param name="logLevel" value="DEBUG"/>
<!-- Retention period of a log file
Specifiable values: 1 to 30
Default : 30
-->
<param name="logFileRetention" value="30"/>
</logging>
<export>
<!-- lineSeparator
Specifiable values: CRLF,LF
Default : CRLF
-->
<param name="lineSeparator" value="CRLF"/>
<!-- characterCode
Specifiable values: US-ASCII,windows-1252,ISO-8859-1,
UTF-8,UTF-16,UTF-16BE,UTF-16LE,
Shift_JIS,EUC-JP,EUC-JP-LINUX,MS932
-->
<param name="characterCode" value=""/>
<!-- Export filename -->
<param name="csvFileName" value="Export.csv"/>
</export>
<vsa>
<vserver-connection>
<!-- The host computer name to which PFM View Server operates. -->
<param name="host" value="hostB"/>
<!-- The port number which PFM View Server uses.
Specifiable values: 1 to 65535
Default : 22286
-->
<param name="port" value="22286"/>
<param name="ownPort" value="22222"/>
<param name="ownCmdPort" value="22223"/>
<param name="ownHost" value="host1"/>
</vserver-connection>
<!-- The maximum limits of the records.
Specifiable values: 1 to 2,147,483,647
Default : 1,440
-->
<param name="maxFetchCount" value="1440"/>
<!-- The display count per a page.
Specifiable values: 1 to 2,147,483,647
Default : 20
-->
<param name="displayCountPerPage" value="20"/>
<!-- Maximum data receiving count per report.
Specifiable values: 1 to 360
Default : 30
-->
<param name="maxRealtimeCache" value="30"/>
<!-- The auto refresh interval.
Specifiable values: 10 to 3600
Default : 60
-->
<param name="updateInterval" value="60"/>
<!-- The login session timeout which PFM Web Console service uses (unit: s)
Specifiable values: 0 to 86400
Default :4000
-->
<param name="sessionTimeout" value="4000"/>
<!-- The range extension for condition expression definitions using ulong fields.
Specifiable values: true,false
Default : false
-->
<param name="condExpValueUlongExtension" value="false"/>
<!-- Maximum series label length.
Specifiable values: 1 to 1024
Default : 30
-->
<param name="maxSeriesLabelLength" value="30"/>
<!-- The Switch of the divided data receivable.
Specifiable values: true or false
Default : true
-->
<param name="blockTransferMode" value="true"/>
<!-- First day of the week
Specifiable values : AUTO,SUNDAY,MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY,SATURDAY
Default : AUTO
-->
<param name="firstDayOfWeek" value="AUTO"/>
<!-- The limit of realtime report request interval.
If the interval between each request exceeds this value,
system consider that realtime report was closed without
notification and the resources will be freed.
Specifiable values: 60000 to 3600000
Default : 600000
-->
<!-Exponental display for scales of graph.
Specifiable values: true,false
Default : true
-->
< param name="exponentialDisplayMode" value="true"/>
<format>
<!-- Format set is specified.
Specifiable values : pattern-ddMMyyyy,
pattern-MMddyyyy,
pattern-yyyyMMdd
-->
<param name="selectFormat" value=""/>
</format>
<bookmark>
<!-- The directory where bookmark repository is stored.
Default : <install directory>¥bookmarks
-->
<param name="bookmarkRepository"
value="c:¥Program Files¥Hitachi¥jp1webopt¥bookmarks"/>
</bookmark>
<health-check>
<!-- Priority of Health check.
Specifiable values: HOST or AGENT
Default HOST
-->HOST
<param name="priority" value="HOST"/>
</health-check>
<properties-define>
<!-- validate of properties.
Specifiable values: on or off
Default : on
--> Host
< param name="validate" value="on">
</properties-define>
<graph-time-correction>
<!--time correction of column or bar graph
Specifiable values: NONE,SECOND
Default : NONE
-->
<!--
< param name="columnBar" value="NONE"/>
-->
<!-- time correction of stacked column or stacked bar graph
Specifiable values: NONE,SECOND
Default : NONE
-->
<!--
< param name="stackedColumnBar" value="NONE"/>
-->
<!-- time correction of pie graph
Specifiable values: NONE,SECOND
Default : NONE
-->
<!--
< param name="pie" value="NONE"/>
-->
<!-- time correction of line graph
Specifiable values: NONE,SECOND
Default : NONE
-->
<!--
< param name="line" value="NONE"/>
-->
<!-- time correction of area graph
Specifiable values: NONE,SECOND
Default : NONE
-->
<!--
< param name="area" value="NONE"/>
-->
<!-- time correction of stacked area graph
Specifiable values: NONE,SECOND
Default : NONE
-->
< param name="stackedArea" value="NONE">
</graph-time-correction>
</vsa>
<command>
<export>
<!-- The maximum limits of the records.
Specifiable values: 1 to 2,147,483,647
Default : The value of maxFetchCount of the <vsa> tag is applied.
-->
<param name="maxFetchCount" value="1440"/>
</export>
</command>
</application>
初期設定DTDファイル(config.dtd)のファイル例を次に示します。
<!--
* Title: PFM - Web Console Configuration File DTD
* Copyright: Copyright (C) 2006, 2007, Hitachi,Ltd.
* Licensed Material of Hitachi, Ltd. Reproduction, use, modification or disclosure
otherwise than permitted in the License Agreement is strictly prohibited.
-->
<!ELEMENT application (logging,export,vsa,draw?,command?,common?)>
<!ATTLIST application name ID #REQUIRED>
<!ELEMENT param (#PCDATA)>
<!ATTLIST param name CDATA #REQUIRED>
<!ATTLIST param value CDATA #REQUIRED>
<!-- common parameters -->
<!ELEMENT common (param*)>
<!-- logging parameters -->
<!ELEMENT logging (param+|separately?)* >
<!ELEMENT separately (param*)>
<!-- export parameters -->
<!ELEMENT export (param*)>
<!-- vsa parameters -->
<!ELEMENT vsa (vserver-connection,param*,vsa-factory?,format,bookmark?,
service-agent-collector-node?,service-agent-store-node?,health-check?,properties-define?,graph-exponential-display?,graph-time-correction?)>
<!ELEMENT vserver-connection (param*)>
<!ELEMENT vsa-factory (param*)>
<!ELEMENT format (param?,date-format?,locale-format*,modify-format*)>
<!ELEMENT date-format (#PCDATA)>
<!ATTLIST date-format
pattern (pattern-yyyyMMdd |
pattern-ddMMyyyy |
pattern-MMddyyyy ) #IMPLIED
separator (space |
slash |
hyphen |
period ) #IMPLIED
export-separator (space |
slash |
hyphen |
period ) #IMPLIED>
<!ELEMENT locale-format (date-format?,locale*,locale-format*)>
<!ELEMENT locale (#PCDATA)>
<!ELEMENT modify-format (date-format?,locale*)>
<!--bookmark parameters -->
<!ELEMENT bookmark (param*)>
<!--service agent node -->
<!ELEMENT service-agent-collector-node (param*)>
<!ELEMENT service-agent-store-node (param*)>
<!--health check-->
<!ELEMENT health-check (param*)>
<!-- properties-define-->
<!ELEMENT properties-define(param*)>
<!--graph-time-correction-->
<!ELEMENT graph-time-correction (param*)>
<!-- command parameters -->
<!ELEMENT command (export?)>
<!-- draw parameters -->
<!ELEMENT draw (chart-style|error-image)*>
<!ELEMENT chart-style (param*)>
<!ATTLIST chart-style id CDATA #REQUIRED>
<!ELEMENT error-image (param*)>
<!ATTLIST error-image id CDATA #REQUIRED>