How to: Instrument a Statically Compiled ASP.NET Web Application and Collect Detailed Timing Data with the Profiler by Using the Command Line
This topic describes how to use Visual Studio Profiling Tools command-line tools to instrument a precompiled ASP.NET Web component or Web site and collect detailed timing data.
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 detailed timing data from a ASP.NET Web component by using the instrumentation method, you use the VSInstr.exe tool to generate an instrumented version of the component. On the computer that hosts the component, you replace the noninstrumented version of the component with the instrumented version. You then use the VSPerfCLREnv.cmd tool to initialize the global profiling environment variables and restart the host computer. You then start the profiler.
When the instrumented component is executed, timing 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 ASP.NET worker process that hosts the component and then explicitly shut down the profiler. In most cases, we recommend clearing the profiling environment variables at the end of a session.
Starting to Profile
To instrument an ASP.NET Web component and start profiling
Open a Command Prompt window.
Use the VSInstr tool to generate an instrumented version of the target application. If necessary, replace the application binaries on the ASP.NET host computer with the instrumented binaries.
Initialize the .NET profiling environment variables. In the Command Prompt window, type:
VSPerfClrEnv /globaltraceon
Restart the computer.
Open a Command Prompt window. If necessary, set the profiler tools path.
Start the profiler. Type:
**VSPerfCmd /start:trace /output:**OutputFile [Options]
The /start:trace option initializes the profiler.
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:trace option.
Note
The /user and /crosssession options are usually required for ASP.NET applications.
Option
Description
/user:[Domain\]UserName
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. The process owner is listed in the User Name column on the Processes tab of Windows Task Manager.
Enables profiling of processes in other logon sessions. This option is required if the ASP.NET application is running in a different session. The session idenitifier 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.
To start the profiler with data collection paused, add the /globaloff option to the /start command line. Use /globalon to resume profiling.
Open the Web site that contains the instrumented component.
Controlling Data Collection
When the target application 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 starting or shutting down the application.
To start and stop data collection
The following pairs of 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).
/threadon:TID /threadoff:TID
Starts (/threadon) or stops (/threadoff) data collection for the thread specified by the thread ID (TID).
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.
Ending the Profiling Session
To end a profiling session, close the ASP.NET Web application, and then use the Internet Information Services (IIS) IISReset command to close the ASP.NET worker process. Call the VSPerfCmd /shutdown option to turn off the profiler and close the profiling data file.
The VSPerfClrEnv /globaloff command clears the profiling environment variables. You must restart the computer for the new environment settings to be applied.
To end a profiling session
Close the ASP.NET Web application.
Close the ASP.NET worker process. Type:
IISReset /stop
Shut down the profiler. Type:
VSPerfCmd /shutdown
(Optional). Clear the profiling environment variables. Type:
VSPerfCmd /globaloff
Restart the computer.
See Also
Concepts
Command-Line Profiling of ASP.NET Web Applications