Compartilhar via

Set-TraceSource

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

Configura, inicia e interrompe um rastreamento de componentes do PowerShell.

Sintaxe

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 cmdlet Set-TraceSource 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 do componente ParameterBinding do PowerShell. Ele usa o parâmetro Name para especificar a fonte de rastreamento, o parâmetro Option para selecionar os eventos de rastreamento de ExecutionFlow 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 valores ProcessID 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 depurador no modo de usuário ou kernel ou no Microsoft Visual Studio. Esse parâmetro também seleciona o ouvinte de rastreamento padrão.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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 de arquivo. Se você usar esse parâmetro para iniciar o rastreamento, use o parâmetro RemoveFileListener para interromper o rastreamento.

Tipo:String
Aliases:PSPath, Path
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Force

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-ListenerOption

Especifica dados opcionais para o prefixo de cada mensagem de rastreamento na saída. Os valores aceitáveis para este 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 binária-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use a conclusão da guia nos valores.

Tipo:TraceOptions
Valores aceitos:None, LogicalOperationStack, DateTime, Timestamp, ProcessId, ThreadId, Callstack
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-Name

Especifica quais componentes são rastreados. Insira o nome da fonte de rastreamento de cada componente. Curingas são permitidos.

Tipo:String[]
Cargo:0
Valor padrão:None
Obrigatório:True
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:True

-Option

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

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

None é 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 a opção parâmetro 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 binária-OR. Passar valores como uma matriz é a opção mais simples e também permite que você use a conclusão da guia nos valores.

Tipo:PSTraceSourceOptions
Valores aceitos:None, Constructor, Dispose, Finalizer, Method, Property, Delegates, Events, Exception, Lock, Error, Errors, Warning, Verbose, WriteLine, Data, Scope, ExecutionFlow, Assert, All
Cargo:1
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:True
Aceitar caracteres curinga:False

-PassThru

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

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga: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.

Tipo:SwitchParameter
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RemoveFileListener

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

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

-RemoveListener

Interrompe o rastreamento removendo o ouvinte de rastreamento.

Use os seguintes valores com RemoveListener:

  • Para remover 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.

Tipo:String[]
Cargo:Named
Valor padrão:None
Obrigatório:False
Aceitar a entrada de pipeline:False
Aceitar caracteres curinga:False

Entradas

String

Você pode canalizar uma cadeia de caracteres que contém um nome para este cmdlet.

Saídas

None

Por padrão, esse cmdlet não retorna nenhuma saída.

PSTraceSource

Quando você usa o parâmetro PassThru, esse cmdlet retorna um objeto PSTraceSource que representa a sessão de rastreamento.

Observações

  • O rastreamento é um método que os desenvolvedores usam para depurar e refinar programas. Ao rastrear, o programa gera mensagens detalhadas sobre cada etapa em 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, identifique a fonte 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 no 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 fonte de rastreamento e o FilePath, de depurador ou parâmetros de 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 comando Set-TraceSource como você 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.