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

ここでは、Visual StudioVisual Studio プロファイリング ツールのコマンド ライン ツールを使用して .NET Framework.NET Framework サービスをインストルメントし、メモリ使用量データを収集する方法について説明します。This topic describes how to use Visual StudioVisual Studio Profiling Tools command-line tools to instrument a .NET Framework.NET Framework service and collect memory usage data. メモリ割り当てデータを収集することも、メモリ割り当てデータとオブジェクト有効期間データの両方を収集することもできます。You can collect memory allocation data, or you can collect both memory allocation and object lifetime data.

注意

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.

注意

コンピューターの起動後にサービスを再起動できない場合、インストルメンテーション メソッドを使用してサービスをプロファイリングすることはできません。このようなサービスが起動されるのは、オペレーティング システムの起動時です。You cannot profile a service with the instrumentation method if the service cannot be restarted after the computer starts, such a service that start when the operating system starts.

プロファイリング ツールのコマンド ライン ツールは、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.

プロファイル セッションの開始Starting the Profiling Session

.NET Framework.NET Framework サービスからパフォーマンス データを収集するには、VSPerfCLREnv.cmd ツールを使用して適切な環境変数を初期化し、VSInstr.exe ツールを使用してサービス バイナリ ファイルのインストルメントされたコピーを作成します。To collect performance data from a .NET Framework.NET Framework service, you use the VSPerfCLREnv.cmd tool to initialize the appropriate environment variables and the VSInstr.exe tool to create an instrumented copy of the service binary file.

サービスをホストするコンピューターをプロファイリング用に構成するには再起動が必要です。The computer that hosts the service must be restarted to configure it for profiling. サービス コントロール マネージャーからサービスを手動で起動することも必要です。You must also start the service manually from the Service Control Manager. その後、プロファイラーを起動し、.NET Framework.NET Framework サービスを起動します。You then start the profiler, and then start the .NET Framework.NET Framework service.

インストルメントされたコンポーネントを実行すると、メモリ データがデータ ファイルに自動的に収集されます。When the instrumented component is executed, memory data is automatically collected to a data file. プロファイル セッション中にデータ収集を一時停止および再開できます。You can pause and resume data collection during the profiling session.

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

.NET Framework サービスのプロファイリングを開始するにはTo begin profiling a .NET Framework service

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

  2. VSInstr ツールを使用して、サービス バイナリのインストルメントされたバージョンを生成します。Use the VSInstr tool to generate an instrumented version of the service binary.

  3. サービス コントロール マネージャーを使用して、元のバイナリをインストルメントされたバージョンに置き換えます。Use Service Control Manager to replace the original binary with the instrumented version. サービスの [スタートアップの種類] が [手動] に設定されていることを確認します。Make sure that the service Startup Type is set to Manual.

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

    VSPerfClrEnv {/globaltracegc | /globaltracegclife}VSPerfClrEnv {/globaltracegc | /globaltracegclife}

    • /globaltracegc および /globaltracegclife を使用すると、メモリの割り当てデータとオブジェクトの有効期間データを収集できます。/globaltracegc and /globaltracegclife enable the collection of memory allocation and object lifetime data.

      オプションOption 説明Description
      /globaltracegc/globaltracegc メモリの割り当てデータのみを収集します。Collects memory allocation data only.
      /globaltracegclife/globaltracegclife メモリの割り当ておよびオブジェクトの有効期間データを収集します。Collects memory allocation and object lifetime data.
  5. コンピューターを再起動します。Restart the computer.

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

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

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

    • /start: contention オプションによってプロファイラーが初期化されます。The /start: contention 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 オプションを使用する場合は、次のうちいずれかのオプションを指定できます。You can use any 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 ASP.NET ワーカー プロセスを所有するアカウントのドメインおよびユーザー名を指定します。Specifies the domain and user name of the account that owns the ASP.NET worker 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.
    /waitstart[:Interval]/waitstart[:Interval] プロファイラーがエラーを返すまでプロファイラーの初期化を待機する秒数を指定します。Specifies the number of seconds to wait for the profiler to initialize before it returns an error. Interval を指定しなかった場合、プロファイラーは無期限に待機します。If Interval is not specified, the profiler waits indefinitely. 既定では、/start が直ちに返されます。By default, /start returns immediately.
    /globaloff/globaloff データ収集を一時停止してプロファイラーを起動するには、/globaloff オプションを /start コマンド ラインに追加します。To start the profiler with data collection paused, add the /globaloff option to the /start command line. プロファイリングを再開するには、/globalon を使用します。Use /globalon to resume profiling.
    /counter : Config/counter : Config Config で指定されたプロセッサのパフォーマンス カウンターから情報を収集します。カウンター情報は、プロファイル イベントが発生するたびに、収集されたデータに追加されます。Collects information from the processor performance counter specified in Config. Counter information is added to the data collected at each profiling event.
    /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. 起動の必要なサービスがあれば起動します。If necessary, start the service.

  9. プロファイラーをサービスにアタッチします。Attach the profiler to the service. 種類:Type:

    VSPerfCmd /attach: PID|ProcessNameVSPerfCmd /attach: PID|ProcessName

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

データ収集の制御Controlling Data Collection

サービスの実行中は、VSPerfCmd.exe のオプションを使用してファイルへのデータ書き込みを開始または停止することにより、データ収集を制御できます。While the service is running, you can control data collection by starting and stopping the writing of data to the file with VSPerfCmd.exe options. データ コレクションを制御することにより、アプリケーションの起動や終了など、プログラム実行の特定の部分についてのデータ コレクションを行うことができます。Controlling data collection enables you to collect data for a specific part of 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).
    /threadon : TID /threadoff : TID/threadon : TID /threadoff : TID スレッド ID (TID) で指定されたスレッドのデータ収集を開始 (/threadon) または停止 (/threadoff) します。Starts (/threadon) or stops (/threadoff) data collection for the thread specified by the thread ID (TID).

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

プロファイル セッションを終了するには、インストルメントされたコンポーネントを実行しているアプリケーションを終了し、VSPerfCmd /shutdown オプションを開始してプロファイラーをオフにした後、プロファイル データ ファイルを閉じます。To end a profiling session, close the application that is running the instrumented component, then start 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.

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

  1. サービス コントロール マネージャーからサービスを停止します。Stop the service from Service Control Manager.

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

    VSPerfCmd /shutdownVSPerfCmd /shutdown

  3. すべてのプロファイリングを完了したら、プロファイル環境変数を消去します。When you have completed all profiling, clear the profiling environment variables. 種類:Type:

    VSPerfClrEnv /globaloffVSPerfClrEnv /globaloff

    インストルメントされたモジュールを元のモジュールに置き換えます。Replace the instrumented module with the original. 必要に応じて、サービスの [スタートアップの種類] を再構成します。If necessary, reconfigure the Startup Type of the service.

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

関連項目See Also

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