Set-TraceSource

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Configura, inicia y detiene un seguimiento de los componentes de PowerShell.

Syntax

Set-TraceSource
   [-Name] <String[]>
   [[-Option] <PSTraceSourceOptions>]
   [-ListenerOption <TraceOptions>]
   [-FilePath <String>]
   [-Force]
   [-Debugger]
   [-PSHost]
   [-PassThru]
   [<CommonParameters>]
Set-TraceSource
   [-Name] <String[]>
   [-RemoveListener <String[]>]
   [<CommonParameters>]
Set-TraceSource
   [-Name] <String[]>
   [-RemoveFileListener <String[]>]
   [<CommonParameters>]

Description

El Set-TraceSource cmdlet configura, inicia y detiene un seguimiento de un componente de PowerShell. Puede usarlo para especificar qué componentes serán objetos de seguimiento y a dónde se enviarán los resultados de seguimiento.

Ejemplos

Ejemplo 1: Seguimiento del componente ParameterBinding

Set-TraceSource -Name "ParameterBinding" -Option ExecutionFlow -PSHost -ListenerOption "ProcessId,TimeStamp"

Este comando inicia el seguimiento del componente ParameterBinding de PowerShell. Usa el parámetro Name para especificar el origen de seguimiento, el parámetro Option para seleccionar los ExecutionFlow eventos de seguimiento y el parámetro PSHost para seleccionar el agente de escucha del host de PowerShell, que envía la salida a la consola. El parámetro ListenerOption agrega los ProcessID valores y TimeStamp al prefijo del mensaje de seguimiento.

Ejemplo 2: Detener un seguimiento

Set-TraceSource -Name "ParameterBinding" -RemoveListener "Host"

Este comando detiene el seguimiento del componente ParameterBinding de PowerShell. Usa el parámetro Name para identificar el componente que se estaba rastreando y el parámetro RemoveListener para identificar el agente de escucha de seguimiento.

Parámetros

-Debugger

Indica que el cmdlet envía la salida de seguimiento al depurador. Puede ver los resultados en cualquier depurador de modo de usuario o de modo kernel en Microsoft Visual Studio. Este parámetro también selecciona el agente de escucha de seguimiento predeterminado.

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

-FilePath

Especifica un archivo al que este cmdlet envía la salida de seguimiento. Este parámetro también selecciona el agente de escucha de seguimiento del archivo. Si usa este parámetro para iniciar el seguimiento, use el parámetro RemoveFileListener para detener el seguimiento.

Type:String
Aliases:PSPath, Path
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Indica que el cmdlet sobrescribe un archivo de solo lectura. Use con el parámetro FilePath .

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

-ListenerOption

Especifica los datos opcionales para el prefijo de cada mensaje de seguimiento en la salida. Los valores permitidos para este parámetro son los siguientes:

  • None
  • LogicalOperationStack
  • DateTime
  • Timestamp
  • ProcessId
  • ThreadId
  • Callstack

None es el valor predeterminado.

Estos valores se definen como una enumeración basada en marcas. Puede combinar varios valores para establecer varias marcas mediante este parámetro. Los valores se pueden pasar al parámetro ListenerOption como una matriz de valores o como una cadena separada por comas de esos valores. El cmdlet combinará los valores mediante una operación binary-OR. Pasar valores como una matriz es la opción más sencilla y también permite usar la finalización de tabulación en los valores.

Type:TraceOptions
Accepted values:None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Especifica qué componentes se rastrean. Escriba el nombre del origen de seguimiento de cada componente. Se permiten los caracteres comodín.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-Option

Especifica el tipo de eventos de seguimiento. Los valores permitidos para este parámetro son los siguientes:

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

All es el valor predeterminado.

Los valores siguientes son combinaciones de otros valores:

  • ExecutionFlow: Constructor, Dispose, Finalizer, Method, Delegates, , , EventsScope
  • Data: Constructor, Dispose, Finalizer, Property, , Verbose, WriteLine
  • Errors: Error, Exception

Estos valores se definen como una enumeración basada en marcas. Puede combinar varios valores para establecer varias marcas mediante este parámetro. Los valores se pueden pasar al parámetro Option como una matriz de valores o como una cadena separada por comas de esos valores. El cmdlet combinará los valores mediante una operación binary-OR. Pasar valores como una matriz es la opción más sencilla y también permite usar la finalización de tabulación en los valores.

Type:PSTraceSourceOptions
Accepted values:None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, All
Position:1
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

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

-PSHost

Indica que este cmdlet envía la salida de seguimiento al host de PowerShell. Este parámetro también selecciona el agente de escucha de seguimiento de PSHost.

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

-RemoveFileListener

Detiene el seguimiento mediante la eliminación del agente de escucha de seguimiento de archivo asociado al archivo especificado. Escriba la ruta de acceso y el nombre del archivo de resultados de seguimiento.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveListener

Detiene el seguimiento mediante la eliminación del agente de escucha de seguimiento.

Use los valores siguientes con RemoveListener:

  • Para quitar PSHost (consola), escriba Host.
  • Para quitar Depurador, escriba Debug.
  • Para quitar todos los agentes de escucha de seguimiento, escriba *.

Para quitar el agente de escucha de seguimiento de archivos, use el parámetro RemoveFileListener .

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Entradas

String

Puede canalizar una cadena que contenga un nombre a este cmdlet.

Salidas

None

De forma predeterminada, este cmdlet no devuelve ninguna salida.

PSTraceSource

Cuando se usa el parámetro PassThru , este cmdlet devuelve un objeto PSTraceSource que representa la sesión de seguimiento.

Notas

  • El seguimiento es un método que los desarrolladores usan para depurar y ajustar los programas. Al realizar el seguimiento, el programa genera los mensajes detallados sobre cada paso en el procesamiento interno.

    Los cmdlets de seguimiento de PowerShell están diseñados para ayudar a los desarrolladores de PowerShell, pero están disponibles para todos los usuarios. Permiten supervisar casi todos los aspectos de la funcionalidad de PowerShell.

    Un origen de seguimiento es la parte de cada componente de PowerShell que administra el seguimiento y genera mensajes de seguimiento para el componente. Para realizar el seguimiento de un componente, se identifica el origen de seguimiento.

    Un agente de escucha de seguimiento recibe la salida del seguimiento y lo muestra al usuario. Puede optar por enviar los datos de seguimiento a un depurador en modo de usuario o en modo kernel, a la consola, a un archivo o a un agente de escucha personalizado derivado de la clase System.Diagnostics.TraceListener .

  • Para iniciar un seguimiento, use el parámetro Name para especificar un origen de seguimiento y los parámetros FilePath, Debugger o PSHost para especificar un agente de escucha (un destino para la salida). Use el parámetro Options para determinar los tipos de eventos que se rastrean y el parámetro ListenerOption para configurar la salida del seguimiento.

  • Para cambiar la configuración de un seguimiento, escriba un Set-TraceSource comando como lo haría para iniciar un seguimiento. PowerShell reconoce que el origen de seguimiento ya se está rastreando. Detiene el seguimiento, agrega la nueva configuración e inicia o reinicia el seguimiento.

  • Para detener un seguimiento, use el parámetro RemoveListener . Para detener un seguimiento que use el agente de escucha de archivos (un seguimiento iniciado mediante el parámetro FilePath ), use el parámetro RemoveFileListener . Al quitar el agente de escucha, se detiene el seguimiento.

  • Para determinar qué componentes se pueden someter a seguimiento, use Get-TraceSource. Los orígenes de seguimiento de cada módulo se cargan automáticamente cuando el componente está en uso y aparecen en la salida de Get-TraceSource.