Como: criar e inicializar ouvintes de rastreamento

  • Artigo

Observação

Este artigo é específico para aplicativos .NET Framework. Não se aplica a implementações mais recentes do .NET, incluindo o .NET 6 e versões posteriores.

As classes System.Diagnostics.Debug e System.Diagnostics.Trace enviam mensagens para objetos chamados ouvintes, que recebem e processam essas mensagens. Um ouvinte desse tipo, o System.Diagnostics.DefaultTraceListener, é criado e inicializado automaticamente quando a depuração ou o rastreamento é habilitado. Se você desejar que a saída Trace ou Debug seja direcionada para outras fontes, crie e inicialize ouvintes de rastreamento adicionais.

Os ouvintes criados devem refletir as necessidades do aplicativo. Por exemplo, se desejar obter um registro de texto de toda a saída de rastreamento, crie um ouvinte TextWriterTraceListener, que grava toda a saída para um novo arquivo de texto quando ele é habilitado. Por outro lado, se desejar exibir a saída somente durante a execução do aplicativo, crie um ouvinte ConsoleTraceListener, que direciona toda a saída para uma janela do console. O EventLogTraceListener pode direcionar a saída de rastreamento para um log de eventos. Para obter mais informações, consulte Ouvintes de rastreamento.

Crie ouvintes de rastreamento em um arquivo de configuração de aplicativo ou no código. Recomendamos o uso de arquivos de configuração de aplicativo, porque eles permitem adicionar, modificar ou remover ouvintes de rastreamento sem a necessidade de alterar o código.

Para criar e usar um ouvinte de rastreamento usando um arquivo de configuração

  1. Declare o ouvinte de rastreamento no arquivo de configuração de aplicativo. Se o ouvinte que você está criando exigir outros objetos, declare-os também. O exemplo a seguir mostra como criar um ouvinte chamado myListener que grava no arquivo de texto TextWriterOutput.log.

    <configuration>
  <system.diagnostics>
    <trace autoflush="false" indentsize="4">
      <listeners>
        <add name="myListener" type="System.Diagnostics.TextWriterTraceListener" initializeData="TextWriterOutput.log" />
        <remove name="Default" />
      </listeners>
    </trace>
  </system.diagnostics>
</configuration>

  2. Use a classe Trace no código para gravar uma mensagem nos ouvintes de rastreamento.

    Trace.TraceInformation("Test message.")
' You must close or flush the trace to empty the output buffer.
Trace.Flush()

    Trace.TraceInformation("Test message.");
// You must close or flush the trace to empty the output buffer.
Trace.Flush();

Para criar e usar um ouvinte de rastreamento no código

  • Adicione o ouvinte de rastreamento à coleção Listeners e envie informações de rastreamento para os ouvintes.

    Trace.Listeners.Add(New TextWriterTraceListener("TextWriterOutput.log", "myListener"))
Trace.TraceInformation("Test message.")
' You must close or flush the trace to empty the output buffer.
Trace.Flush()

    Trace.Listeners.Add(new TextWriterTraceListener("TextWriterOutput.log", "myListener"));
Trace.TraceInformation("Test message.");
// You must close or flush the trace to empty the output buffer.
Trace.Flush();

    - ou -

  • Se você não desejar que o ouvinte receba a saída de rastreamento, não adicione-a à coleção Listeners. Emita a saída por meio de um ouvinte independente da coleção Listeners chamando os próprios métodos de saída do ouvinte. O exemplo a seguir mostra como gravar uma linha em um ouvinte que não está na coleção Listeners.

    Dim myListener As New TextWriterTraceListener("TextWriterOutput.log", "myListener")
myListener.WriteLine("Test message.")
' You must close or flush the trace listener to empty the output buffer.
myListener.Flush()

    TextWriterTraceListener myListener = new TextWriterTraceListener("TextWriterOutput.log", "myListener");
myListener.WriteLine("Test message.");
// You must close or flush the trace listener to empty the output buffer.
myListener.Flush();

Confira também