Start-SbecLogSession

Starts an ETW log session.

Syntax

Start-SbecLogSession
     [-Name] <String>
     [[-Path] <String>]
     [[-SessionGuid] <Guid>]
     [[-ProviderName] <String[]>]
     [[-ProviderGuid] <Guid[]>]
     [[-Level] <SeverityLevel>]
     [[-ClockType] <ClientContext>]
     [[-BufferSize] <UInt32>]
     [[-MinimumBufferCount] <UInt32>]
     [[-MaximumBufferCount] <UInt32>]
     [[-MaximumFileSize] <UInt32>]
     [[-FlushSeconds] <UInt32>]
     [[-LogFileMode] <LoggingMode>]
     [[-KernelEnableFlags] <EventTraceFlag>]
     [-PassThru]
     [[-SimulateCreationError] <Int32>]
     [[-SimulateSubscriptionError] <Int32>]
     [<CommonParameters>]

Description

The Start-SbecLogSession cmdlet starts an Event Tracing for Windows (ETW) log session with full flexibility.

To start an ETW session in a simpler way with fewer parameters, use the Start-SbecSimpleLogSession cmdlet.

Required Parameters

-Name

Specifies the name of the session to start.

Type:String
Position:0
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-BufferSize

Specifies the buffer size for the session, in kilobytes. This is the size of one buffer, with the count of these buffers set by the MinimumBufferCount and MaximumBufferCount parameters.

Type:UInt32
Position:7
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ClockType

Specifies the type of clock used for the events collected by this session: The acceptable values for this parameter are:

  • Default
  • QueryPerformanceCounter. The high-resolution (period of 100 nanoseconds) clock that is typically used for performance measurement.
  • SystemTime. The lower-resolution system time similar to FILETIME (period of 10 milliseconds). This value is most typical for the data collection through SBEC.
  • CpuCycleCounter. The highest-resolution, with the frequency of the CPU, but may be unreliable depending on the CPU model and the thermal and power modes.
Type:ClientContext
Parameter Sets:Default, QueryPerformanceCounter, SystemTime, CpuCycleCounter
Position:6
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-FlushSeconds

Specifies the timeout, in seconds, for the session buffers to automatically flush. You can disable the flushing of buffers on timeout by setting this parameter to 0, then the buffers will be written only when full or on an explicit flush.

Type:UInt32
Aliases:FlushTimer
Position:11
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-KernelEnableFlags

Specifies flags for the NT Kernel Logger that enable the kernel events. For the setup and boot monitoring, the only reasonable flag is Process. This enumeration type is defined in $PsHome\Modules\BootEventCollector\SbecTraceHelpers.psm1. The acceptable values for this parameter are:

  • Process
  • Thread
  • ImageLoad
  • ProcessCounters
  • ContextSwitch
  • Dpc
  • Interrupt
  • SystemCall
  • DiskIO
  • DiskFileIO
  • DiskIOInit
  • Dispatcher
  • MemoryPageFaults
  • MemoryHardFaults
  • VirtualAlloc
  • NetworkTCPIP
  • Registry
  • Alpc
  • SplitIO
  • Driver
  • FileIO
  • FileIOInit
  • Profile
Type:EventTraceFlag
Parameter Sets:None, Process, Thread, ImageLoad, ProcessCounters, ContextSwitch, Dpc, Interrupt, SystemCall, DiskIO, DiskFileIO, DiskIOInit, Dispatcher, MemoryPageFaults, MemoryHardFaults, VirtualAlloc, NetworkTCPIP, Registry, Alpc, SplitIO, Driver, FileIO, FileIOInit, Profile
Position:13
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Level

Specifies the highest detail level value to enable for providers. This enumeration type is defined in $PsHome\Modules\BootEventCollector\SbecTraceHelpers.psm1. The acceptable values for this parameter are:

  • Undefined
  • Fatal
  • Error
  • Warning
  • Information
  • Verbose
  • All
Type:SeverityLevel
Parameter Sets:Undefined, Fatal, Error, Warning, Information, Verbose, All
Position:5
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-LogFileMode

Specifies the new flags for the log file mode. The EnableKd and DisableKd values parameters are applied on top of these flags. This enumeration type is defined in $PsHome\Modules\BootEventCollector\SbecTraceHelpers.psm1. The cmdlet automatically adds the RealTime and KdFilter values to this parameter. Commonly used values are:

  • FileSequential. Write events to a log file sequentially; stops when the file reaches its maximum size.
  • FileCircular. Write events to a log file. After the file reaches the maximum size, replace the oldest events with incoming events.
  • FileAppend. Append events to an existing sequential log file.
  • FileNewFile. Automatically switch to a new log file when the file reaches the maximum size.
  • FilePreallocate. Reserve the MaximumFileSize of disk space for the log files in advance.
  • Secure. Restrict who can log events to the session to those with TRACELOG_LOG_EVENT permission.
  • RealTime. Deliver the events to consumers in real-time instead of writing them to a file. This mode is required for sending the events to the event collector.
  • KdFilter. Forward the events though the kernel channel to the event collector or to the debugger.
  • UsePagedMemory. Use the paged memory for the buffers.
  • NoPerProcessorBuffering. Write the events from all processors to the same buffer. This preserves the order of the events, and is recommended for sending the events to the event collector.

The acceptable values for this parameter are:

  • None
  • FileNone
  • FileSequential
  • FileCircular
  • FileAppend
  • FileNewFile
  • Reserved0x00000010
  • FilePreallocate
  • Nonstoppable
  • Secure
  • RealTime
  • DelayOpenFile
  • Buffering
  • PrivateLogger
  • AddHeader
  • UseKilobytesForSize
  • UseGobalSequence
  • Relog
  • PrivateInProc
  • BufferInterface
  • KdFilter
  • RealtimeRelog
  • LostEventsDebug
  • StopOnHybridShutdown
  • PersistOnHybridShutdown
  • UsePagedMemory
  • SystemLogger
  • Compressed
  • IndependentSession
  • NoPerProcessorBuffering
  • Blocking
  • Reserved0x40000000
  • AddToTriageDump
Type:LoggingMode
Parameter Sets:None, FileNone, FileSequential, FileCircular, FileAppend, FileNewFile, Reserved0x00000010, FilePreallocate, Nonstoppable, Secure, RealTime, DelayOpenFile, Buffering, PrivateLogger, AddHeader, UseKilobytesForSize, UseGobalSequence, UseLocalSequence, Relog, PrivateInProc, BufferInterface, KdFilter, RealtimeRelog, LostEventsDebug, StopOnHybridShutdown, PersistOnHybridShutdown, UsePagedMemory, SystemLogger, Compressed, IndependentSession, NoPerProcessorBuffering, Blocking, Reserved0x40000000, AddToTriageDump
Position:12
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MaximumBufferCount

Specifies the maximum number of buffers to allocate for this session.

Type:UInt32
Aliases:MaximumBuffers, maxbuf
Position:9
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MaximumFileSize

Specifies the maximum file size after which the session may switch to the next file, in megabytes. Specify 0 for no limit.

Type:UInt32
Position:10
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MinimumBufferCount

Specifies the minimum number of buffers to allocate for this session.

Type:UInt32
Aliases:MinimumBuffers, minbuf
Position:8
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the ETL file where the session will write its log. The session must have the file mode enabled to write to a file; a session in real-time mode ignores the file.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProviderGuid

Specifies the provider GUIDs to subscribe this session to. The providers are configured to include all events up to the level specified by the Level parameter.

Type:Guid[]
Aliases:pg
Position:4
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProviderName

Specifies the provider names to subscribe this session to. The providers are configured to include all events up to the level specified by the Level parameter

Type:String[]
Aliases:pn
Position:3
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SessionGuid

Specifies the GUID for the session.

Type:Guid
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SimulateCreationError

Simulates a Windows error in session creation, and causes the function to throw an error. You can specify this parameter to test error handling.

Type:Int32
Position:14
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SimulateSubscriptionError

Simulates a Windows error in session subscription, and causes the function to throw an error. You can specify this parameter to test error handling.

Type:Int32
Position:15
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Outputs

SbecEtwTrace.TraceSessionInfo

The class is defined in $PsHome\Modules\BootEventCollector\SbecTraceHelpers.psm1.