Skip to content

Commit bc381a6

Browse files
Update vcperf-commands.md (#4375)
* Update vcperf-commands.md Update commands according to https://github.com/microsoft/vcperf#command-line-reference * Update vcperf-commands.md * Update with grammar fixes for i18n --------- Co-authored-by: Colin Robertson <[email protected]>
1 parent a3a8ad1 commit bc381a6

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/build-insights/reference/vcperf-commands.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,23 +18,23 @@ This article lists and describes the commands available in *`vcperf.exe`*, and h
1818
## Commands to start and stop traces
1919

2020
> [!IMPORTANT]
21-
> The following commands all require administrative privileges.
21+
> Unless you specify `/noadmin`, the following commands require administrative privileges.
2222
2323
| Option | Arguments and description |
2424
|------------------|---------------------------|
25-
| `/start` | `[/nocpusampling]` `<sessionName>` |
26-
| | Tells *vcperf.exe* to start a trace under the given session name. There can only be one active session at a time on a given machine. <br/><br/> If the `/nocpusampling` option is specified, *vcperf.exe* doesn't collect CPU samples. It prevents the use of the CPU Usage (Sampled) view in Windows Performance Analyzer, but makes the collected traces smaller. <br/><br/> Once tracing is started, *vcperf.exe* returns immediately. Events are collected system-wide for all processes running on the machine. That means that you don't need to build your project from the same command prompt as the one you used to run *vcperf.exe*. For example, you can build your project from Visual Studio. |
27-
| `/stop` | `<sessionName>` `<outputFile.etl>` |
28-
| | Stops the trace identified by the given session name. Runs a post-processing step on the trace to generate a file viewable in Windows Performance Analyzer (WPA). For the best viewing experience, use a version of WPA that includes the C++ Build Insights add-in. For more information, see [Get started with C++ Build Insights](../get-started-with-cpp-build-insights.md). The `<outputFile.etl>` parameter specifies where to save the output file. |
29-
| `/stopnoanalyze` | `<sessionName>` `<rawOutputFile.etl>` |
30-
| | Stops the trace identified by the given session name and writes the raw, unprocessed data in the specified output file. The resulting file isn't meant to be viewed in WPA. <br/><br/> The post-processing step involved in the `/stop` command can sometimes be lengthy. You can use the `/stopnoanalyze` command to delay this post-processing step. Use the `/analyze` command when you're ready to produce a file viewable in Windows Performance Analyzer. |
25+
| `/start` | [`/noadmin`] [`/nocpusampling`] [`/level1` \| `/level2` \| `/level3`] `<sessionName>` |
26+
| | Starts a trace under the given session name. <br/><br/> The `/noadmin` option runs *vcperf.exe* without admin privileges, and it ignores the `/nocpusampling` option. When you run vcperf without admin privileges, there can be more than one active session on a given machine. <br/><br/> The `/nocpusampling` option specifies *vcperf.exe* doesn't collect CPU samples. It prevents the use of the CPU Usage (Sampled) view in Windows Performance Analyzer, but makes the collected traces smaller. <br/><br/> The `/level1`, `/level2`, or `/level3` options specify which MSVC events to collect, in increasing level of information. Level 3 includes all events. Level 2 includes all events except template instantiation events. Level 1 includes all events except template instantiation, function, and file events. If unspecified, `/level2` is selected by default. <br/><br/> Once *vcperf.exe* starts the trace, it returns immediately. The trace collects events system-wide for all processes running on the machine. That means that you don't need to build your project in the same command prompt window as the one you use to run *vcperf.exe*. For example, you can build your project in Visual Studio. |
27+
| `/stop` | (1) [`/templates`] `<sessionName> <outputFile.etl>` <br/> (2) [`/templates`] `<sessionName> /timetrace <outputFile.json>` |
28+
| | Stops the trace identified by the given session name. Runs a post-processing step on the trace to generate a file specified by the `<outputFile>` parameter. <br/><br/> The `/templates` option includes template instantiation events in the file. <br/><br/> (1) Generates a file viewable in Windows Performance Analyzer (WPA). The output file requires a `.etl` extension.<br/>(2) Generates a file viewable in the Microsoft Edge trace viewer (`edge://tracing`). The output file requires a `.json` extension. |
29+
| `/stopnoanalyze` | `<sessionName> <rawOutputFile.etl>` |
30+
| | Stops the trace identified by the given session name and writes the raw, unprocessed data in the specified output file. The resulting file isn't meant for viewing in WPA. <br/><br/> The post-processing step involved in the `/stop` command can sometimes be lengthy. You can use the `/stopnoanalyze` command to delay this post-processing step. Use the `/analyze` command when you're ready to produce a file viewable in Windows Performance Analyzer or the Microsoft Edge trace viewer. |
3131

3232
## Miscellaneous commands
3333

3434
| Option | Arguments and description |
3535
|------------|---------------------------|
36-
| `/analyze` | `<rawInputFile.etl> <outputFile.etl>` |
37-
| | Accepts a raw trace file produced by the `/stopnoanalyze` command. Runs a post-processing step on this trace to generate a file viewable in Windows Performance Analyzer. For the best viewing experience, use a version of WPA that includes the C++ Build Insights add-in. For more information, see [Get started with C++ Build Insights](../get-started-with-cpp-build-insights.md). |
36+
| `/analyze` | (1) [`/templates`] `<rawInputFile.etl> <outputFile.etl>` <br/>(2) [`/templates`] `<rawInputFile.etl> /timetrace <outputFile.json>` |
37+
| | Accepts a raw trace file produced by the `/stopnoanalyze` command. Runs a post-processing step on this trace to generate the file specified by the `<outputFile>` parameter. <br/><br/> The `/templates` option includes template instantiation events in the file. <br/><br/> (1) Generates a file viewable in Windows Performance Analyzer (WPA). The output file requires a `.etl` extension. <br/><br/> (2) Generates a file viewable in the Microsoft Edge trace viewer (`edge://tracing`). The output file requires a `.json` extension. |
3838

3939
## See also
4040

0 commit comments

Comments
 (0)