3.6.1 ユーザー定義サービスの定義
計測対象サービスの応答時間などを計測するプログラムを作成し,ユーザー定義コマンドとして登録します。
- 〈この項の構成〉
(1) ユーザー定義コマンドの作成
ユーザー定義コマンドはコマンドラインから実行するプログラムとして作成します。ユーザー定義コマンドが計測する項目は1つだけです。複数の項目について計測したい場合は,必要な数だけユーザー定義コマンドを作成してください。なお,ユーザー定義コマンドはPFM - Agent for Service Responseから呼び出されるため,Administrators権限で実行します。
(a) 入力
PFM - Agent for Service Responseでは,ユーザー定義コマンドに対して入力用の値を引き渡すインターフェースは提供しません。サービス固有の計測条件については,ユーザー定義コマンドの引数,ファイル読み込みなどの方法で,計測実行に必要な情報を取得させる必要があります。
(b) 出力
ユーザー定義コマンドの標準出力を計測結果とするように設定した場合,ユーザー定義コマンドは次の値を標準出力に出力する必要があります。PFM - Agent for Service Responseは,標準出力に出力された値を応答性能情報として扱います。なお,ユーザー定義コマンドの実行(起動してから終了するまで)に掛かった時間を計測結果とするように設定した場合は,ユーザー定義コマンドの標準出力には何も出力しないでください。
値 |
説明 |
---|---|
応答性能情報 |
総応答時間,スループットなど任意の計測項目の値(倍精度実数)を文字列で出力します。 |
- 補足事項
-
ユーザー定義コマンドが計測した情報はレポートファイルに出力されます。ユーザー定義コマンドの実行に掛かった時間を出力する場合は,秒単位でミリ秒までの精度で出力します。なお,ユーザー定義コマンドが出力した値が範囲以外の値であったり,規定されたフォーマット以外で出力されたりした場合はエラーとして扱われ,計測を停止します。
(c) 戻り値
ユーザー定義コマンド終了時の戻り値は,計測結果を表します。次の表に示す値を戻り値として返すように作成してください。
戻り値 |
意味 |
---|---|
0 |
正常終了。 計測が正常に終了し,応答性能情報を取得。 |
0以外 |
異常終了。 計測は失敗し,応答性能情報の値は無効。 |
作成したユーザー定義コマンドは,次に示すPFM - Agent for Service Responseのユーザー定義コマンド格納フォルダに格納します。
インストール先フォルダ\agtv\probe\user
なお,ユーザー定義コマンド格納フォルダ以外のフォルダに格納したコマンドを呼び出したい場合は,コマンドを呼び出すバッチファイルを作成してユーザー定義コマンド格納フォルダに格納します。
- 注意事項
-
ユーザー定義コマンドの実行は,計測条件で指定したタイムアウト時間経過後に終了します。これは,ユーザー定義コマンドの内部処理が長時間終了しない場合に,ほかのインターネットサービスの計測開始(計測用リクエストの発行)が遅延するおそれがあるためです。したがって,ユーザー定義コマンドは,計測条件に指定したタイムアウト時間内に終了させるように作成してください。
(2) ユーザー定義コマンドの登録
作成したユーザー定義コマンドをコマンド登録ファイル(espcommand.xml)に登録します。コマンド登録ファイルには,計測対象サービスの識別子となるユーザー定義サービスIDや,その他サービス固有の計測条件を定義します。コマンド登録ファイルについては,「7.6 コマンド登録ファイル(espcommand.xml)」を参照してください。