CA Continuous Application Insight の使用 › CAI コマンドライン ツール

CAI コマンドライン ツール

PFCmdLineTool コマンドでは、コマンドラインからさまざまな CA Continuous Application Insight タスクを実行できます。

主なオプションは、--count、--roots、--paths、--export、--import、--baseline、および --virtualize です。

コマンドの形式は以下のとおりです。

PFCmdLineTool [--count|--roots|--paths|--export|--import|--baseline|--virtualize|--help|--version] [タスク固有のオプション] [検索条件]

検索条件

--import 以外の主要なすべてのオプションでは、操作されるトランザクション フレームのセットは指定した検索条件に一致するオプションによって定義されます。 検索条件を指定するには、--from、--to、--localIP、--remoteIP、--category、--class、--method、--session、--transaction、–agent、--min-time、--tag、--max-frames の中から任意のオプションを使用します。 これらのオプションは、操作されるルート トランザクション フレームのセットを絞り込むために使用されます。

また、--frame オプションを使用して検索結果を単一のトランザクション フレームに制限することもできます。

--from=開始時刻

必要なトランザクション フレームのウィンドウの開始時刻を指定します。 yyyy-mm-dd または yyyy-mm-ddThh:mm:ss のいずれかの形式を使用します。 このオプションおよび --frame オプションが指定されない場合、現在の日の開始時刻が使用されます。

--to=終了時刻

必要なトランザクション フレームのウィンドウの終了時刻を指定します。 yyyy-mm-dd または yyyy-mm-ddThh:mm:ss のいずれかの形式を使用します。 このオプションおよび --frame オプションが指定されない場合、現在の日の終了時刻が使用されます。

--localIP=IP アドレス

CAI が記録するクライアント側 IP アドレスを指定します。

--remoteIP=IP アドレス

CAI が記録するサーバ側 IP アドレスを指定します。

--category=カテゴリ

トランザクション フレームのタイプを指定します。 このオプションを繰り返して指定することにより、複数のカテゴリを一度に検索できます。

値： amx、client、dn_default、dn_remoting、dn_sql、ejb、gui、jca、jdbc、jms、logging、mq、rest_http、rmi、rmi_http、rmi_ssl、thread、throwable、tibco、web_http、web_https、wm、wps、ws_http、ws_https

--class=クラス名

クラス名を指定します。 この値は、完全なクラス名か、または「%」で終了する文字列（「前方一致」検索を実行）のいずれかになります。

--method=メソッド名

メソッド名を指定します。 この値は、完全なメソッド名か、または「%」で終了する文字列（「前方一致」検索を実行）のいずれかになります。

--session=セッション ID

セッション識別子を指定します。

--transaction=トランザクション ID

トランザクション識別子を指定します。

--agent=エージェント名

必要なトランザクション フレームに対するソースであるエージェントの名前を指定します。

--min-time=min-time

参照するトランザクション フレームの最小実行時間（ミリ秒）を指定します。 この値より速く実行されるフレームはフィルタで除外されます。

--tag=名前、--tag=名前=値

トランザクション フレームと関連付けられたフレーム タグを指定します。 名前のみ、または名前と値の両方を指定できます。 このオプションを繰り返すことにより、複数のタグを一度に検索できます。

--max-frames=最大フレーム数

取得されるルート トランザクション フレームの最大数を指定します。 このオプションが指定されない場合、デフォルトで 10000 になります。 この最大数より多くのフレームが処理される場合があります。

--frame=frame-id

必要な特定のトランザクション フレームの識別子を指定します。

クエリの実行および表示

以下のオプションにより、トランザクションに対してクエリを実行し、トランザクションを表示できます。

-c、--count

指定された検索条件に一致するルート トランザクション フレームの数を表示します。

-r、--roots

指定された検索条件に一致するルート トランザクション フレームを表示します。

-p、--paths

ルート トランザクション フレームのセットのトランザクション フレーム階層を表示します。

エクスポートおよびインポート

以下のオプションにより、パスをエクスポートおよびインポートできます。

-e 出力 ZIP ファイル名、--export=出力 ZIP ファイル名

選択されたトランザクション フレームをデータベースからエクスポートします。

-i 入力 ZIP ファイル名、--import=入力 ZIP ファイル名

トランザクションをデータベースにインポートします。 指定した検索条件は無視されます。

--no-persist

インポート操作でデータを保持しないように指定します。インポート ファイルの検証のみが実行されます。

注： DevTest がデフォルトの Derby 以外のデータベースに接続される場合、rules.xml ファイルの broker エレメントにデータベースを指定する必要があります。

<database driver="yourdatabasedriver" url="yourdatabaseurl" user="yourdatabaseuser" password="yourdatabasepassword"/>

この設定は、エージェントのライフスパンにおいて使用されます。

ベースライン

以下のオプションにより、ベースライン テスト ケースおよびスイートを作成できます。 --to-dir オプションまたは --to-project オプションは必須です。

-b 名前、--baseline=名前

選択されたトランザクション フレームに対するベースライン テストを生成します。

--refer=フレーム ID

キー トランザクション フレームとして指定される特定のトランザクション フレームの識別子を指定します。 このオプションが指定されない場合、クエリ結果内の最初のトランザクション フレームがキー トランザクション フレームとして指定されます。

--consolidated

ベースライン テスト ケースを生成するように指定します。 このオプションが指定されない場合、ベースライン スイートが生成されます。

--stateful

ステートフル ベースラインが生成されることを指定します。

--force-tf-steps

ベースライン テストをトランザクション フレームの実行ステップのみを使用して生成するように指定します。 このオプションが指定されない場合、使用可能なすべての CA Application Test テスト ステップが可能な限り使用されます。

注： トランザクション フレームの実行ステップの詳細については、「CA Application Test の使用」を参照してください。

--magic-dates

ベースライン テストでマジック デート処理が適用されることを指定します。

--jndi-factory=ファクトリ クラス名

EJB ベースライン テストを生成するときに使用する JNDI ファクトリ クラスを指定します。

--jndi-url=URL

EJB ベースライン テストを生成するときに使用する JNDI URL を指定します。

--jndi-user=ユーザ ID

EJB ベースライン テストを生成するときに使用する JNDI ユーザを指定します。

--jndi-user-cred=ユーザ認証情報

EJB ベースライン テストを生成するときに使用する JNDI ユーザ認証情報を指定します。

--to-dir=出力 PFI ファイル名

生成された PFI ファイルが書き込まれるディレクトリの名前を指定します。

--to-project=LISA プロジェクト ディレクトリ

中間のインポート ファイルを必要とせずに、生成されたアーティファクトが書き込まれるプロジェクトのルート ディレクトリを指定します。 --to-dir オプションの代わりに、または追加してこのオプションを指定できます。

仮想化アーティファクト

以下のオプションにより、仮想化アーティファクトを生成できます。 --to-dir オプションまたは --to-project オプションは必須です。

-v 名前、--virtualize=名前

選択されたトランザクション フレームに対する仮想化アーティファクトを生成します。

--refer=フレーム ID

キー トランザクション フレームとして指定される特定のトランザクション フレームの識別子を指定します。 このオプションが指定されない場合、クエリ結果内の最初のトランザクション フレームがキー トランザクション フレームとして指定されます。

--force-stateless

サービス イメージを生成するとき、VSE 会話式処理が適用されることを指定します。

--unknown-request-action=no_match|no_hijack

不明な要求に対して実行されるアクションを指定します。 このオプションは、Java VSE に基づいて生成された仮想化アーティファクトに適用されます。 有効な値は、no_match （「一致なし」を返す）および no_hijack （仮想サービスを省略）です。

--to-dir=出力 PFI ファイル名

生成された PFI ファイルが書き込まれるディレクトリの名前を指定します。

--to-project=LISA プロジェクト ディレクトリ

中間のインポート ファイルを必要とせずに、生成されたアーティファクトが書き込まれるプロジェクトのルート ディレクトリを指定します。 --to-dir オプションの代わりに、または追加してこのオプションを指定できます。

エージェントの状態

以下のオプションでは、エージェントの指定された状態を確認できます。 サポートされている唯一の状態は、エージェントが現在ディスパッチしているかどうかです。 「ディスパッチ」とは、トランザクションをキャプチャするアクションを表します。

--check

エージェントの指定された状態を確認します。

--agent=エージェント名

エージェントの名前を指定します。

--condition=状態

確認する状態を指定します。

値： Dispatching

--check-timeout=秒数

タイムアウトになるまで待機する秒数を指定します。

キャプチャ レベル

以下のオプションでは、Java エージェントがキャプチャできる各プロトコルのキャプチャ レベルを変更できます。

注： WebSphere MQ、JMS など、キューベースのクライアント/サーバ通信では、異なるキャプチャ レベルの設定はサポートされていません。

--set-weights

1 つ以上のプロトコルのキャプチャ レベルを変更します。

--agent=エージェント名

エージェントの名前を指定します。

--protocols="プロトコル[,プロトコル]"

プロトコル名を指定します。 複数の値を含める場合は、値をカンマで区切ります。

値： ALL、HTTP Client、HTTP Server、Logging、Category、Exception、GUI、EJB、JMS、MQ、JCA、RCP、RMI、SAP、Tibco、WPS、WebMethods、JDBC

--weights="重み付け[,重み付け]"

プロトコルの重み付けを指定します。 複数の値を含める場合は、値をカンマで区切ります。

値： 0、4、8。 値 0 は「カウント」レベルに対応します。 値 4 は「カウント数およびパス」レベルに対応します。 値 8 は「全データ」レベルに対応します。

その他

以下のオプションも使用できます。

--broker=ブローカ URL

ブローカ接続文字列を指定します。 デフォルト値は tcp://localhost:2009 です。

--search-frame

指定された検索条件およびフレーム名に一致するトランザクション フレームを検索します。

--frame-name=フレーム名

検索するトランザクション フレームの名前を指定します。

--help -h

ヘルプ テキストを表示します。

--version

バージョン番号を出力します。

例： ルート トランザクション フレームの表示

この例では、指定したエージェントおよび開始時刻のルート トランザクション フレームを表示する方法を示します。

PFCmdLineTool --roots --agent=JBoss_LISABank --from=2014-03-14T12:28:00

Frame ID                              Time                     Category  Local IP       Remote IP      Name     Exec Time
------------------------------------  -----------------------  --------  -------------  -------------  -------  ---------
c3a9c830-abae-11e3-b937-0024d6ab5ce2  2014-03-14 12:28:04 660  web_http  10.132.92.143  10.132.92.143  Unknown  984 ms

例： トランザクション フレーム階層の表示

この例では、1 セットのルート トランザクション フレームのトランザクション フレーム階層を表示する方法を示します。

PFCmdLineTool --paths --agent=JBoss_LISABank --from=2014-03-14T12:28:00

984 ms /lisabank/buttonclick.do (c3a9c830-abae-11e3-b937-0024d6ab5ce2)
   50 ms $Proxy93.getUser (c3c73b40-abae-11e3-b937-0024d6ab5ce2)
      37 ms EJB3UserControlBean.getUser (c3c8c1e0-abae-11e3-b937-0024d6ab5ce2)
         3 ms SQL Activity (1) (c3c8c1e0-abae-11e3-b937-0024d6ab5ce2-SQL)

例： ベースライン スイートの生成

この例では、ベースライン スイートを生成する方法を示します。

PFCmdLineTool --baseline=BaselineName --refer=c3c8c1e0-abae-11e3-b937-0024d6ab5ce2 --to-dir=C:\DevTest

例： ステートフル ベースラインの生成

この例では、ステートフル ベースラインを生成する方法を示します。

PFCmdLineTool --baseline=BaselineName --stateful --from=2014-03-14T12:28:00 --refer=c3c8c1e0-abae-11e3-b937-0024d6ab5ce2 --to-dir=C:\DevTest

例： 仮想化アーティファクトの生成

この例では、仮想化アーティファクトを生成する方法を示します。

PFCmdLineTool --virtualize=VSEServiceName --from=2014-03-14T12:28:00 --refer=c3c8c1e0-abae-11e3-b937-0024d6ab5ce2 --category=ejb --to-dir=C:\DevTest

例： エージェントの状態の確認

この例では、エージェントがトランザクションをキャプチャしているかどうかを確認する方法を示します。 この出力は、エージェントがトランザクションをキャプチャしていないことを示しています。

PFCmdLineTool --check --agent=JBoss_LISABank --condition=Dispatching --check-timeout=10

Agent has not yet started dispatching.

例： キャプチャ レベルの設定

この例では、1 つのプロトコルのキャプチャ レベルを変更する方法を示します。

PFCmdLineTool --set-weights --agent=JBoss_LISABank --protocols=EJB --weights=8

この例では、複数のプロトコルのキャプチャ レベルを変更する方法を示します。 引用符が使用されていることに注目してください。

PFCmdLineTool --set-weights --agent=JBoss_LISABank --protocols="EJB,JMS" --weights="8,4"

例： 名前によるトランザクション フレームの検索

この例では、CAI が特定のトランザクション フレームをキャプチャしたかどうかをフレーム名によって確認する方法を示します。 検索によって複数の一致するフレームが見つかった場合、最新のフレームが表示されます。 この出力は名前、期間、および一意の識別子で構成されています。

PFCmdLineTool --search-frame --frame-name=EJB3AccountControlBean.addAccount --from=2014-03-20T10:20:00

EJB3AccountControlBean.addAccount, 141 ms, 27ca1bd0-b03c-11e3-a8f1-005056ba138a