Trace-Command

参考

模块:: Microsoft.PowerShell.Utility

配置并启动指定表达式或命令的跟踪。

语法

Trace-Command
     [-InputObject <PSObject>]
     [-Name] <String[]>
     [[-Option] <PSTraceSourceOptions>]
     [-Expression] <ScriptBlock>
     [-ListenerOption <TraceOptions>]
     [-FilePath <String>]
     [-Force]
     [-Debugger]
     [-PSHost]
     [<CommonParameters>]

Trace-Command
     [-InputObject <PSObject>]
     [-Name] <String[]>
     [[-Option] <PSTraceSourceOptions>]
     [-Command] <String>
     [-ArgumentList <Object[]>]
     [-ListenerOption <TraceOptions>]
     [-FilePath <String>]
     [-Force]
     [-Debugger]
     [-PSHost]
     [<CommonParameters>]

说明

Trace-Command cmdlet 配置并启动指定表达式或命令的跟踪。它的工作方式类似于 Set-TraceSource，只是它仅适用于指定的命令。

示例

示例 1：跟踪元数据处理、参数绑定和表达式

此示例开始跟踪元数据处理、参数绑定和 cmdlet 创建和销毁 Get-Process Notepad 表达式。

Trace-Command -Name metadata,parameterbinding,cmdlet -Expression {Get-Process Notepad} -PSHost

它使用 Name 参数来指定跟踪源、表达式 参数来指定命令，PSHost 参数将输出发送到控制台。由于它未指定任何跟踪选项或侦听器选项，因此该命令使用默认值：

所有跟踪选项
侦听器选项无

示例 2：跟踪 ParameterBinding作的作

本示例跟踪 PowerShell ParameterBinding作的作，同时处理从管道获取输入的 Get-Alias 表达式。

$A = "i*"
Trace-Command ParameterBinding {Get-Alias $Input} -PSHost -InputObject $A

在 Trace-Command中，InputObject 参数将对象传递给跟踪期间正在处理的表达式。

第一个命令将字符串 i* 存储在 $A 变量中。第二个命令将 Trace-Command cmdlet 与 ParameterBinding 跟踪源配合使用。 PSHost 参数将输出发送到控制台。

正在处理的表达式 Get-Alias $Input，其中 $Input 变量与 InputObject 参数相关联。 InputObject 参数将变量 $A 传递给表达式。实际上，跟踪期间正在处理的命令 Get-Alias -InputObject $A" or "$A | Get-Alias。

示例 3：本机命令的跟踪 ParameterBinding作

PowerShell 7.3 添加了跟踪本机命令的参数绑定的功能。以下示例演示 PowerShell 如何分析本机命令 TestExe的命令行参数。

$a = 'a" "b'
Trace-Command -PSHOST -Name ParameterBinding { TestExe -echoargs $a 'c" "d' e" "f }

DEBUG: 2023-02-27 14:20:45.3975 ParameterBinding Information: 0 : BIND NAMED native application line args [C:\Public\Toolbox\TestExe\testexe.exe]
DEBUG: 2023-02-27 14:20:45.3978 ParameterBinding Information: 0 :     BIND cmd line arg [-echoargs] to position [0]
DEBUG: 2023-02-27 14:20:45.3979 ParameterBinding Information: 0 :     BIND cmd line arg [a" "b] to position [1]
DEBUG: 2023-02-27 14:20:45.3980 ParameterBinding Information: 0 :     BIND cmd line arg [c" "d] to position [2]
DEBUG: 2023-02-27 14:20:45.3982 ParameterBinding Information: 0 :     BIND cmd line arg [e f] to position [3]
DEBUG: 2023-02-27 14:20:47.6092 ParameterBinding Information: 0 : CALLING BeginProcessing

参数

-ArgumentList

指定要跟踪的命令的参数和参数值。 ArgumentList 的别名 Args。此功能可用于调试动态参数。

有关 ArgumentList的行为的详细信息，请参阅 about_Splatting。

类型:	Object[]
别名:	Args
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Command

指定在跟踪期间正在处理的命令。

使用此参数时，PowerShell 会像在管道中处理一样处理命令。例如，不会为每个传入对象重复命令发现。

类型:	String
Position:	1
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Debugger

指示 cmdlet 将跟踪输出发送到调试器。可以在任何用户模式或内核模式调试器或 Visual Studio 中查看输出。此参数还会选择默认跟踪侦听器。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Expression

指定在跟踪期间正在处理的表达式。将表达式括在大括号（{}）。

类型:	ScriptBlock
Position:	1
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-FilePath

指定 cmdlet 将跟踪输出发送到的文件。此参数还会选择文件跟踪侦听器。

类型:	String
别名:	PSPath, Path
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Force

强制命令运行而不要求用户确认。与 FilePath 参数一起使用。即使使用 Force 参数，cmdlet 也不能替代安全限制。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-InputObject

指定跟踪期间正在处理的表达式的输入。可以输入一个代表表达式接受的输入的变量，也可以通过管道传递对象。

类型:	PSObject
Position:	Named
默认值:	None
必需:	False
接受管道输入:	True
接受通配符:	False

-ListenerOption

指定输出中每个跟踪消息的前缀的可选数据。此参数的可接受值为：

None
LogicalOperationStack
DateTime
Timestamp
ProcessId
ThreadId
Callstack

None 为默认值。

这些值定义为基于标志的枚举。可以使用此参数将多个值组合在一起以设置多个标志。可以将值作为值数组或这些值的逗号分隔字符串传递给 ListenerOption 参数。该 cmdlet 将使用二进制 OR作合并这些值。将值作为数组传递是最简单的选项，还允许对值使用 Tab 补全。

类型:	TraceOptions
接受的值:	None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-Name

指定跟踪的 PowerShell 组件的数组。输入每个组件的跟踪源的名称。允许通配符。若要在计算机上查找跟踪源，请键入 Get-TraceSource。

类型:	String[]
Position:	0
默认值:	None
必需:	True
接受管道输入:	False
接受通配符:	False

-Option

确定跟踪的事件的类型。此参数的可接受值为：

None
Constructor
Dispose
Finalizer
Method
Property
Delegates
Events
Exception
Lock
Error
Errors
Warning
Verbose
WriteLine
Data
Scope
ExecutionFlow
Assert
All

All 为默认值。

以下值是其他值的组合：

ExecutionFlow：Constructor、Dispose、Finalizer、Method、Delegates、Events、Scope
Data：Constructor、Dispose、Finalizer、Property、Verbose、WriteLine
Errors：Error、Exception

这些值定义为基于标志的枚举。可以使用此参数将多个值组合在一起以设置多个标志。可以将值作为值数组或这些值的逗号分隔字符串传递给 Option 参数。该 cmdlet 将使用二进制 OR作合并这些值。将值作为数组传递是最简单的选项，还允许对值使用 Tab 补全。

类型:	PSTraceSourceOptions
接受的值:	None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, All
Position:	2
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

-PSHost

指示 cmdlet 将跟踪输出发送到 PowerShell 主机。此参数还会选择 PSHost 跟踪侦听器。

类型:	SwitchParameter
Position:	Named
默认值:	None
必需:	False
接受管道输入:	False
接受通配符:	False

输入

PSObject

可以通过管道将表示表达式输入的对象传递给此 cmdlet。

输出

PSObject

此 cmdlet 不返回自己的输出。跟踪的命令可能会返回输出。此 cmdlet 将命令跟踪写入调试流。

备注

跟踪是开发人员用于调试和优化程序的方法。跟踪时，程序会生成有关其内部处理中每个步骤的详细消息。 PowerShell 跟踪 cmdlet 旨在帮助 PowerShell 开发人员，但可供所有用户使用。它们允许你监视 shell 功能的几乎所有方面。

跟踪源是管理跟踪和生成组件跟踪消息的每个 PowerShell 组件的一部分。若要跟踪组件，请标识其跟踪源。

使用 Get-TraceSource 查看已启用跟踪的 PowerShell 组件列表。

跟踪侦听器接收跟踪的输出并将其显示给用户。可以选择将跟踪数据发送到用户模式或内核模式调试器、主机或控制台、文件或派生自 System.Diagnostics.TraceListener 类的自定义侦听器。

通过