Share via


start

Displays logger start options.

xperf [-start [ProfileFileName!ProfileName|SessionName]|-update [LoggerName]|[ProfileFileName!ProfileName|SessionName]] -on Flags|Groups options ...
or -flush [LoggerName] ...
or -save ProfileFileName!ProfileName|SessionName merged.etl
or -SetProfInt [<n>] [cached]
User provider format for -on: (GUID|KnownProviderName)[:Flags[:Level]]

Examples

The following table shows examples of using the logger start options.

-start LoggerName|ProfileFileName!ProfileName|SessionName
Start a logging session for LoggerName. Or start loggers in profile ProfileName defined in file ProfileFileName. Or start logger SessionName defined in file ProfileFileName.
-update LoggerName|ProfileFileName!ProfileName|SessionName
Update a logging session for LoggerName. Or update loggers in profile ProfileName defined in file ProfileFileName. Or update logger SessionName defined in file ProfileFileName.
-flush LoggerName
Flush a logging session for LoggerName.
-on Flags|Groups
For kernel logging sessions, the sequence of kernel flags and groups to be enabled, separated by '+'. For user logging sessions, the sequence of providers to be enabled, separated by '+'. The accepted provider format is: (GUID|KnownProviderName)[:Flags[:Level]]. Use "xperf -help providers" for a list of valid flags.
-BufferSize Size
Set trace buffer size to Size KB (4 KB - 1024 KB); default: 64 KB.
-MinBuffers n
Set minimum number of trace buffers to n; default: 64.
-MaxBuffers n
Set maximum number of trace buffers to n; default: 320.
-MaxFile Size
Set maximum file size to Size MB.
-FlushTimer n
Set the flush timer to n seconds.
-BootTrace Flags|Groups|off
Configure the Event Tracing For Windows Logger to trace boot. Set flags as off to turn off boot tracing. All logging control can be used in conjunction with this. Use in conjunction with -f to log to a file other than \Perf.etl.
-RealTime
Enable real time tracing.
-Buffering
Enable buffering mode tracing.
-FileMode Mode
Set the File Mode; default: Sequential. Mode: Sequential, Circular, Append, NewFile.
-ClockType ClockType
Set the clock type; default: PerfCounter.Type: Cycle, PerfCounter, SystemTime.
-StackWalk flags|@file
Enable stack walking for the events specified as Flag+Flag+..., or parse 'file' file for flags. Run "xperf -help stackwalk" for more information.
-Pids pid [...]
Apply flags to processes pid [...]. Used in conjunction with private loggers.
-PidNewProcess <command-line>
Apply flags to a new process xperf will start with <command-line>. Used in conjunction with private loggers.
-WaitForNewProcess
Wait for new process created using -pidNewProcess to return before exiting.
-heap
Enable heap tracing in processes specified by Pids and PidNewProcess.
-critsec
Enable critical section tracing in processes specified by Pids and PidNewProcess.
-SetProfInt [<n>] [cached]
Set sampled profile interval to <n> [1221 ..10000000]. If "cached" is specified, intervals are cached in ETW and reapplied whenever new ETW kernel loggers with sampled profile are started. [Default: <n> = 10000; not cached].
-save ProfileFileName!ProfileName|SessionName merged.etl
Flush the loggers in profile ProfileName defined in file ProfileFileName and merge the ETL files to merged.etl. Or flush logger SessionName defined in file ProfileFileName and merge the ETL file to merged.etl. Multiple loggers can be started using multiple -start options, each followed by the options to be applied to that logger. If LoggerName, or -start LoggerName, is omitted, the Kernel Logger is implied. Only a single instance of Kernel Logger can exist at any time. If one of the loggers fails to start, all the already started loggers are stopped.

Multiple loggers can be started using multiple -start options, each followed by the options to be applied to that logger. If LoggerName, or -start LoggerName, is omitted, the Kernel Logger is implied. Only a single instance of Kernel Logger can exist at any time. If one of the loggers fails to start, all the already started loggers are stopped.