Export (0) Print
Expand All
Expand Minimize

Set-TraceSource

Updated: December 3, 2014

Applies To: Windows PowerShell 4.0

Set-TraceSource

Configures, starts, and stops a trace of Windows PowerShell components.

Syntax

Parameter Set: optionsSet
Set-TraceSource [-Name] <String[]> [[-Option] <PSTraceSourceOptions> ] [-Debugger] [-FilePath <String> ] [-Force] [-ListenerOption <TraceOptions> ] [-PassThru] [-PSHost] [ <CommonParameters>]

Parameter Set: removeAllListenersSet
Set-TraceSource [-Name] <String[]> [-RemoveListener <String[]> ] [ <CommonParameters>]

Parameter Set: removeFileListenersSet
Set-TraceSource [-Name] <String[]> [-RemoveFileListener <String[]> ] [ <CommonParameters>]




Detailed Description

The Set-TraceSource cmdlet configures, starts, and stops a trace of a Windows PowerShell component. You can use it to specify which components will be traced and where the tracing output is sent.

Parameters

-Debugger

Sends the trace output to the debugger. You can view the output in any user-mode or kernel mode debugger or in Microsoft Visual Studio. This parameter also selects the default trace listener.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-FilePath<String>

Sends the trace output to the specified file. This parameter also selects the file trace listener. If you use this parameter to start the trace, use the RemoveFileListener parameter to stop the trace.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Force

Allows the cmdlet to overwrite a read-only file. Use with the FilePath parameter.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-ListenerOption<TraceOptions>

Adds optional data to the prefix of each trace message in the output. The valid values are "None", "LogicalOperationStack", "DateTime", "Timestamp", "ProcessId", "ThreadId", and "Callstack". "None" is the default.

To specify multiple options, separate them with commas, but with no spaces, and enclose them in quotation marks, such as "ProcessID,ThreadID".


Aliases

none

Required?

false

Position?

named

Default Value

"None"

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Name<String[]>

Determines which components are traced. Enter the name of the trace source of each component. Wildcards are permitted.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

true (ByValue, ByPropertyName)

Accept Wildcard Characters?

true

-Option<PSTraceSourceOptions>

Determines the type of events that are traced.

The valid values are: None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, and All. All is the default.

The following values are combinations of other values:

-- ExecutionFlow: (Constructor, Dispose, Finalizer, Method, Delegates, Events, and Scope)

-- Data: (Constructor, Dispose, Finalizer, Property, Verbose, and WriteLine)

-- Errors: (Error and Exception).

To specify multiple options, separate them with commas, but with no spaces, and enclose them in quotation marks, such as "Constructor,Dispose".


Aliases

none

Required?

false

Position?

2

Default Value

All

Accept Pipeline Input?

true (ByPropertyName)

Accept Wildcard Characters?

false

-PSHost

Sends the trace output to the Windows PowerShell host. This parameter also selects the PSHost trace listener.


Aliases

none

Required?

false

Position?

named

Default Value

False

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-PassThru

Returns an object representing the trace session. By default, this cmdlet does not generate any output.


Aliases

none

Required?

false

Position?

named

Default Value

No output

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemoveFileListener<String[]>

Stops the trace by removing the file trace listener associated with the specified file. Enter the path and file name of the trace output file.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-RemoveListener<String[]>

Stops the trace by removing the trace listener.

Use the following values with RemoveListener:

--To remove PSHost (console), type "Host".

--To remove Debugger, type "Debug".

--To remove all trace listeners, type "*".

To remove the file trace listener, use the RemoveFileListener parameter.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see  about_CommonParameters (http://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

  • System.String

    You can pipe a string that contains a name to Set-TraceSource.


Outputs

The output type is the type of the objects that the cmdlet emits.

  • None or System.Management.Automation.PSTraceSource

    When you use the PassThru parameter, Set-TraceSource generates a System.Management.Automation.PSTraceSource object representing the trace session. Otherwise, this cmdlet does not generate any output.


Notes

  • Tracing is a method that developers use to debug and refine programs. When tracing, the program generates detailed messages about each step in its internal processing.

    The Windows PowerShell tracing cmdlets are designed to help Windows PowerShell developers, but they are available to all users. They let you monitor nearly every aspect of the functionality of Windows PowerShell.

    A "trace source" is the part of each Windows PowerShell component that manages tracing and generates trace messages for the component. To trace a component, you identify its trace source.

    A "trace listener" receives the output of the trace and displays it to the user. You can elect to send the trace data to a user-mode or kernel-mode debugger, to the console, to a file, or to a custom listener derived from the System.Diagnostics.TraceListener class.

    To start a trace, use the Name parameter to specify a trace source (the component to be traced) and the FilePath, Debugger, or PSHost parameters to specify a listener (a destination for the output). Use the Options parameter to determine the types of events that are traced and the ListenerOptions parameter to configure the trace output.

    To change the configuration of a trace, enter a Set-TraceSource command as you would to start a trace. Windows PowerShell recognizes that the trace source is already being traced. It stops the trace, adds the new configuration, and starts or restarts the trace.

    To stop a trace, use the RemoveListener parameter. To stop a trace that uses the file listener (a trace started by using the -FilePath parameter), use the RemoveFileListener parameter. When you remove the listener, the trace stops.

    To determine which components can be traced, use Get-TraceSource. The trace sources for each module are loaded automatically when the component is in use, and they appear in the output of Get-TraceSource.

Examples

-------------------------- EXAMPLE 1 --------------------------

This command starts tracing for the ParameterBinding component of Windows PowerShell. It uses the Name parameter to specify the trace source, the Option parameter to select the ExecutionFlow trace events, and the PSHost parameter to select the Windows PowerShell host listener, which sends the output to the console. The ListenerOption parameter adds the "ProcessID" and "TimeStamp" values to the trace message prefix.


PS C:\> Set-TraceSource -Name Parameterbinding -Option ExecutionFlow -PSHost -ListenerOption "ProcessID,TimeStamp"

-------------------------- EXAMPLE 2 --------------------------

This command stops the trace of the ParameterBinding component of Windows PowerShell. It uses the Name parameter to identify the component that was being traced and the RemoveListener parameter to identify the trace listener.


PS C:\> set-tracesource -name ParameterBinding -RemoveListener Host

Related topics



Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft