Share via

Set-TraceSource

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Configura, inicia e interrompe um rastreamento de componentes do 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

O Set-TraceSource cmdlet configura, inicia e interrompe um rastreamento de um componente do PowerShell. Você pode usá-lo para especificar quais componentes serão rastreados e para onde a saída de rastreamento é enviada.

Exemplos

Exemplo 1: Rastrear o componente ParameterBinding

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

Esse comando inicia o rastreamento para o componente ParameterBinding do PowerShell. Ele usa o parâmetro Name para especificar a origem do rastreamento, o parâmetro Option para selecionar os ExecutionFlow eventos de rastreamento e o parâmetro PSHost para selecionar o ouvinte de host do PowerShell, que envia a saída para o console. O parâmetro ListenerOption adiciona os ProcessID valores e TimeStamp ao prefixo da mensagem de rastreamento.

Exemplo 2: Parar um rastreamento

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

Esse comando interrompe o rastreamento do componente ParameterBinding do PowerShell. Ele usa o parâmetro Name para identificar o componente que estava sendo rastreado e o parâmetro RemoveListener para identificar o ouvinte de rastreamento.

Parâmetros

-Debugger

Indica que o cmdlet envia a saída de rastreamento para o depurador. Você pode exibir a saída em qualquer modo de usuário ou depurador do modo kernel, ou ainda no Microsoft Visual Studio. Esse parâmetro também seleciona o ouvinte de rastreamento padrão.

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

-FilePath

Especifica um arquivo para o qual esse cmdlet envia a saída de rastreamento. Esse parâmetro também seleciona o ouvinte de rastreamento do arquivo. Se você usar esse parâmetro para iniciar o rastreamento, use o parâmetro RemoveFileListener para interromper o rastreamento.

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

-Force

Indica que o cmdlet substitui um arquivo somente leitura. Use com o parâmetro FilePath .

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

-ListenerOption

Especifica dados opcionais para o prefixo de cada mensagem de rastreamento na saída. Os valores aceitáveis para esse parâmetro são:

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

None é o padrão.

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para o parâmetro ListenerOption como uma matriz de valores ou como uma cadeia de caracteres separada por vírgulas desses valores. O cmdlet combinará os valores usando uma operação binary-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use a conclusão de tabulação nos 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 quais componentes são rastreados. Insira o nome da origem de rastreamento de cada componente. Caracteres curinga são permitidos.

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

-Option

Especifica o tipo de eventos que são rastreados. Os valores aceitáveis para esse parâmetro são:

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

All é o padrão.

Os seguintes valores são combinações de outros valores:

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

Esses valores são definidos como uma enumeração baseada em sinalizador. Você pode combinar vários valores para definir vários sinalizadores usando esse parâmetro. Os valores podem ser passados para o parâmetro Option como uma matriz de valores ou como uma cadeia de caracteres separada por vírgulas desses valores. O cmdlet combinará os valores usando uma operação binary-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use a conclusão de tabulação nos 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

Retorna um objeto que representa o item com que você está trabalhando. Por padrão, este cmdlet não gera saída.

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

-PSHost

Indica que esse cmdlet envia a saída de rastreamento para o host do PowerShell. Esse parâmetro também seleciona o ouvinte de rastreamento PSHost.

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

-RemoveFileListener

Interrompe o rastreamento, removendo o ouvinte de rastreamento do arquivo associado ao arquivo especificado. Digite o caminho e o nome do arquivo de saída de rastreamento.

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

-RemoveListener

Interrompe o rastreamento, removendo o ouvinte de rastreamento.

Use os seguintes valores com RemoveListener:

  • Para remover o PSHost (console), digite Host.
  • Para remover o Depurador, digite Debug.
  • Para remover todos os ouvintes de rastreamento, digite *.

Para remover o ouvinte de rastreamento de arquivo, use o parâmetro RemoveFileListener .

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

Entradas

String

Você pode redirecionar uma cadeia de caracteres que contém um nome para Set-TraceSource.

Saídas

None or System.Management.Automation.PSTraceSource

Quando você usa o parâmetro PassThru , Set-TraceSource gera um objeto System.Management.Automation.PSTraceSource que representa a sessão de rastreamento. Caso contrário, este cmdlet não gera nenhuma saída.

Observações

  • O rastreamento é um método utilizado pelos desenvolvedores para depurar e aprimorar os programas. Ao realizar o rastreamento, o componente gera mensagens detalhadas sobre cada etapa no seu processamento interno.

    Os cmdlets de rastreamento do PowerShell foram projetados para ajudar os desenvolvedores do PowerShell, mas estão disponíveis para todos os usuários. Eles permitem monitorar quase todos os aspectos da funcionalidade do PowerShell.

    Uma fonte de rastreamento é a parte de cada componente do PowerShell que gerencia o rastreamento e gera mensagens de rastreamento para o componente. Para rastrear um componente, você deve identificar sua origem de rastreamento.

    Um ouvinte de rastreamento recebe a saída do rastreamento e o exibe para o usuário. Você pode optar por enviar os dados de rastreamento para um depurador de modo de usuário ou kernel, para o console, para um arquivo ou para um ouvinte personalizado derivado da classe System.Diagnostics.TraceListener .

  • Para iniciar um rastreamento, use o parâmetro Name para especificar uma origem de rastreamento e os parâmetros FilePath, Debugger ou PSHost para especificar um ouvinte (um destino para a saída). Use o parâmetro Options para determinar os tipos de eventos que são rastreados e o parâmetro ListenerOption para configurar a saída de rastreamento.

  • Para alterar a configuração de um rastreamento, insira um Set-TraceSource comando como faria para iniciar um rastreamento. O PowerShell reconhece que a fonte de rastreamento já está sendo rastreada. Ele interrompe o rastreamento, adiciona a nova configuração e inicia ou reinicia o rastreamento.

  • Para interromper um rastreamento, use o parâmetro RemoveListener . Para interromper um rastreamento que usa o ouvinte de arquivos (um rastreamento iniciado usando o parâmetro FilePath ), use o parâmetro RemoveFileListener . Quando você remove o ouvinte, o rastreamento é interrompido.

  • Para determinar quais componentes podem ser rastreados, use Get-TraceSource. As fontes de rastreamento para cada módulo são carregadas automaticamente quando o componente está em uso e aparecem na saída de Get-TraceSource.