Exportar (0) Imprimir
Expandir todo

FileLogTraceListener (Clase)

Actualización: noviembre 2007

Proporciona un agente de escucha simple que dirige el resultado de registro a un archivo.

Espacio de nombres:  Microsoft.VisualBasic.Logging
Ensamblado:  Microsoft.VisualBasic (en Microsoft.VisualBasic.dll)

[ComVisibleAttribute(false)]
public class FileLogTraceListener : TraceListener
/** @attribute ComVisibleAttribute(false) */
public class FileLogTraceListener extends TraceListener
public class FileLogTraceListener extends TraceListener

La clase FileLogTraceListener proporciona las funciones de mantenimiento automatizadas para almacenar los archivos de registro según sea necesario, diariamente o por aplicación. Esta funcionalidad de archivado automático ayuda a reducir las responsabilidades de mantenimiento de los desarrolladores y administradores.

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

Las principales características de esta clase son:

  1. Funcionalidad de archivado. A los archivos de registro generados por esta clase se les asigna un nombre basándose en el nombre base y la fecha, junto con un número para diferenciar el archivo de registro de las versiones sucesivas del registro. Se crean nuevos archivos de registro según sean necesarios.

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

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

    • dateStamp 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 los mismos valores de baseName y dateStamp, se agrega version, un valor positivo de tipo Integer, al nombre de archivo.

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

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

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

  3. Seguridad para subprocesos. La clase FileLogTraceListener es segura para subprocesos. Esto permite escribir sin ningún riesgo mensajes en el registro desde varios subprocesos sin utilizar bloqueos.

Ubicación del archivo de registro

  • La propiedad Location toma una enumeración LogFileLocation para especificar uno de los directorios comunes donde se escribe el archivo de registro.

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

Nombre del archivo de registro

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

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

Mantenimiento de registros

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

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

  • La propiedad ReserveDiskSpace determina cuánto espacio disponible (en bytes) debe haber. Esto ayuda a garantizar que la clase FileLogTraceListener no utilizará todo el espacio disponible en disco. Utilice la propiedad DiskSpaceExhaustedBehavior para especificar el comportamiento de las escrituras de registro cuando el espacio disponible, en bytes, es menor que ReserveDiskSpace.

Configuración de salida del archivo de registro

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

  • La propiedad Append especifica si los mensajes se van a anexar al archivo de registro actual, si está permitido, o si se van a escribir en un nuevo archivo de registro.

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

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

Salida del archivo de registro

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

  • El método Flush vuelca todos los mensajes que están actualmente en el búfer de salida al archivo de registro.

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

Habilitar la salida

Es preciso habilitar el seguimiento o la depuración para poder utilizar un agente de escucha de seguimiento. La sintaxis siguiente es específica del compilador. Si se utilizan compiladores que no sean C# o Visual Basic, consulte la documentación del compilador.

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

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

Para establecer el nivel del agente de escucha, edite el archivo de configuración de la aplicación. En este archivo, se podrá agregar un agente de escucha, establecer el tipo de agente y sus parámetros, quitar un agente o borrar todos los agentes definidos previamente por la aplicación. El archivo de configuración debería tener el formato que se muestra en el siguiente ejemplo.

Para poder ejecutar este ejemplo, deberá proporcionar el nombre completo del ensamblado. Para obtener información sobre cómo obtener el nombre completo del ensamblado, vea Nombres de ensamblado.

<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>

System.Object
  System.MarshalByRefObject
    System.Diagnostics.TraceListener
      Microsoft.VisualBasic.Logging.FileLogTraceListener

Todos los miembros static (Shared en Visual Basic) públicos de este tipo son seguros para la ejecución de subprocesos. No se garantiza que los miembros de instancias sean seguros para la ejecución de subprocesos.

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

.NET Framework y .NET Compact Framework no admiten todas las versiones de cada plataforma. Para obtener una lista de las versiones compatibles, vea Requisitos de sistema de .NET Framework.

.NET Framework

Compatible con: 3.5, 3.0, 2.0

Adiciones de comunidad

AGREGAR
Mostrar:
© 2014 Microsoft