Share via

コマンド ラインからプロファイラーを使用してスタンドアロンの .NET Framework コンポーネントをインストルメントし、タイミング データを収集する

  • [アーティクル]

このトピックでは、Visual Studio コマンド ライン プロファイル ツールを使用して、.exe ファイルや .dll ファイルなどの .NET Framework コンポーネントをインストルメント化し、詳細なタイミング データを収集する方法について説明します。

注意

.NET Core と .NET 5 以降については、コマンド ライン インストルメンテーション シナリオの「コマンド ラインからアプリケーションのパフォーマンスを測定する」を参照してください。 VSInstr は、.NET Core および .NET 5 以降のバイナリではサポートされていません。 Visual Studio 2022 バージョン 17.6 以降では、動的インストルメンテーションが提供されるため、.NET Framework シナリオにも VSDiagnostics.exe を使用することをお勧めします。

インストルメンテーション メソッドを使用して .NET Framework から詳細なタイミング データを収集するには、VSInstr.exe ツールを使用してコンポーネントのインストルメント化されたバージョンを生成し、VSPerfCLREnv.cmd ツールを使用して、プロファイル環境変数を初期化します。 次に、プロファイラーを起動します。

プロファイリング ツールへのパスは Microsoft Visual Studio\version\Enterprise\Team Tools\DiagnosticsHub\Collector です。

Note

プロファイラー コマンド ライン ツールを使用するには、コマンド プロンプト ウィンドウの PATH 環境変数にツールのパスを追加するか、コマンド自体にそれを追加します。

インストルメントされたコンポーネントを実行すると、タイミング データがデータ ファイルに自動的に収集されます。 プロファイル セッション中にデータ収集を一時停止および再開できます。

プロファイル セッションを終了するには、対象のアプリケーションを終了し、プロファイラーを明示的に終了します。 ほとんどの場合、セッションの最後にプロファイル環境変数を消去することをお勧めします。

プロファイル セッションの開始

インストルメンテーション メソッドを使用してプロファイルを開始するには:

  1. コマンド プロンプト ウィンドウを開きます。 必要に応じて、プロファイラー ツール ディレクトリを PATH 環境変数に追加します。 インストール時にはパスは追加されません。

  2. VSInstr ツールを使用して、対象アプリケーションのインストルメントされたバージョンを生成します。

  3. .NET Framework プロファイル環境変数を初期化します。 型:

    VSPerfClrEnv /traceon

  4. プロファイラーを起動します。 型:

    VSPerfCmd /start:trace /output:OutputFile [Options]

    • /start:trace オプションによってプロファイラーが初期化されます。

    • /start を使用するには、/output:OutputFile オプションを指定する必要があります。 OutputFile には、プロファイル データ (.vsp) ファイルの名前と場所を指定します。

      /start:trace オプションでは、次のオプションのいずれかを使用できます。

    オプション 説明
    /user:[Domain\]UserName プロファイリングされたプロセスを所有するアカウントのドメインおよびユーザー名を指定します。 このオプションは、ログオンしているユーザーとは別のユーザーがプロセスを実行している場合にのみ指定する必要があります。 プロセスの所有者は、Windows タスク マネージャーの [プロセス] タブの [ユーザー名] 列に表示されます。
    /crosssession 他のセッションにおけるプロセスのプロファイリングを有効にします。 このオプションは、ASP.NET アプリケーションが別のセッションで実行されている場合に必要です。 セッション ID は、Windows タスク マネージャーの [プロセス] タブの [セッション ID] 列に表示されます。 /crosssession の省略形として、/CS を指定することができます。
    /globaloff データ コレクションを一時停止した状態でプロファイラーを起動します。 プロファイリングを再開するには、/globalon を使用します。
    /counter:Config Config で指定されたプロセッサのパフォーマンス カウンターから情報を収集します。 カウンター情報は、プロファイル イベントが発生するたびに、収集されたデータに追加されます。
    /wincounter:WinCounterPath プロファイリング実行中に収集する Windows パフォーマンス カウンターを指定します。
    /automark:Interval /wincounter との組み合わせでのみ使用します。 Windows パフォーマンス カウンター コレクション イベントの間隔をミリ秒単位で指定します。 既定値は 500 ミリ秒です。
    /events:Config プロファイリング実行中に収集する ETW (Event Tracing for Windows) イベントを指定します。 ETW イベントは独立した (.etl) ファイルに収集されます。

  5. コマンド プロンプト ウィンドウから対象のアプリケーションを開始します。

データ収集の制御

対象アプリケーションの実行中に、VSPerfCmd.exe のオプションを使用して、プロファイラーのデータ ファイルへのデータ書き込みを開始および停止することにより、データ収集を制御できます。 データ コレクションを制御することにより、アプリケーションの起動や終了など、プログラム実行の特定の部分についてのデータ コレクションを行うことができます。

データ収集を開始および停止するには:

  • 次に示すオプションの組み合わせにより、データ収集を開始および停止します。 個別のコマンド ラインで各オプションを指定します。 データ収集のオンとオフは複数回切り替えることができます。

    オプション 説明
    /globalon /globaloff すべてのプロセスのデータ収集を開始 ( /globalon) または停止 ( /globaloff) します。
    /processon:PID/processoff:PID プロセス ID (PID) で指定されたプロセスのデータ収集を開始 (/processon) または停止s (/processoff) します。
    /threadon:TID/threadoff:TID スレッド ID (TID) で指定されたスレッドのデータ収集を開始 (/threadon) または停止 (/threadoff) します。

プロファイル セッションの終了

プロファイル セッションを終了するには、インストルメントされたコンポーネントを実行中のアプリケーションを閉じます。 VSPerfCmd/shutdown オプションを呼び出して、プロファイラーをオフにし、プロファイル データ ファイルを閉じます。 VSPerfClrEnv /off コマンドは、プロファイル環境変数を消去します。

プロファイル セッションを終了するには:

  1. 対象アプリケーションを終了します。

  2. プロファイラーをシャットダウンします。 型:

    VSPerfCmd /shutdown

  3. (省略可能) プロファイル環境変数を削除します。 型:

    VSPerfClrEnv /off

関連するコンテンツ