方法: コマンド ラインを使用してプロファイラーを .NET サービスにアタッチし、メモリ データを収集するHow to: Attach the Profiler to a .NET Service to Collect Memory Data by Using the Command Line

ここでは、Visual StudioVisual Studio プロファイリング ツールのコマンド ライン ツールを使用してプロファイラーを .NET Framework.NET Framework サービスにアタッチし、メモリ データを収集する方法について説明します。This topic describes how to use Visual StudioVisual Studio Profiling Tools command-line tools to attach the profiler to a .NET Framework.NET Framework service and collect memory data. メモリ割り当ての数およびサイズに関するデータだけでなく、メモリ オブジェクトの有効期間に関するデータも収集できます。You can collect data about the number and size of memory allocations, and you can also collect data about the lifetime of memory objects.

注意

Windows 8 および Windows Server 2012 の強化されたセキュリティ機能によって、Visual Studio プロファイラーがこれらのプラットフォームでデータを収集する方法に大幅な変更が必要になりました。Enhanced security features in Windows 8 and Windows Server 2012 required significant changes in the way the Visual Studio profiler collects data on these platforms. UWP アプリにも新しい収集手法が必要です。UWP apps also require new collection techniques. Performance Tools on Windows 8 and Windows Server 2012 applications (Windows 8 および Windows Server 2012 アプリケーションのパフォーマンス ツール)」をご覧ください。See Performance Tools on Windows 8 and Windows Server 2012 applications.

注意

プロファイリング ツールのコマンド ライン ツールは、Visual StudioVisual Studio インストール ディレクトリの \Team Tools\Performance Tools サブディレクトリにあります。Command-line tools of the Profiling Tools are located in the \Team Tools\Performance Tools subdirectory of the Visual StudioVisual Studio installation directory. 64 ビット コンピューター上では、64 ビット バージョンのツールと 32 ビット バージョンのツールの両方を使用できます。On 64 bit computers, both 64 bit and 32 bit versions of the tools are available. プロファイラー コマンド ライン ツールを使用するには、コマンド プロンプト ウィンドウの PATH 環境変数にツールのパスを追加するか、コマンド自体にそれを追加します。To use the profiler command-line tools, you must add the tools path to the PATH environment variable of the command prompt window or add it to the command itself. 詳細については、「コマンド ライン ツールへのパスの指定」をご覧ください。For more information, see Specifying the Path to Command Line Tools.

.NET Framework.NET Framework サービスからメモリ データを収集するには、VSPerfCLREnv.cmd ツールを使用して、サービスをホストするコンピューター上で該当する環境変数を初期化する必要があります。To collect memory data from a .NET Framework.NET Framework service, you use the VSPerfCLREnv.cmd tool to initialize the appropriate environment variables on the computer that hosts the service. コンピューターをプロファイリング用に構成するには再起動が必要です。The computer must be restarted to configure it for profiling.

次に、VSPerfCmd ツールを使用してプロファイラーをサービス プロセスにアタッチします。You then use the VSPerfCmd tool to attach the profiler to the service process. プロファイラーをサービスにアタッチしている間はデータ コレクションを一時停止し、完了後に再開できます。While the profiler is attached to the service, you can pause and resume data collection.

プロファイル セッションを終了するには、プロファイラーをサービスからデタッチし、プロファイラーを明示的に終了する必要があります。To end a profiling session, the profiler must be detached from the service and the profiler must be explicitly shut down. ほとんどの場合、セッションの最後にプロファイル環境変数を消去することをお勧めします。In most cases, we recommend clearing the profiling environment variables at the end of a session.

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

プロファイラーを .NET Framework サービスにアタッチするにはTo attach the Profiler to a .NET Framework service

  1. インストールの必要なサービスがあればインストールします。If necessary, install the service.

  2. コマンド プロンプト ウィンドウを開きます。Open a command prompt window.

  3. プロファイル環境変数を初期化します。Initialize the profiling environment variables. 種類:Type:

    VSPerfClrEnv {/globalsamplegc /globalsamplegclife}[/samplelineoff]VSPerfClrEnv {/globalsamplegc /globalsamplegclife}[/samplelineoff]

    • オプションの /globalsamplegclife/globalsamplegclife では、収集するメモリ データの型を指定します。The options /globalsamplegclife and /globalsamplegclife specify the type of memory data to collect. 次のいずれかのオプションを 1 つのみ指定します。Specify one and only one of the following options.

      /globalsamplegc/globalsamplegc
      メモリの割り当てデータを収集できます。Enables the collection of memory allocation data.

      /globalsamplegclife/globalsamplegclife
      メモリの割り当てデータとオブジェクトの有効期間データを収集できます。Enables the collection of both memory allocation data and object lifetime data.

    • /samplelineoff オプションを指定すると、ソース コードの行番号データの収集が無効になります。The /samplelineoff option disables the collection of source code line number data.

  4. コンピューターを再起動して、新しい環境構成を設定します。Restart the computer to set the new environment configuration.

  5. 起動の必要なサービスがあれば起動します。If necessary, start the service.

  6. コマンド プロンプト ウィンドウを開きます。Open a command prompt window. 必要に応じて、プロファイラー パスを PATH 環境変数に追加します。If necessary, add the profiler path to the PATH environment variable.

  7. プロファイラーを起動します。Start the profiler. 種類:Type:

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

    • /start:sample オプションによってプロファイラーが初期化されます。The /start:sample option initializes the profiler.

    • /start を使用するには、/output:OutputFile オプションを指定する必要があります。The /output:OutputFile option is required with /start. OutputFile には、プロファイル データ (.vsp) ファイルの名前と場所を指定します。OutputFile specifies the name and location of the profiling data (.vsp) file.

      /start:sample オプションを使用する場合は、次の 1 つ以上のオプションを指定できます。You can use one or more of the following options with the /start:sample option.

    注意

    /user オプションと /crosssession オプションは、通常、サービスで必要です。The /user and /crosssession options are usually required for services.

    オプションOption 説明Description
    /user :[Domain\]UserName/user :[Domain\]UserName プロセスを所有するアカウントのドメインおよびユーザー名を指定します。Specifies the domain and user name of the account that owns the process. このオプションは、ログオンしているユーザーとは別のユーザーがプロセスを実行している場合に指定する必要があります。This option is required if the process is running as a user other than the logged on user. プロセスの所有者は、Windows タスク マネージャーの [プロセス] タブの [ユーザー名] 列に表示されます。The process owner is listed in the User Name column on the Processes tab of Windows Task Manager.
    /crosssession/crosssession 他のログオン セッションにおけるプロセスのプロファイリングを有効にします。Enables profiling of processes in other logon sessions. このオプションは、ASP.NET アプリケーションが別のセッションで実行されている場合に必要です。This option is required if the ASP.NET application is running in a different session. セッション ID は、Windows タスク マネージャーの [プロセス] タブの [セッション ID] 列に表示されます。The session id is listed in the Session ID column on the Processes tab of Windows Task Manager. /crosssession の省略形として、/CS を指定することができます。/CS can be specified as an abbreviation for /crosssession.
    /user :[Domain\]UserName/user :[Domain\]UserName サービスが実行されるログオン アカウントのドメインおよびユーザー名を指定します (省略可能)。Specifies the optional domain and user name of the logon account under which the service runs. ログオン アカウントは、Windows サービス コントロール マネージャーのサービスの [ログオン方法] 列に表示されます。The logon account is listed in the Log On As column of the service in the Windows Service Control Manager.
    /crosssession|cs/crosssession|cs 他のログオン セッションにおけるプロセスのプロファイリングを有効にします。Enables profiling of processes in other logon sessions.
    /wincounter : WinCounterPath/wincounter : WinCounterPath プロファイリング実行中に収集する Windows パフォーマンス カウンターを指定します。Specifies a Windows performance counter to be collected during profiling.
    /automark : Interval/automark : Interval /wincounter との組み合わせでのみ使用します。Use with /wincounter only. Windows パフォーマンス カウンター コレクション イベントの間隔をミリ秒単位で指定します。Specifies the number of milliseconds between Windows performance counter collection events. 既定値は 500 ミリ秒です。Default is 500 ms.
    /events : Config/events : Config プロファイリング実行中に収集する ETW (Event Tracing for Windows) イベントを指定します。Specifies an Event Tracing for Windows (ETW) event to be collected during profiling. ETW イベントは独立した (.etl) ファイルに収集されます。ETW events are collected in a separate (.etl) file.
  8. プロファイラーをサービスにアタッチします。Attach the profiler to the service. 種類:Type:

    VSPerfCmd /attach :{PID|ProcName} [/targetclr:Version]VSPerfCmd /attach :{PID|ProcName} [/targetclr:Version]

    • サービスのプロセス ID またはプロセス名を指定します。Specify either the process ID or the process name of the service. Windows タスク マネージャーで、実行中のすべてのプロセスのプロセス ID と名前を参照できます。You can view the process IDs and names of all running processes in Windows Task Manager.

    • targetclr: Version には、アプリケーションに複数のバージョンのランタイムが読み込まれている場合に、プロファイリングを行う共通言語ランタイム (CLR: Common Language Runtime) のバージョンを指定します。targetclr: Version specifies the version of the common language runtime (CLR) to profile when more than one version of the runtime is loaded in an application. 省略可能です。Optional.

データ収集の制御Controlling Data Collection

サービスの実行中に、VSPerfCmd.exe のオプションを使用して、プロファイラー データ ファイルへのデータ書き込みを停止または開始できます。While the service is running, you can use VSPerfCmd.exe options to stop and start the writing of data to the profiler data file. データ コレクションを制御することにより、アプリケーションの起動や終了など、プログラム実行の特定の部分についてのデータ コレクションを行うことができます。Controlling data collection enables you to collect data for a specific part of the program execution, such as starting or shutting down the application.

データ収集を開始および停止するにはTo start and stop data collection

  • 次に示す VSPerfCmd のオプションの組み合わせにより、データ収集を開始および停止します。The following pairs of VSPerfCmd options start and stop data collection. 個別のコマンド ラインで各オプションを指定します。Specify each option on a separate command line. データ収集のオンとオフは複数回切り替えることができます。You can turn data collection on and off multiple times.

    オプションOption 説明Description
    /globalon /globaloff/globalon /globaloff すべてのプロセスのデータ収集を開始 (/globalon) または停止 (/globaloff) します。Starts (/globalon) or stops (/globaloff) data collection for all processes.
    /processon : PID /processoff : PID/processon : PID /processoff : PID プロセス ID (PID) で指定されたプロセスのデータ コレクションを開始 (/processon) または停止 (/processoff) します。Starts (/processon) or stops (/processoff) data collection for the process specified by the process ID (PID).
    /attach:{PID|ProcName} /detach[:{PID|ProcName}]/attach:{PID|ProcName} /detach[:{PID|ProcName}] /attach は、プロセス ID またはプロセス名で指定したプロセスのデータ収集を開始します。/attach starts to collect data for the process specified by the process ID or process name. /detach は、指定されたプロセスのデータ収集を停止します。特定のプロセスが指定されていない場合は、すべてのプロセスのデータ収集を停止します。/detach stops data collection for the specified process, or for all processes if a specific process is not specified.

プロファイル セッションの終了Ending the Profiling Session

プロファイル セッションを終了するには、プロファイラーがデータ収集を停止している必要があります。To end a profiling session, the profiler must not be collecting data. サービスを停止するか VSPerfCmd /detach オプションを呼び出すことによって、サンプリング メソッドを使用してプロファイリングが実行されているアプリケーションからのデータ コレクションを停止できます。You can stop the collection of data from an application profiled with the sampling method by stopping the service or by calling the VSPerfCmd /detach option. 次に、VSPerfCmd /shutdown オプションを呼び出して、プロファイラーをオフにし、プロファイル データ ファイルを閉じます。You then call the VSPerfCmd /shutdown option to turn the profiler off and close the profiling data file. VSPerfClrEnv /globaloff コマンドによってプロファイル環境変数は消去されますが、コンピューターを再起動するまでシステム構成はリセットされません。The VSPerfClrEnv /globaloff command clears the profiling environment variables, but the system configuration is not reset until the computer is restarted.

プロファイル セッションを終了するにはTo end a profiling session

  1. 対象アプリケーションからプロファイラーをデタッチするには、次のいずれかの操作を行います。Do one of the following to detach the profiler from the target application:

    • サービスを停止します。Stop the service.

      または-or-

    • VSPerfCmd /detach と入力しますType VSPerfCmd /detach

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

    VSPerfCmd /shutdownVSPerfCmd /shutdown

  3. (省略可能) プロファイル環境変数を削除します。(Optional) Clear the profiling environment variables. 種類:Type:

    VSPerfClrEnv /globaloffVSPerfClrEnv /globaloff

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

関連項目See Also

サービスのプロファイリング Profiling Services
.NET メモリのデータ ビュー.NET Memory Data Views