方法: コマンド ラインを使用してプロファイラーを .NET サービスにアタッチし、同時実行データを収集する

Visual Studio 2017 RC の最新のドキュメントの詳細については、Visual Studio 2017 RC ドキュメントをご参照ください。

ここでは、Visual Studio プロファイリング ツールのコマンド ライン ツールを使用して、プロファイラーを .NET Framework サービスにアタッチし、サンプリング メソッドによってプロセス データおよびスレッド同時実行データを収集する方法について説明します。

注意

Windows 8 および Windows Server 2012 の強化されたセキュリティ機能によって、Visual Studio プロファイラーがこれらのプラットフォームでデータを収集する方法に大幅な変更が必要になりました。 Windows ストア アプリにも新しい収集手法が必要です。 「Windows 8 および Windows Server 2012 アプリケーションのプロファイリング」を参照してください。

注意

プロファイリング ツールのコマンド ライン ツールは、Visual Studio インストール ディレクトリの \Team Tools\Performance Tools サブディレクトリにあります。 64 ビット コンピューター上では、64 ビット バージョンのツールと 32 ビット バージョンのツールの両方を使用できます。 プロファイラー コマンド ライン ツールを使用するには、コマンド プロンプト ウィンドウの PATH 環境変数にツールのパスを追加するか、コマンド自体にそれを追加します。 詳細については、「コマンド ライン ツールへのパスの指定」を参照してください。

同時実行データを収集するには、プロファイラーをサービス プロセスにアタッチします。 プロファイラーをサービスにアタッチしている間はデータ収集を一時停止し、完了後に再開できます。 プロファイル セッションを終了するには、サービスへのプロファイラーのアタッチを解除し、プロファイラーを明示的に終了する必要があります。 ほとんどの場合、セッションの最後にプロファイル環境変数を消去することをお勧めします。

プロファイラーのアタッチ

プロファイラーを .NET Framework サービスにアタッチするには

  1. サービスをインストールします。

  2. コマンド ウィンドウを開きます。

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

    VSPerfClrEnv \/globalsampleon [\/samplelineoff]

    • \/globalsampleon はサンプリングを有効にします。

    • \/samplelineoff は、特定のソース コード行への収集データの割り当てを無効にします。 このオプションを指定すると、データは関数に対してのみ割り当てられます。

  4. コンピューターを再起動します。

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

    VSPerfCmd \/start:concurrency \/output:OutputFile [Options]

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

    \/start オプションを使用する場合は、次のうちいずれかのオプションを指定できます。

    注意

    \/user オプションと \/crosssession オプションは、通常、サービスで必要です。

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

  7. プロファイラーをサービスにアタッチします。 Type:

    VSPerfCmd \/attach: PID [\/targetclr:Version]

    • PID には、サービスのプロセス ID またはプロセス名を指定します。 Windows タスク マネージャーで、実行中のすべてのプロセスのプロセス ID を参照できます。

    • targetclr: Version には、アプリケーションに複数のバージョンのランタイムが読み込まれている場合に、プロファイリングを行う共通言語ランタイム (CLR: Common Language Runtime) のバージョンを指定します。 省略可能。

データ収集の制御

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

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

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

    オプション 説明
    \/globalon \/globaloff すべてのプロセスのデータ収集を開始 (\/globalon) または停止 (\/globaloff) します。
    \/processon : PID \/processoff:PID プロセス ID (PID) で指定されたプロセスのデータ収集を開始 (\/processon) または停止 (\/processoff) します。
    \/attach:{PID|ProcName} \/detach[:{PID|ProcName}] \/attach は、プロセス ID またはプロセス名で指定したプロセスのデータ収集を開始します。 \/detach は、指定されたプロセスのデータ収集を停止します。特定のプロセスが指定されていない場合は、すべてのプロセスのデータ収集を停止します。
  • VSPerfCmd.exe \/mark オプションを使用して、データ ファイルにプロファイル マークを挿入することもできます。 \/mark コマンドは、ID、タイム スタンプ、およびオプションのユーザー定義文字列を追加します。 マークは、プロファイラー レポートおよびデータ ビューでデータをフィルター処理するために使用できます。 次に示す VSPerfCmd のオプションの組み合わせにより、データ収集を開始および停止します。 個別のコマンド ラインで各オプションを指定します。 データ収集のオンとオフは複数回切り替えることができます。

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

プロファイル セッションを終了するには、プロファイラーがデータ収集を停止している必要があります。 サービスを停止するか VSPerfCmd \/detach オプションを呼び出すことによって、同時実行メソッドを使用してプロファイリングが実行されているアプリケーションからのデータ収集を停止できます。 次に、VSPerfCmd \/shutdown オプションを呼び出して、プロファイラーをオフにし、プロファイル データ ファイルを閉じます。 VSPerfClrEnv \/globaloff コマンドによってプロファイル環境変数は消去されますが、コンピューターを再起動するまでシステム構成はリセットされません。

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

  1. 対象アプリケーションからプロファイラーをデタッチするには、次のいずれかの操作を行います。

    • サービスを停止します。

      または

    • VSPerfCmd \/detach.」と入力します。

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

    VSPerfCmd Shutdown