FileLogTraceListener Clase

Definición

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

Herencia

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Atributos

ComVisibleAttribute

Comentarios

La FileLogTraceListener clase proporciona funcionalidades de mantenimiento automatizadas para archivar los archivos de registro según sea necesario, de forma diaria o por aplicación. Esta funcionalidad de archivado automática ayuda a reducir las responsabilidades de mantenimiento de los desarrolladores y administradores.

Se puede agregar una instancia de FileLogTraceListener a las Debug.Listeners colecciones o Trace.Listeners para redirigir la salida del registro a un archivo de texto. Las instancias de esta clase también se pueden agregar a My.Application.Log o My.Log (para aplicaciones web) en aplicaciones de Visual Basic. Para obtener más información, consulta Tutorial: Cambiar el lugar donde My.Application.Log escribe información.

Las características principales de esta clase son:

1. Funcionalidad de archivado. Los archivos de registro generados por esta clase se denominan según el nombre base y la fecha, junto con un número para distinguir el archivo de registro de las versiones sucesivas del registro. Los nuevos archivos de registro se crean según sea necesario.

   La forma explícita del nombre de archivo es baseName[-dateStamp][-version].log, donde:

   • La baseName parte es el nombre de registro fundamental, especificado por la BaseFileName propiedad .

   • La dateStamp parte tiene el formato "AAAA-MM-DD", y se muestra cuando LogFileCreationSchedule es Daily o Weekly.

   • Si se necesita más de un archivo de registro con el mismo baseName y , el version elemento , un positivo Integer, se agrega al dateStampnombre de archivo.

2. Varias instancias de clase. Si una instancia de la FileLogTraceListener clase escribe en un archivo que está en uso:

   • La clase comparte el archivo si otra instancia de la FileLogTraceListener clase está usando en el mismo proceso.

   • La clase crea un nuevo archivo de registro con el siguiente nombre disponible si otro proceso usa el archivo.

3. Seguridad de subprocesos. La FileLogTraceListener clase es segura para subprocesos. Esto le permite escribir mensajes de forma segura en el registro desde varios subprocesos sin usar bloqueos.

Ubicación del archivo de registro

• La Location propiedad toma una LogFileLocation enumeración para especificar uno de los directorios típicos en los que escribir el archivo de registro.

• Para escribir el registro en otra ubicación, establezca la CustomLocation propiedad en esa ubicación.

Nombre del archivo de registro

• La propiedad especifica BaseFileName el nombre base del archivo de registro.

• El nombre del archivo de registro actual se puede leer desde la FullLogFileName propiedad . Se deriva de otras propiedades y del estado actual de los registros en el sistema de archivos.

Mantenimiento del registro

• La propiedad determina LogFileCreationSchedule la frecuencia mínima para crear nuevos archivos de registro. Cuando el valor es Daily o Weekly, se crea un nuevo archivo de registro al menos una vez cada día o semana y se incorpora una marca de fecha en el FullLogFileName nombre.

• La propiedad determina MaxFileSize el tamaño máximo (en bytes) del archivo de registro. Si el tamaño del archivo de registro supera este tamaño, se descartan los mensajes adicionales escritos en el registro y, según la DiskSpaceExhaustedBehavior propiedad , se produce una excepción.

• La ReserveDiskSpace propiedad determina cuánto espacio libre (en bytes) debe estar disponible. Esto ayuda a garantizar que la FileLogTraceListener clase no consumirá todo el espacio disponible en disco. Utilice la DiskSpaceExhaustedBehavior propiedad para especificar el comportamiento de las escrituras de registro cuando hay menos de ReserveDiskSpace bytes libres.

Configuración de salida del archivo de registro

• La AutoFlush propiedad especifica si la secuencia subyacente se debe vaciar automáticamente después de cada escritura en el archivo de registro.

• La Append propiedad especifica si se van a anexar mensajes al archivo de registro actual, si se permiten, o escribirlos en un nuevo archivo de registro.

• La Delimiter propiedad especifica la cadena que se va a usar para delimitar los campos dentro de un mensaje de registro.

• La Encoding propiedad especifica la codificación que se va a usar al crear un nuevo archivo de registro.

Salida del archivo de registro

• Los TraceData métodos y TraceEvent escriben mensajes en el archivo de registro. Estos métodos comprueban la LogFileCreationSchedule propiedad, junto con los registros existentes con el mismo nombre base para determinar si se debe crear un nuevo registro.

• El Flush método vacía los mensajes que hay actualmente en el búfer de salida en el archivo de registro.

• El Close método cierra el archivo de registro para que otros procesos puedan usarlo.

Habilitación de la salida

Debe habilitar el seguimiento o la depuración para usar un agente de escucha de seguimiento. La sintaxis siguiente es específica del compilador. Si usa compiladores distintos de C# o Visual Basic, consulte la documentación del compilador.

• Para habilitar la depuración en C#, agregue la /d:DEBUG marca a la línea de comandos del compilador al compilar el código o puede agregar #define DEBUG a la parte superior del archivo. En Visual Basic, agregue la /d:DEBUG=True marca a la línea de comandos del compilador.

• Para habilitar el seguimiento en C#, agregue la /d:TRACE marca a la línea de comandos del compilador al compilar el código o agregue #define TRACE a la parte superior del archivo. En Visual Basic, agregue la /d:TRACE=True marca a la línea de comandos del compilador.

En las aplicaciones de .NET Framework, puede establecer el nivel del agente de escucha editando el archivo de configuración de la aplicación. Dentro de este archivo, puede agregar un agente de escucha, establecer su tipo y establecer sus parámetros, quitar un agente de escucha o borrar todos los agentes de escucha establecidos previamente por la aplicación. El archivo de configuración debe tener un formato similar al del ejemplo siguiente.

<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 ejemplo se ejecute, debe proporcionar el nombre completo del ensamblado. Para obtener información sobre cómo obtener el nombre completo del ensamblado, vea Nombres de ensamblado.

Constructores

Propiedades

Métodos

Se aplica a

Consulte también

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Tutorial: Cambiar el lugar en el que My.Application.Log escribe la información