New-EtwTraceSession

適用対象: Windows 10, Windows Server Technical Preview

New-EtwTraceSession

Creates an ETW trace session.

構文

Parameter Set: cim:CreateInstance0
New-EtwTraceSession [-Name] <String> [-BufferSize <UInt32> ] [-CimSession <CimSession[]> ] [-ClockType <ClockType> {Performance | System | Cycle} ] [-FlushTimer <UInt32> ] [-LocalFilePath <String> ] [-LogFileMode <UInt32> ] [-MaximumBuffers <UInt32> ] [-MaximumFileSize <UInt32> ] [-MinimumBuffers <UInt32> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

詳細説明

The New-EtwTraceSession cmdlet creates an Event Trace for Windows (ETW) trace session.

パラメーター

-BufferSize<UInt32>

Specifies the size, in kilobytes, of buffers. We recommend less than 1000 kilobytes. If you do not specify a value for this parameter, ETW uses the size of physical memory to calculate a default value.

-CimSession<CimSession[]>

リモート セッションまたはリモート コンピューターでコマンドレットを実行します。コンピューター名またはセッション オブジェクト (New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など) を入力します。既定値は、ローカル コンピューター上の現在のセッションです。

-ClockType<ClockType>

Specifies the timer to use for the time stamp for events. Valid values are:

-- 1: Performance. Performance counter value (high resolution)
-- 2: System. System timer
-- 3: Cycle. CPU cycle counter

The default value is Performance on computers that run Windows Vista and subsequent versions of the Windows operating system. The default value is System for previous versions of the Windows operating system.

-FlushTimer<UInt32>

Specifies the interval, in seconds, at which to flush trace buffers. The minimum value is one second. This forced flush is in addition to the automatic flush that occurs when a buffer is full and when the trace session stops.

For a real-time logger, the default value of zero means that the flush time is one second. You can configure a real-time logger by specifying a value of EVENT_TRACE_REAL_TIME_MODE for the LogFileMode parameter.

The default value is zero. By default, buffers are flushed only when they are full.

-LocalFilePath<String>

Specifies the full path for an ETW log file.

-LogFileMode<UInt32>

Specifies one or more log modes. For valid values, see Logging Mode Constants.

Specify more than one log mode, add the values of the modes. For instance, to include both EVENT_TRACE_FILE_MODE_CIRCULAR, which has a value of 0x00000002, and EVENT_TRACE_NO_PER_PROCESSOR_BUFFERING, which has a value of 0x10000000, add 0x10000000 and 0x00000002 to obtain 0x1000002.

-MaximumBuffers<UInt32>

Specifies the maximum number of buffers to allocate to the ETW session. We recommend a value of the MinimumBuffers parameter plus twenty. The value must be greater than or equal to MinimumBuffers. If you do not specify a value for the current parameter, ETW uses the buffer size and the size of physical memory to calculate a default value.

-MaximumFileSize<UInt32>

Specifies the maximum size, in megabytes, of a log file. The session is closed when the maximum size is reached, unless the session uses the circular log file mode. To specify no limit, specify a value of zero. The default value is 100 MB. When the log file size reaches its maximum size, the behavior depends on the value specified by the LogFileMode parameter.

-MinimumBuffers<UInt32>

Specifies the minimum number of buffers to allocate at startup of the ETW session.

-Name<String>

Specifies the name of the ETW trace session that this cmdlet creates.

-ThrottleLimit<Int32>

コマンドレットを実行する際に確立できる同時実行操作の最大数を指定します。このパラメーターを省略するか、値 0 を入力した場合、コンピューター上で実行されている CIM コマンドレットの数に基づいて、コマンドレットに最適なスロットル制限が Windows PowerShell® によって計算されます。スロットル制限は、セッションやコンピューターではなく、現在のコマンドレットにのみ適用されます。

-Confirm

コマンドレットを実行する前に確認メッセージを表示します。

-WhatIf

コマンドレットが実行された場合に何が起きるのかを示します。コマンドレットは実行されません。

<CommonParameters>

このコマンドレットは共通のパラメーターをサポートしています(-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable)。詳細については、TechNet の「 「about_CommonParameters」 (https://go.microsoft.com/fwlink/p/?LinkID=113216) を参照してください。

<WorkflowParameters>

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットが出力するオブジェクトの型です。

使用例

Example 1: Create an ETW trace session

This command creates an ETW trace session named NetCfgTrace that has a value of 24 for the MaximumBuffers parameter.

PS C:\> New-EtwTraceSession -Name "NetCfgTrace" -MaximumBuffers 24

関連項目

Get-EtwTraceSession

Remove-EtwTraceSession

Set-EtwTraceSession