FileLogTraceListener Clase

Definición

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

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

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 Visual Basic aplicaciones. 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 .NET Framework aplicaciones, 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

FileLogTraceListener()

Inicializa una nueva instancia de la clase FileLogTraceListener con el nombre predeterminado.

FileLogTraceListener(String)

Inicializa una nueva instancia de la clase FileLogTraceListener con el nombre proporcionado.

Propiedades

Append

Determina si el resultado se va a anexar al archivo actual o se va a escribir en un archivo nuevo o existente.

Attributes

Obtiene los atributos de agente de escucha de seguimiento personalizados que están definidos en el archivo de configuración de la aplicación.

(Heredado de TraceListener)
AutoFlush

Indica si al escribir en el archivo de registro se vacía el búfer.

BaseFileName

Obtiene o establece el nombre base de los archivos de registro, que se utiliza para crear su nombre completo.

CustomLocation

Obtiene o establece el directorio del archivo de registro cuando el valor de la propiedad Location se establece en Custom.

Delimiter

Obtiene o establece el delimitador utilizado para delimitar los campos en un mensaje de registro.

DiskSpaceExhaustedBehavior

Determina qué debe hacerse cuando se escribe en el archivo de registro y hay menos espacio disponible en disco que el especificado por la propiedad ReserveDiskSpace.

Encoding

Obtiene o establece la codificación que se va a utilizar al crear un nuevo archivo de registro.

Filter

Obtiene o establece el filtro de seguimiento para el agente de escucha de seguimiento.

(Heredado de TraceListener)
FullLogFileName

Obtiene el nombre completo del archivo de registro actual.

IncludeHostName

Indica si el nombre de host del equipo de registro debe incluirse en el resultado.

IndentLevel

Obtiene o establece el nivel de sangría.

(Heredado de TraceListener)
IndentSize

Obtiene o establece el número de espacios de una sangría.

(Heredado de TraceListener)
IsThreadSafe

Obtiene un valor que indica si el agente de escucha de seguimiento es seguro para la ejecución de subprocesos.

(Heredado de TraceListener)
Location

Obtiene o establece la ubicación de los archivos de registro.

LogFileCreationSchedule

Determina qué fecha se va a incluir en los nombres de los archivos de registro.

MaxFileSize

Obtiene o establece el tamaño máximo permitido del archivo de registro, expresado en bytes.

Name

Obtiene o establece un nombre para este objeto TraceListener.

(Heredado de TraceListener)
NeedIndent

Obtiene o establece un valor que indica si se va a aplicar sangría a los resultados.

(Heredado de TraceListener)
ReserveDiskSpace

Obtiene o establece la cantidad necesaria de espacio disponible en disco, en bytes, para que los mensajes puedan escribirse en el archivo de registro.

TraceOutputOptions

Obtiene o establece las opciones de los resultados de seguimiento.

(Heredado de TraceListener)

Métodos

Close()

Cierra la secuencia subyacente del archivo de registro actual y libera los recursos asociados a la secuencia actual.

CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.

(Heredado de MarshalByRefObject)
Dispose()

Libera todos los recursos que usa TraceListener.

(Heredado de TraceListener)
Dispose(Boolean)

Cierra la secuencia subyacente y, de manera opcional, libera los recursos administrados.

Equals(Object)

Determina si el objeto especificado es igual que el objeto actual.

(Heredado de Object)
Fail(String)

Emite un mensaje de error para el agente de escucha que se crea al implementar la clase TraceListener.

(Heredado de TraceListener)
Fail(String, String)

Emite un mensaje de error y un mensaje de error detallado para el agente de escucha que se crea al implementar la clase TraceListener.

(Heredado de TraceListener)
Flush()

Vacía la secuencia subyacente que escribe en el archivo de registro actual.

GetHashCode()

Sirve como la función hash predeterminada.

(Heredado de Object)
GetLifetimeService()
Obsoleto.

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.

(Heredado de MarshalByRefObject)
GetSupportedAttributes()

Obtiene los atributos de configuración XML personalizados que admite el agente de escucha de seguimiento.

GetType()

Obtiene el Type de la instancia actual.

(Heredado de Object)
InitializeLifetimeService()
Obsoleto.

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.

(Heredado de MarshalByRefObject)
MemberwiseClone()

Crea una copia superficial del Object actual.

(Heredado de Object)
MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.

(Heredado de MarshalByRefObject)
ToString()

Devuelve una cadena que representa el objeto actual.

(Heredado de Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)

Escribe la información de seguimiento, un objeto de datos y la información de evento en el archivo de salida o el flujo de salida.

TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])

Escribe la información de seguimiento, una matriz de objetos de datos y la información de evento en el archivo de salida o el flujo de salida.

TraceEvent(TraceEventCache, String, TraceEventType, Int32)

Escribe la información de seguimiento y de evento en los resultados específicos del agente de escucha.

(Heredado de TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)

Escribe la información de seguimiento, un mensaje y la información de evento en el archivo de salida o el flujo de salida.

TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])

Escribe la información de seguimiento, una matriz de objetos con formato y la información de evento en el archivo de salida o el flujo de salida.

TraceTransfer(TraceEventCache, String, Int32, String, Guid)

Escribe la información de seguimiento, un mensaje, una identidad de actividad relacionada y la información de evento en los resultados específicos del agente de escucha.

(Heredado de TraceListener)
Write(Object)

Escribe el valor del método ToString() del objeto en el agente de escucha que se crea al implementar la clase TraceListener.

(Heredado de TraceListener)
Write(Object, String)

Escribe un nombre de categoría y el valor del método ToString() del objeto en el agente de escucha que se crea al implementar la clase TraceListener.

(Heredado de TraceListener)
Write(String)

Escribe literalmente un mensaje en el disco, sin información de contexto adicional.

Write(String, String)

Escribe un nombre de categoría y un mensaje en el agente de escucha que se crea al implementar la clase TraceListener.

(Heredado de TraceListener)
WriteIndent()

Escribe la sangría en el agente de escucha que se crea al implementar esta clase y restablece la propiedad NeedIndent en false.

(Heredado de TraceListener)
WriteLine(Object)

Escribe el valor del método ToString() del objeto en el agente de escucha que se crea al implementar la clase TraceListener, seguido de un terminador de línea.

(Heredado de TraceListener)
WriteLine(Object, String)

Escribe un nombre de categoría y el valor del método ToString() del objeto en el agente de escucha que se crea al implementar la clase TraceListener, seguidos de un terminador de línea.

(Heredado de TraceListener)
WriteLine(String)

Escribe un mensaje literal en el disco, seguido del terminador de línea actual y sin ninguna información de contexto adicional.

WriteLine(String, String)

Escribe un nombre de categoría y un mensaje en el agente de escucha que se crea al implementar la clase TraceListener, seguidos de un terminador de línea.

(Heredado de TraceListener)

Se aplica a

Consulte también