How to: Attach the Profiler to a .NET Service to Collect Concurrency Data by Using the Command Line
This topic describes how to use Visual Studio Profiling Tools command-line tools to attach the Profiler to a .NET Framework service and collect process and thread concurrency data 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 Profiling 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 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 Profiling Tools Command Line Tools.
To collect concurrency data, you 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 no longer be attached to 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
To attach the Profiler to a .NET Framework service
Install the service.
Open a command window.
Initialize the profiling environment variables. Type:
VSPerfClrEnv/globalsampleon [/samplelineoff]
/globalsampleon enables sampling.
/samplelineoff disables the assignment of collected data to specific source code lines. When this option is specified, data is assigned only to functions.
Restart the computer.
Start the profiler. Type:
VSPerfCmd/start:concurrency **/output:**OutputFile [Options]
The /output**:**OutputFile option is required with /start. OutputFile specifies the name and location of the profiling data (.vsp) file.
You can use any of the following options with the /start option.
Note
The /user and /crosssession options are usually required for services.
Option
Description
/user:[Domain\]UserName
Specifies the domain and user name of the account that owns the profiled process. This option is required only if the process is running as a user other than the logged on user. The process owner is listed in the User Name column on the Processes tab of Windows Task Manager.
Enables profiling of processes in other sessions. This option is required if the service is running in a different session. The session id is listed in the Session ID column on the Processes tab of Windows Task Manager. /CS can be specified as an abbreviation for /crosssession.
/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. Default is 500 ms.
/events:Config
Specifies an Event Tracing for Windows (ETW) event to be collected during profiling. ETW events are collected in a separate (.etl) file.
If necessary, start the service.
Attach the profiler to the service. Type:
**VSPerfCmd /attach:PID [/targetclr:**Version]
PID specifies the process ID or process name of the service. You can view the process IDs of all running processes in Windows Task Manager.
**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
While the service is running, you can control data collection by starting and stopping the writing of data to the file by using VSPerfCmd.exe options. Controlling data collection enables you to collect data for a specific part of program execution, such as the starting or shutdown of the application.
To start and stop data collection
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
Starts (/globalon) or stops (/globaloff) data collection for all processes.
/processon:PID/processoff:PID
Starts (/processon) or stops (/processoff) data collection for the process specified by the process ID (PID).
/attach:{PID|ProcName} /detach[:{PID|ProcName}]
/attach starts to collect data for the process specified by the process ID or process name. /detach stops data collection for the specified process or for all processes if a specific process is not specified.
You can also use the VSPerfCmd.exe/mark option to insert a profiling mark into the data file. The /mark command adds an identifier, a time stamp, and an optional user-defined text string. Marks can be used to filter the data in profiler reports and data views. 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.
Ending the profiling session
To end a profiling session, the profiler must not be collecting data. You can stop collecting data from a application 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 the profiler off and close the profiling data file. 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
Do one of the following to detach the profiler from the target application.
Stop the service.
-or-
Type VSPerfCmd /detach.
Shut down the profiler. Type:
VSPerfCmd Shutdown