Partager via

How to: Attach the Profiler to a Native Service to Collect Concurrency Data by Using the Command Line

  • Article

Note

This article applies to Visual Studio 2015. If you're looking for the latest Visual Studio documentation, see Visual Studio documentation. We recommend upgrading to the latest version of Visual Studio. Download it here

This topic describes how to use the Visual Studio Profiling Tools command-line tools to attach the profiler to a native (C/C++) service and collect process and thread concurrency data by using the sampling method.

Note

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. Windows Store apps also require new collection techniques. See Performance Tools on Windows 8 and Windows Server 2012 applications.

Note

Command-line tools of the Profiling Tools are located in the \Team Tools\Performance Tools subdirectory of the Visual Studio installation directory. On 64-bit computers, both 64-bit and 32-bit versions of the tools are available. To use the profiler at a command prompt, you must add the tools path to the PATH environment variable of the Command Prompt window or to the command itself. For more information, see Specifying the Path to Command Line Tools.

While the profiler is attached to the service, you can pause and resume data collection. To end a profiling session, the Profiler must no longer be attached to the service, and the Profiler must be explicitly shut down.

Attaching the Profiler

To attach the profiler to a native service, you use the VSPerfCmd/start and /attach options to initialize the profiler and attach it to the target application. You can specify /start and /attach and their respective options on a single command line. You can also add the /globaloff option to pause data collection at the start of the target application. You then use /globalon to begin to collect data.

To attach the Profiler to a native service

  1. If the service is not running, start the service.

  2. Start the profiler by typing the following at a command prompt:

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

    • The /output:OutputFile option is required with /start. OutputFile specifies the name and the location of the profiling data (.vsp) file.

      You can use any option in the following table with the /start option.

    Note

    Most services require the /user and /crosssession option.

    Option Description
    /user :[Domain\]UserName Specifies the optional domain and user name of the account to be granted access to the profiler.
    /crosssession Enables profiling of processes in other logon sessions.
    /wincounter : WinCounterPath Specifies a Windows performance counter to be collected during profiling.
    /automark : Interval Use with /wincounter only. Specifies the number of milliseconds between Windows performance counter collection events. The default value is 500.
    /events : Config Specifies an Event Tracing for Windows (ETW) event to be collected during profiling. ETW events are collected in a separate (.etl) file.

  3. Attach the profiler to the service by typing the following command at a command prompt:

    VSPerfCmd /attach: PID

    PID specifies the process ID or process name of the target application. You can view the process IDs of all running processes in Windows Task Manager.

Controlling Data Collection

While the target application is running, you can control data collection by starting and stopping the writing of data to the file with VSPerfCmd.exe options. By controlling data collection, you can collect data for a specific part of program execution, such as the starting or shutting down of the application.

To start and stop data collection

  • The pairs of options in the following table 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 Starts (/globalon) or stops (/globaloff) data collection for all processes.
    /processon : PID /processoff : PID Starts (/processon) or stops (/processoff) data collection for the process that the process ID (PID) specifies.
    /attach :{PID|ProcName} /detach[:{PID|ProcName}] /attach starts to collect data for the process that the process ID (PID) or process name (ProcName) specifies. /detach stops data collection for the specified process or for all processes if no process is specified.

Ending the profiling session

To end a profiling session, the profiler must not be collecting data. You can stop collecting data from a native service that is being profiled with the concurrency method by stopping the service or by invoking the VSPerfCmd /detach option. You then invoke the VSPerfCmd /shutdown option to turn off the profiler and close the profiling data file.

To end a profiling session

  1. Detach the profiler from the target application by stopping the service or by typing the following command at a command prompt:

    Type VSPerfCmd /detach

  2. Shut down the profiler by typing the following command at a command prompt:

    VSPerfCmd /shutdown