FileLogTraceListener Classe

Definição

public ref class FileLogTraceListener : System::Diagnostics::TraceListener

[System.Runtime.InteropServices.ComVisible(false)]
public class FileLogTraceListener : System.Diagnostics.TraceListener

[<System.Runtime.InteropServices.ComVisible(false)>]
type FileLogTraceListener = class
    inherit TraceListener

Public Class FileLogTraceListener
Inherits TraceListener

Herança

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Atributos

ComVisibleAttribute

Comentários

A FileLogTraceListener classe fornece recursos de manutenção automatizados para arquivar arquivos de log conforme necessário, diariamente ou por aplicativo. Essa funcionalidade de arquivamento automático ajuda a reduzir as responsabilidades de manutenção de desenvolvedores e administradores.

Uma instância do FileLogTraceListener pode ser adicionada às Debug.Listeners coleções ou Trace.Listeners para redirecionar a saída do registro em log para um arquivo de texto. Instâncias dessa classe também podem ser adicionadas a My.Application.Log ou My.Log (para aplicativos Web) em aplicativos do Visual Basic. Para obter mais informações, consulte Instruções passo a passo: Alterando onde My.Application.Log grava informações.

Os main recursos dessa classe são:

1. Funcionalidade de arquivamento. Os arquivos de log gerados por essa classe são nomeados de acordo com o nome base e a data, juntamente com um número para distinguir o arquivo de log de versões sucessivas do log. Novos arquivos de log são criados conforme necessário.

   A forma explícita do nome do arquivo é baseName[-dateStamp][-version].log, em que:

   • A baseName parte é o nome de log fundamental, especificado pela BaseFileName propriedade .

   • A dateStamp parte tem o formato "AAAA-MM-DD" e é mostrada quando LogFileCreationSchedule é Daily ou Weekly.

   • Se mais de um arquivo de log for necessário com o mesmo baseName e , a version parte , um positivo Integer, será adicionado ao dateStampnome do arquivo.

2. Várias instâncias de classe. Se uma instância da FileLogTraceListener classe gravar em um arquivo que está em uso:

   • A classe compartilhará o arquivo se ele estiver sendo usado por outra instância da FileLogTraceListener classe no mesmo processo.

   • A classe criará um novo arquivo de log usando o próximo nome disponível se o arquivo estiver sendo usado por outro processo.

3. Segurança de thread. A FileLogTraceListener classe é thread-safe. Isso permite que você escreva mensagens com segurança no log de vários threads sem usar bloqueios.

Local do arquivo de log

• A Location propriedade usa uma LogFileLocation enumeração para especificar um dos diretórios típicos para gravar o arquivo de log.

• Para gravar o log em outro local, defina a CustomLocation propriedade para esse local.

Nome do arquivo de log

• O nome base do arquivo de log é especificado pela BaseFileName propriedade .

• O nome do arquivo de log atual pode ser lido na FullLogFileName propriedade . Ele é derivado de várias outras propriedades e do estado atual dos logs no sistema de arquivos.

Manutenção de log

• A frequência mínima para criar novos arquivos de log é determinada pela LogFileCreationSchedule propriedade . Quando o valor é Daily ou Weekly, um novo arquivo de log é criado pelo menos uma vez por dia ou semana e um carimbo de data é incorporado ao FullLogFileName nome.

• O tamanho máximo (em bytes) do arquivo de log é determinado pela MaxFileSize propriedade . Se o tamanho do arquivo de log exceder esse tamanho, mensagens adicionais gravadas no log serão descartadas e, dependendo da DiskSpaceExhaustedBehavior propriedade , uma exceção será gerada.

• A ReserveDiskSpace propriedade determina quanto espaço livre (em bytes) deve estar disponível. Isso ajuda a garantir que a FileLogTraceListener classe não consumirá todo o espaço em disco disponível. Use a DiskSpaceExhaustedBehavior propriedade para especificar o comportamento de gravações de log quando houver menos de ReserveDiskSpace bytes livres.

Configurações de saída do arquivo de log

• A AutoFlush propriedade especifica se o fluxo subjacente deve ser liberado automaticamente após cada gravação no arquivo de log.

• A Append propriedade especifica se as mensagens devem ser acrescentadas ao arquivo de log atual, se permitido, ou gravá-las em um novo arquivo de log.

• A Delimiter propriedade especifica a cadeia de caracteres a ser usada para delimitar os campos dentro de uma mensagem de log.

• A Encoding propriedade especifica a codificação a ser usada ao criar um novo arquivo de log.

Saída do arquivo de log

• Os TraceData métodos e TraceEvent gravam mensagens no arquivo de log. Esses métodos marcar a LogFileCreationSchedule propriedade, juntamente com todos os logs existentes com o mesmo nome base para determinar se um novo log deve ser criado.

• O Flush método libera todas as mensagens atualmente no buffer de saída para o arquivo de log.

• O Close método fecha o arquivo de log para que ele possa ser usado por outros processos.

Habilitando a saída

Você deve habilitar o rastreamento ou a depuração para usar um ouvinte de rastreamento. A sintaxe a seguir é específica do compilador. Se você usar compiladores diferentes de C# ou Visual Basic, consulte a documentação do compilador.

• Para habilitar a depuração em C#, adicione o /d:DEBUG sinalizador à linha de comando do compilador ao compilar o código ou adicione #define DEBUG à parte superior do arquivo. No Visual Basic, adicione o /d:DEBUG=True sinalizador à linha de comando do compilador.

• Para habilitar o rastreamento em C#, adicione o /d:TRACE sinalizador à linha de comando do compilador ao compilar o código ou adicione #define TRACE à parte superior do arquivo. No Visual Basic, adicione o /d:TRACE=True sinalizador à linha de comando do compilador.

Em .NET Framework aplicativos, você pode definir o nível do ouvinte editando o arquivo de configuração do aplicativo. Nesse arquivo, você pode adicionar um ouvinte, definir seu tipo e definir seus parâmetros, remover um ouvinte ou limpar todos os ouvintes definidos anteriormente pelo aplicativo. O arquivo de configuração deve ser formatado como o exemplo a seguir.

<configuration>  
    <system.diagnostics>  
        <sharedListeners>  
            <add name="FileLog"  
                type="Microsoft.VisualBasic.Logging.FileLogTraceListener,   
                      Microsoft.VisualBasic, Version=8.0.0.0,   
                      Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a,   
                      processorArchitecture=MSIL"   
                initializeData="FileLogWriter"/>  
        </sharedListeners>  
    </system.diagnostics>  
</configuration>  

Para que este exemplo seja executado, você deve fornecer o nome do assembly totalmente qualificado. Para obter informações sobre como obter o nome do assembly totalmente qualificado, consulte Nomes de assembly.

Construtores

Propriedades

Métodos

Aplica-se a

Confira também

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Passo a passo: alterar o local no qual My.Application.Log grava informações