9.2.1 DDでの定義

クライアント性能モニタ機能の設定は,クライアント性能フィルタで実行されます。

ここでは,アプリケーションの開発環境で必要なDDでの定義について,必須項目と任意項目に分けて説明します。DDでのクライアント性能モニタ機能の定義はweb.xmlに指定します。

<この項の構成>
(1) 必須項目
(2) 任意項目

(1) 必須項目

DDでの定義で必ず指定しなければならない項目は次の二つです。

定義方法については,「9.2.2 クライアント性能フィルタの定義方法」を参照してください。

(2) 任意項目

クライアント性能フィルタに指定する項目は,サーブレットフィルタの初期化パラメタ(<init-param>タグ)として定義します。

DDでの定義で任意に指定できる項目を次の表に示します。これらの項目は,サーブレットフィルタの初期化パラメタ(<filter>タグ内の<init-param>タグ)に指定します。なお,各項目に指定範囲外の値や文字列,誤った文法などを指定した場合はエラーとなり,Webアプリケーションが開始できません。

表9-5 DDでのクライアント性能モニタ機能の定義でカスタマイズできる項目

項番項目<param-name>に指定する要素<param-value>に指定する内容デフォルト値
1使用するリソース名の先頭文字列resourcePrefixクライアント性能モニタ機能で使用する次のリソース名の先頭文字列をほかの文字列に置き換えたい場合に指定します。
  • Cookie名
  • HTMLドキュメントのエレメントのid属性
  • user Dataビヘイビアで保存されるファイル名
先頭文字列は,半角英字(A~Z(大文字))の5文字の文字列で指定します。
この項目は,通常は指定する必要はありません。ユーザが作成したWebアプリケーションの中に「CPMON_」で始まるCookie名が含まれている場合などに,名前の重複を避けるために指定してください。
CPMON
2Webブラウザ上の性能データの有効期限dataExpireWebブラウザ上に保存される性能データ全体の有効期限を分単位で指定します。値は,1~1440の整数で指定します。
ここで指定する有効期限は,すべての性能データで共有されます。クライアント性能測定スクリプトやモニタページの操作で,性能データが更新(追加,削除など)されるたびに,有効期限が再設定されます。性能データが更新されないまま有効期限を超えた場合は,すべての性能データが有効期限切れとなります。
なお,ここで指定する有効期限は,クライアント性能モニタ機能が保証する期間です。この期限を過ぎると即座に性能データが失われるわけではありません。
また,有効期限内の性能データであっても,dataMaxCountに設定した個数,またはWebブラウザのリソースの上限値を超えたデータは削除対象となります。
60
3問い合わせIDの先頭文字列idAddrNameMapping問い合わせIDの先頭文字列にあるIPアドレス部分をほかの文字列に置き換えたい場合に指定します。
先頭文字列には,半角英数字(0~9,A~Z(大文字))の組み合わせで15文字以内の文字列を指定します。クライアントにホストのIPアドレスを公開しない場合に指定してください。
この項目を指定する場合の構文を次に示します。
構文
IPアドレス=置き換え文字列
複数のIPアドレスを指定する場合は,半角セミコロン「;」を区切り文字として指定してください。「;」の前後の空白文字は無視されます。最後の「;」は無視されます。
複数指定する場合の例
IPアドレス=置き換え文字列;IPアドレス=置き換え文字列;・・・
なお,問い合わせIDのIPアドレスがここで指定したどのアドレスとも一致しなかった場合は,問い合わせIDのIPアドレスがそのままクライアントに送信されます。
問い合わせIDについては,「9.2.3 問い合わせIDの定義方法」を参照してください。
4クライアント性能フィルタのバッファサイズfilterSizeクライアント性能フィルタが最低限確保するバッファサイズをバイト単位で指定します。値は,1024~2097152の整数で指定します。
WebアプリケーションのHTMLコンテンツで,<BODY>タグまたは<FRAMESET>タグが現在のバッファサイズよりもあとに設定されて,クライアント性能測定スクリプトが挿入されない場合は,この指定値を大きくしてください。ただし,値を大きくした場合,処理性能が低下します。
8192
5性能データを保存する個数dataMaxCountWebブラウザ上に保存する性能データの個数を指定します。値は,10~200の整数で指定します。
この値を超える性能データが記録された場合,古い性能データから順番に削除対象として扱われます。削除対象の性能データは,任意のタイミングで削除されます。ただし,実際に削除されるまでは,通常の性能データと同様に扱うことができます。
また,性能データの個数が保存できる上限値以内であっても,dataExpireに設定した有効期限,またはWebブラウザのリソースの上限値を超えたデータは削除対象となります。
50
6クライアント性能モニタを適用しないページの指定ignorePagesクライアント性能モニタ機能を適用しないページのパスを指定します。性能データを読み出すアプリケーションを作成した場合,このパスを指定して測定対象から除きます。
通常は指定する必要はありません。
パスには,コンテキストルート以下を指定してください。
複数のパスを指定する場合は,半角セミコロン「;」を区切り文字として指定してください。「;」の前後の空白文字は無視されます。また,最後の「;」は無視されます。
複数指定する場合の例
/monitor/MyMonitor.html;/MyMonitor2.html
7Webブラウザ側のエラー表示方法の指定printErrorBoxWebアプリケーションに埋め込まれたクライアント性能測定スクリプトの実行中にエラーが発生した場合,エラーメッセージをWebブラウザのダイアログボックスに表示するかどうかを指定します。値は,OnまたはOffで指定します。
On
エラーメッセージを表示します。
Off
エラーメッセージを表示しません。
クライアント性能モニタ機能が動作していることをユーザに意識させたくない場合などに指定します。
この項目の指定は次のエラー発生時に有効です。
  • クライアント性能測定スクリプトによる性能データの取得フェーズでのエラー
  • API(ClientPerformance.getAllLogメソッド)実行時のエラー
なお,モニタページの操作中に発生したエラーメッセージは,この設定内容に関係なくWebブラウザのダイアログボックスに表示されます。
Off
8モニタページの表示レベルの指定monitorPageEnableLevelモニタページの表示レベルを指定します。指定した表示レベル以外のモニタページへアクセスした場合は,404 Not Foundが表示されます。値は,Test,MonitorまたはAPIのどれかで指定します。
Test
クライアントからモニタページ,および性能データを読み出すためのAPI(ClientPerformance.getAllLogメソッド)のサンプル画面が表示できます。また,API(ClientPerformance.getAllLogメソッド)を実行できます。この値はテスト環境以外では指定しないでください。サンプル画面は確認用の画面です。
Monitor
クライアントからモニタページを表示できます。また,API(ClientPerformance.getAllLogメソッド)を実行できます。
API
クライアントからは,API(ClientPerformance.getAllLogメソッド)だけが実行できます。
モニタページをユーザに公開しない場合などにこの値を指定してください。APIを指定した場合は,性能データを読み出すための画面を作成する必要があります。
性能データを読み出すための画面の作成については,「9.2.6 Webブラウザから性能データを読み出すアプリケーションの作成」を参照してください。また,モニタページの表示レベルの指定については,「9.2.4 モニタページのアクセス制御の定義方法」を参照してください。
Monitor
9性能データの異常値を検出するのためのしきい値warningThreshold通信時間,描画時間,応答時間および操作時間のそれぞれの値で,異常値と判定するしきい値をミリ秒単位で指定します。しきい値は,0~86400000の整数で指定します。
しきい値を指定する場合の構文を次に示します。
構文
(通信時間のしきい値, 描画時間のしきい値, 応答時間のしきい値, 操作時間のしきい値)
指定したしきい値を超えた場合,モニタページで性能情報や統計情報を表示したときに,該当する値のセルが赤い警告色で表示されます。
また,値に0を指定した場合は,しきい値は設定されません。この場合,警告色は表示されません。
(3000, 3000, 6000, 0)
10保存するファイル名の最大長urlMaxLength性能データに記録するURLのファイル名の最大長を指定します。値は,16~64の整数で指定します。通常は指定する必要はありません。
性能データのファイル名が途中で切れてしまう場合は,この指定値を大きくすることで対応できます。ただし,値を大きくした場合は,保存できる性能データの個数が減少します。
16

(凡例) -:なし