jpcvtaskctl(タスクの計測を一時停止/再開する)
- 〈このページの構成〉
形式
- 形式1(特定のタスクIDの計測を一時停止する)
-
jpcvtaskctl pause -t タスクID [-v]
- 形式2(特定のタスクIDの計測を再開する)
-
jpcvtaskctl continue -t タスクID [-v]
- 形式3(一時停止しているタスクID一覧を昇順で標準出力に出力する)
-
jpcvtaskctl list
- 形式4(一時停止/再開をプローブ/IEプローブに通知する)※
-
jpcvtaskctl sync [-v]
- 注※
-
形式1および形式2でコマンドを実行し,一時停止/再開の対象としてタスクIDの登録/削除に成功していても,システム負荷などの要因で通信エラーが発生した場合,プローブやIEプローブへの一時停止/再開の通知が失敗し,有効にならないことがあります。この場合,通信エラーの要因を取り除いてから,形式4でコマンドを実行します。形式4でコマンドを実行すると,プローブやIEプローブに再通知を行い,一時停止/再開を有効にできます。
機能
PFM - Agent for Service Responseから監視対象に対してリクエストを発行し,レスポンスなどを取得するといったプローブおよびIEプローブによる計測をタスクID単位に一時停止することができます。また,一時停止しているタスクIDの一覧を昇順で標準出力に出力して,一時停止中のタスクIDを確認することや,一時停止中のタスクIDの計測を再開させることもできます。
最大500件までのタスクIDを一時停止しておくことができます。
実行権限
Administrators権限
格納先フォルダ
インストール先フォルダ\agtv\probe\bin
引数
-t タスクID
一時停止または再開するタスクIDを1件指定します。なお,指定されるタスクIDが計測条件登録ファイル(esptask.xml)に存在するかどうかは,jpcvtaskctlコマンドではチェックしません。
-v
jpcvtaskctlコマンド実行時に,詳細情報も同時に標準出力に出力します。
注意事項
-
jpcvtaskctlコマンドは複数同時に実行できません。複数実行した場合,あとから実行されたjpcvtaskctlコマンドの実行結果がエラーとなります。
-
jpcvtaskctlコマンドはプローブの起動状態に関係なく,実行することができます。プローブが起動していないときに実行されたコマンド結果は,プローブが起動されたときに有効となります。IEプローブについても同様です。
-
アラーム機能を使用して稼働監視している監視対象に対してjpcvtaskctlコマンドを実行する場合は,jpcvtaskctlコマンドの実行とあわせてアラームによる監視の停止/開始をしてください。
図11‒1 アラーム機能を使用して稼動監視する場合 アラームによる監視の停止/開始については,マニュアル「JP1 Version 11 JP1/Performance Management 運用ガイド」をご参照ください。
実行順序については,必ず以下の手順で一時停止/再開を行うようにしてください。順序が異なると,PFM - Agent for Service Responseの計測や監視対象そのものが停止状態のときにアラームが発行され,エラーとして通知されてしまうことがあります。
図11‒2 アラーム機能を使用して稼動監視している監視対象の計測を一時停止/再開する手順 - <一時停止する場合>
-
1. アラームによる監視を停止する。
2. jpcvtaskctl pauseコマンドを実行し,PFM - Agent for Service Responseの計測を一時停止する。
3. 手順2で指定したタスクIDの計測間隔※だけ時間を空ける。
4. 監視対象のサービスを停止する。
- <再開する場合>
-
1. 監視対象のサービスを起動する。
2. jpcvtaskctl continueコマンドを実行し,PFM - Agent for Service Responseの計測を再開する。
3. 手順2で指定したタスクIDの計測間隔※だけ時間を空ける。
4. アラームによる監視を再開する。
- 注※
-
計測間隔は,計測条件登録ファイル(esptask.xml)でタスクIDごとに指定している<INTERVAL>タグの値を指します。詳細は,「8.3.2 計測条件(共通部分)の書式と定義内容」を参照してください。
計測間隔で指定した時間を置かずに上記の手順を実施すると,PFM - Agent for Service Responseの計測が完全に停止/再開される前の計測結果で,再開時の初回アラーム発行が行われてしまい,エラーとして通知されてしまうことがあります。
-
jpcvtaskctl pauseコマンドでタスクIDの計測を一時停止すると,jpcvtaskctl continueコマンドでタスクIDの計測が再開されるまで,そのタスクIDが一時停止の対象であるという情報は保持され続けます。
一時停止しているタスクIDのタスク自体が削除されても,同じタスクIDで新たにタスクを定義した場合には,以前のタスクの一時停止状態は引き継がれます。
タスクIDが一時停止の対象かどうかについては,jpcvtaskctl listコマンドで一時停止中のタスクID一覧を標準出力に出力して確認してください。
-
jpcvtaskctlコマンドで計測の一時停止もしくは再開を実行する場合は,PFM - Agent for Service Responseの起動またはリロードを同時に実行しないでください。同時実行した場合は,PFM - Agent for Service Responseのサービスが異常停止することがあります。
-
クラスタシステムで運用する場合,待機系ホストからjpcvtaskctlコマンドを実行することはできません。
-
通常構成の運用からクラスタシステムでの運用に移行する場合は,一時停止の登録は引き継ぎません。通常構成でタスクの一時停止をしていた場合は,クラスタ環境を設定後,jpcvtaskctl pauseコマンドで計測の一時停止を実行してください。
戻り値
|
0 |
正常終了。 |
|
1 |
コマンド実行時の引数や定義内容に誤りがある。または,継続運用できないメモリー不足などが発生している。 エラーの詳細はメッセージとしても出力される。 |
|
2 |
コマンド実行の結果がエラーとなる。 エラーの例:
エラーの詳細はメッセージとしても出力される。 |
|
3 |
コマンドが複数同時に実行されている。 |
使用例1(特定のタスクIDの計測を一時停止する場合)
ここでは,タスクID:100の計測を以下の監視対象のWebサーバの停止計画に合わせて,一時停止する例を示します。
|
- (1) 事前確認
-
jpcvtaskctl pauseコマンドを実行する前に,タスクID:100の計測間隔に指定した時間を事前確認しておく必要があります。計測間隔については,計測条件登録ファイル(esptask.xml)で確認することができます。<TASKID>タグの値が100の<INTERVAL>タグの値で確認します。<INTERVAL>タグの値の単位は秒です。
計測条件登録ファイル(esptask.xml)が以下の例とすると,タスクID:100の計測間隔は,300秒(5分)となります。
<?xml version="1.0" encoding="Shift_JIS" standalone="no"?> <!DOCTYPE TASKLIST SYSTEM "esptask.dtd"> <TASKLIST> <TASK> <GEN_PARAM> <TASKID>100</TASKID> <INTERVAL>300</INTERVAL> </GEN_PARAM> <SERV_PARAM> <HTTP> <URL>www.example.com/</URL> </HTTP> </SERV_PARAM> </TASK> </TASKLIST> - (2) 監視対象のWebサーバ停止時の流れ
-
-
2016/07/07 00:55:00以前 アラームによる監視を停止する。
-
2016/07/07 00:55:00以前 jpcvtaskctl pauseコマンドを実行して,タスクID:100の計測を停止する。
-
タスクID:100の計測間隔(5分)時間を空ける。
-
2016/07/07 01:00:00 監視対象のWebサーバを計画停止する。
一時停止するタスクID:100のアラームによる監視の停止およびjpcvtaskctl pauseコマンド実行による一時停止を2016/07/07 00:55:00以前に完了させてください。実行順序はアラームによる監視の停止を先に実施してください。アラームによる監視の停止より先に計測を一時停止してしまうと,計測失敗のエラーがアラームとして発行されてしまう可能性があります。
jpcvtaskctl pauseコマンドの実行に成功すると,以下のようにKAVK43004-Iメッセージが出力されます。
>jpcvtaskctl pause -t 100 KAVK43004-I コマンドの実行に成功しました。
-
使用例2(一時停止している特定タスクIDの計測を再開する場合)
使用例1で一時停止したタスクID:100の計測を,計画しているサーバ起動時刻(2016/07/07 06:00:00)直後に再開する例を示します。
- (1) 監視対象のWebサーバ起動時の流れ
-
-
2016/07/07 06:00:00 監視対象のWebサーバを起動する。
-
2016/07/07 06:03:00 監視対象のWebサーバの起動完了を確認してから,jpcvtaskctl continueコマンドを実行して,タスクID:100の計測を再開する。
-
タスクID:100の計測間隔(5分)時間を空ける。
-
2016/07/07 06:08:00以降 アラームによる監視を開始する。
jpcvtaskctl continueコマンド実行による計測再開後,使用例1と同様に,計測条件登録ファイル(esptask.xml)で確認したタスクID:100の計測間隔(5分)だけ時間を空け,計測が完全に開始されている2016/07/07 06:08:00以降に,タスクID:100のアラームによる監視を再開します。
jpcvtaskctl continueコマンドの実行に成功すると,以下のようにKAVK43004-Iメッセージが出力されます。
>jpcvtaskctl continue -t 100 KAVK43004-I コマンドの実行に成功しました。
-
使用例3(エラーなどの理由により,一時停止が有効にならない場合)
使用例1でjpcvtaskctl pauseコマンドを実行時に以下のメッセージが出力される場合の対処について,出力されるメッセージごとに以下に示します。
- (1) KAVK43008-Eが出力された場合
>jpcvtaskctl pause -t 100 KAVK43008-E 内部ファイルの操作に失敗しました。OP=WRITE, ERRNO=xx, P1=xx, P2=xx, ERRINFO=xx KAVK43003-E コマンドの実行に失敗しました。
一時停止の対象となるタスクIDの登録に失敗しています。「12.4 メッセージ一覧」のKAVK43008-Eの記載をもとに,エラー原因を取り除いた上で,jpcvtaskctl pauseコマンドを再実行してください。
なお,一時停止の対象にタスクIDの登録が成功しているかどうかは,jpcvtaskctl listコマンドの実行結果で確認することができます。登録に成功している場合は,jpcvtaskctl pauseコマンドの実行時に指定した引数-tのタスクIDが,以下のようにjpcvtaskctl listコマンドの実行結果として出力されます。
>jpcvtaskctl list 100
- (2) KAVK43009-Eが出力された場合
>jpcvtaskctl pause -t 100 KAVK43009-W Probe/IEProbeデーモンへの通知ができませんでした。 SERVICE=PROBE KAVK43009-W Probe/IEProbeデーモンへの通知ができませんでした。 SERVICE=IEPROBE KAVK43004-I コマンドの実行に成功しました。
一時停止の対象となるタスクIDの登録には成功していますが,プローブまたはIEプローブに対する一時停止の通知に失敗しています。通知に失敗するケースとしては,システム負荷などの要因で通信エラーが発生した場合などが考えられます。
プローブまたはIEプローブが停止している場合にも,KAVK43009-Wのメッセージが出力されるため,まずはKAVK43009-Wのメッセージとして出力されるSERVICEの値に基づき,プローブまたはIEプローブが起動しているかを確認してください。SERVICEの値がPROBEである場合はプローブ,IEPROBEである場合はIEプローブが起動していることを確認します。IEシナリオ以外の計測をしている場合はプローブ,IEシナリオの計測をしている場合はIEプローブが起動しているかを確認してください。計測していないサービスは起動しなくても問題ありませんので,このメッセージは無視してください。
プローブまたはIEプローブが起動しているが,本メッセージが出力される場合にはシステム負荷の状態を確認後,以下のようにjpcvtaskctl syncコマンドを実行してください。
>jpcvtaskctl sync KAVK43004-I コマンドの実行に成功しました。
コマンド実行が成功すると,プローブまたはIEプローブへの通知のみ再実行され,一時停止が有効となります。
コマンド実行に失敗する場合には,jpcvtaskctl syncコマンドの引数に-vも追加することで,さらに詳細なエラー情報を確認することができます。
>jpcvtaskctl sync -v KAVK43010-E Probe/IEProbeデーモンへの通知ができませんでした。OP=xx, ERRNO=xx, SERVICE=PROBE, ERRINFO=xx KAVK43010-E Probe/IEProbeデーモンへの通知ができませんでした。OP=xx, ERRNO=xx, SERVICE=IEPROBE, ERRINFO=xx KAVK43003-E コマンドの実行に失敗しました。
「12.4 メッセージ一覧」の出力メッセージの対処方法の記載をもとに,エラー原因を取り除いてコマンドを再実行してください。