Trace-Command

 

SYNOPSIS

The Trace-Command cmdlet configures and starts a trace of the specified expression or command.

 

SYNTAX

Trace-Command [-name] <string[]> [-expression] <scriptblock> [[-option] {<None> | <Constructor> | <Dispose> | <Finalizer> | <Method> | <Property> | <Delegates> | <Events> | <Exception> | <Lock> | <Error> | <Errors> | <Warning> | <Verbose> | <WriteLine> | <Data> | <Scope> | <ExecutionFlow> | <Assert> | <All>}] [-filePath <string>] [-debugger] [-pSHost] [-listenerOption {<None> | <LogicalOperationStack> | <DateTime> | <Timestamp> | <ProcessId> | <ThreadId> | <Callstack>}] [-inputObject <psobject>] [-force] [<CommonParameters>]

 

Trace-Command [-name] <string[]> [-command] <string> [[-option] {<None> | <Constructor> | <Dispose> | <Finalizer> | <Method> | <Property> | <Delegates> | <Events> | <Exception> | <Lock> | <Error> | <Errors> | <Warning> | <Verbose> | <WriteLine> | <Data> | <Scope> | <ExecutionFlow> | <Assert> | <All>}] [-filePath <string>] [-debugger] [-pSHost] [-listenerOption {<None> | <LogicalOperationStack> | <DateTime> | <Timestamp> | <ProcessId> | <ThreadId> | <Callstack>}] [-inputObject <psobject>] [-argumentList <Object[]>] [-force] [<CommonParameters>]

 

DETAILED DESCRIPTION

The Trace-Command cmdlet configures and starts a trace of the specified expression or command. It works like Set-TraceSource, except that it applies only to the specified command.

 

PARAMETERS

 

-name <string[]>

Determines which Windows PowerShell components are traced. Enter the name of the trace source of each component. Wildcards are permitted. To find the trace sources on your computer, type "Get-TraceSource".

 

Required?	true
Position?	1
Default value
Accept pipeline input?	false
Accept wildcard characters?	true

 

-expression <scriptblock>

Specifies the expression that is being processed during the trace. Enclose the expression in curly braces ({}).

 

Required?	true
Position?	2
Default value	Null
Accept pipeline input?	false
Accept wildcard characters?	false

 

-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".

 

The following lists the acceptable values for this parameter:

 

·          None

·          Constructor

·          Dispose

·          Finalizer

·          Method

·          Property

·          Delegates

·          Events

·          Exception

·          Lock

·          Error

·          Errors

·          Warning

·          Verbose

·          WriteLine

·          Data

·          Scope

·          ExecutionFlow

·          Assert

·          All

 

Required?	false
Position?	3
Default value	All
Accept pipeline input?	false
Accept wildcard characters?	false

 

-filePath <string>

Sends the trace output to specified file. This parameter also selects the file trace listener.

 

Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	true

 

-debugger <SwitchParameter>

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

 

Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	false

 

-pSHost <SwitchParameter>

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

 

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".

The following lists the acceptable values for this parameter:

 

·          None

·          LogicalOperationStack

·          DateTime

·          Timestamp

·          ProcessId

·          ThreadId

·          Callstack

 

Required?	false
Position?	named
Default value	TraceOptions.None
Accept pipeline input?	false
Accept wildcard characters?	false

 

-command <string>

Specifies a command that is being processed during the trace.

 

Required?	true
Position?	2
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

 

-inputObject <psobject>

Provides input to the expression that is being processed during the trace.

 

You can enter a variable that represents the input that the expression accepts, or pass an object through the pipeline.

 

Required?	false
Position?	named
Default value
Accept pipeline input?	true (ByValue)
Accept wildcard characters?	false

 

-argumentList <Object[]>

Specifies the parameters and parameter values for the command being traced. This feature is especially useful for debugging dynamic parameters.

 

Required?	false
Position?	named
Default value
Accept pipeline input?	false
Accept wildcard characters?	false

 

-force <SwitchParameter>

Overrides restrictions that prevent the command from succeeding, just so the changes do not compromise security. For example, Force will override the read-only attribute or create directories to complete a file path, but it will not attempt to change file permissions.

 

Required?	false
Position?	named
Default value	False
Accept pipeline input?	false
Accept wildcard characters?	false

 

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, and -OutVariable. For more information, type, "get-help about_commonparameters".

 

INPUT TYPE

Objects that represent the command or expression being traced

 

RETURN TYPE

The output of the expression or command

 

NOTES

 

For more information, type "Get-Help Trace-Command -detailed". For technical information, type "Get-Help Trace-Command -full".

 

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 the shell.

 

To find the Windows PowerShell components that are enabled for tracing, type "Get-Help Get-TraceSource."

 

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 host or console, to a file, or to a custom listener derived from the System.Diagnostics.TraceListener class.

 

When you use the Command parameter set, Windows PowerShell processes the command just as it would be processed in a pipeline. For example, command discovery is not repeated for each incoming object.

 

The names of the Name, Expression, Option, and Command parameters are optional. If you omit the parameter names, the unnamed parameter values must appear in this order: Name, Expression, Option or Name, Command,-Option . If you include the parameter names, the parameters can appear in any order.

 

EXAMPLE 1

 

 

This command starts a trace of metadata processing, parameter binding, and cmdlet creation and destruction of the "get-process notepad" expression. It uses the Name parameter to specify the trace sources, the Expression parameter to specify the command, and the PSHost parameter to send the output to the console. Because it does not specify any tracing options or listener options, the command uses the defaults, "All" for the tracing options and "None" for the listener options.

 

EXAMPLE 2

 

 

This command starts a trace of the command processor and pipeline processor while processing the "get-alias cd" command. It uses the Name parameter to specify the trace sources, the Command parameter to specify the command, the ArgumentList parameter to specify the parameters of the Get-Alias command, the Option parameter to specify tracing options, and the ListenerOption parameter to specify the fields in the trace message prefix. The FilePath parameter send the output to the Debug.txt file.

 

EXAMPLE 3

 

 

 

These commands trace the actions of the ParameterBinding operations of Windows PowerShell while it processes a Get-Aliasexpression that takes input from the pipeline.

 

In Trace-Command, the InputObject parameter passes an object to the expression that is being processed during the trace.

 

The first command stores the string "i*" in the $a variable. The second command uses the Trace-Command cmdlet with the ParameterBinding trace source. The PSHost parameter sends the output to the console.

 

The expression being processed is "get-alias $input", where the $input variable is associated with the InputObject parameter. The InputObject parameter passes the variable $a to the expression. In effect, the command being processed during the trace is "get-alias -inputobject $a" or "$a | get-alias".

 

RELATED LINKS

Get-TraceSource

Set-TraceSource