FileLogTraceListener Clase

Definición

Proporciona un agente de escucha simple que dirige el resultado del registro a un archivo.Provides a simple listener that directs logging output to file.

public ref class FileLogTraceListener : System::Diagnostics::TraceListener
[System.Runtime.InteropServices.ComVisible(false)]
public class FileLogTraceListener : System.Diagnostics.TraceListener
type FileLogTraceListener = class
    inherit TraceListener
Public Class FileLogTraceListener
Inherits TraceListener
Herencia
FileLogTraceListener
Atributos

Comentarios

La clase FileLogTraceListener proporciona funciones de mantenimiento automatizado para archivar los archivos de registro según sea necesario, a diario o por aplicación.The FileLogTraceListener class provides automated maintenance capabilities to archive log files as needed, on a daily or per-application basis. Esta funcionalidad de archivo automático ayuda a reducir las responsabilidades de mantenimiento de los desarrolladores y administradores.This automatic archival functionality helps reduce the maintenance responsibilities of developers and administrators.

Se puede Agregar una instancia de FileLogTraceListener a las colecciones Debug.Listeners o Trace.Listeners para redirigir la salida del registro a un archivo de texto.An instance of FileLogTraceListener can be added to the Debug.Listeners or Trace.Listeners collections to redirect output from logging to a text file. Las instancias de esta clase también se pueden agregar a My.Application.Log o My.Log (para aplicaciones web) en Visual Basic aplicaciones.Instances of this class can also be added to My.Application.Log or My.Log (for Web applications) in Visual Basic applications. Para obtener más información, vea Tutorial: Cambiar el lugar en el que My. Application. log escribe información.For more information, see Walkthrough: Changing Where My.Application.Log Writes Information.

Las principales características de esta clase son:The main features of this class are:

  1. Funcionalidad de archivo.Archival functionality. 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 versiones sucesivas del registro.The log files generated by this class are named according to the base name and the date, along with a number to distinguish the log file from successive versions of the log. Se crean nuevos archivos de registro según sea necesario.New log files are created on an as-needed basis.

    La forma explícita del nombre de archivo es baseName[-dateStamp] [-version]. log, donde:The explicit form of the file name is baseName[-dateStamp][-version].log, where:

    • La parte baseName es el nombre de registro fundamental, especificado por la propiedad BaseFileName.The baseName part is the fundamental log name, specified by the BaseFileName property.

    • La parte dateStamp tiene el formato "AAAA-MM-DD" y se muestra cuando LogFileCreationSchedule está Daily o Weekly.The dateStamp part has the format "YYYY-MM-DD", and it is shown when LogFileCreationSchedule is Daily or Weekly.

    • Si se necesita más de un archivo de registro con el mismo baseName y dateStamp, la parte version, un Integerpositivo, se agrega al nombre de archivo.If more than one log file is needed with the same baseName and dateStamp, the version part, a positive Integer, is added to the file name.

  2. Varias instancias de clase.Multiple class instances. Si una instancia de la clase FileLogTraceListener escribe en un archivo que está en uso:If an instance of the FileLogTraceListener class writes to a file that is in use:

    • La clase comparte el archivo si lo está utilizando otra instancia de la clase FileLogTraceListener en el mismo proceso.The class shares the file if it is being used by another instance of the FileLogTraceListener class in the same process.

    • La clase crea un nuevo archivo de registro con el siguiente nombre disponible si otro proceso lo está usando.The class creates a new log file using the next available name if the file is being used by another process.

  3. Seguridad para subprocesos.Thread safety. La clase FileLogTraceListener es segura para subprocesos.The FileLogTraceListener class is thread safe. Esto le permite escribir mensajes en el registro de forma segura desde varios subprocesos sin usar bloqueos.This allows you to safely write messages to the log from multiple threads without using locks.

Ubicación del archivo de registroLog-File Location

  • La propiedad Location toma una enumeración LogFileLocation para especificar uno de los directorios típicos en los que se va a escribir el archivo de registro.The Location property takes a LogFileLocation enumeration to specify one of the typical directories to write the log file to.

  • Para escribir el registro en otra ubicación, establezca la propiedad CustomLocation en esa ubicación.To write the log to another location, set the CustomLocation property to that location.

Nombre del archivo de registroLog-File Name

  • La propiedad BaseFileName especifica el nombre base del archivo de registro.The base name for the log file is specified by the BaseFileName property.

  • El nombre del archivo de registro actual se puede leer en la propiedad FullLogFileName.The current log file name can be read from the FullLogFileName property. Se deriva de otras propiedades y del estado actual de los registros en el sistema de archivos.It is derived from several other properties and the current state of the logs in the file system.

Mantenimiento de registroLog Maintenance

  • La frecuencia mínima para crear nuevos archivos de registro viene determinada por la propiedad LogFileCreationSchedule.The minimum frequency for creating new log files is determined by the LogFileCreationSchedule property. 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 nombre de la FullLogFileName.When the value is Daily or Weekly, a new log file is created at least once every day or week, and a date stamp is incorporated into the FullLogFileName name.

  • La propiedad MaxFileSize determina el tamaño máximo (en bytes) del archivo de registro.The maximum size (in bytes) of the log file is determined by the MaxFileSize property. Si el tamaño del archivo de registro supera este tamaño, se descartan los mensajes adicionales que se escriben en el registro y, en función de la propiedad DiskSpaceExhaustedBehavior, se produce una excepción.If the log file size exceeds this size, additional messages written to the log are discarded and, depending on the DiskSpaceExhaustedBehavior property, an exception is thrown.

  • La propiedad ReserveDiskSpace determina la cantidad de espacio libre (en bytes) que debe estar disponible.The ReserveDiskSpace property determines how much free space (in bytes) must be available. Esto ayuda a garantizar que la clase FileLogTraceListener no consuma todo el espacio disponible en disco.This helps ensure that the FileLogTraceListener class will not consume all available disk space. Use la propiedad DiskSpaceExhaustedBehavior para especificar el comportamiento de las escrituras de registro cuando hay menos de ReserveDiskSpace bytes libres.Use the DiskSpaceExhaustedBehavior property to specify the behavior of log writes when there are less than ReserveDiskSpace bytes free.

Configuración de salida de archivo de registroLog-File Output Settings

  • La propiedad AutoFlush especifica si la secuencia subyacente se debe vaciar automáticamente después de cada escritura en el archivo de registro.The AutoFlush property specifies whether the underlying stream should be flushed automatically after each write to the log file.

  • La propiedad Append especifica si se deben anexar mensajes al archivo de registro actual, si están permitidos, o escribirlos en un nuevo archivo de registro.The Append property specifies whether to append messages to the current log file, if allowed, or write them to a new log file.

  • La propiedad Delimiter especifica la cadena que se va a usar para delimitar los campos dentro de un mensaje de registro.The Delimiter property specifies the string to use for delimiting the fields within a log message.

  • La propiedad Encoding especifica la codificación que se va a utilizar al crear un nuevo archivo de registro.The Encoding property specifies the encoding to use when creating a new log file.

Salida del archivo de registroLog-File Output

  • Los métodos TraceData y TraceEvent escriben mensajes en el archivo de registro.The TraceData and TraceEvent methods write messages to the log file. Estos métodos comprueban la propiedad LogFileCreationSchedule, junto con los registros existentes con el mismo nombre base para determinar si se debe crear un nuevo registro.These methods check the LogFileCreationSchedule property, along with any existing logs with the same base name to determine if a new log should be created.

  • El método Flush vacía los mensajes que están actualmente en el búfer de salida en el archivo de registro.The Flush method flushes any messages currently in the output buffer to the log file.

  • El método Close cierra el archivo de registro para que lo puedan usar otros procesos.The Close method closes the log file so that it can be used by other processes.

Habilitar resultadosEnabling Output

Debe habilitar el seguimiento o la depuración para utilizar un agente de escucha de seguimiento.You must enable tracing or debugging to use a trace listener. La sintaxis siguiente es específica del compilador.The following syntax is compiler specific. Si utiliza compiladores distintos de C# o Visual Basic, consulte la documentación del compilador.If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • Para habilitar la depuración en C#, agregue la marca/d:DEBUGa la línea de comandos del compilador al compilar el código o puede Agregar#define DEBUGa la parte superior del archivo.To enable debugging in C#, add the /d:DEBUG flag to the compiler command line when you compile your code, or you can add #define DEBUG to the top of your file. En Visual Basic, agregue la marca de /d:DEBUG=True a la línea de comandos del compilador.In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • Para habilitar el seguimiento C#en, agregue la marca/d:TRACEa la línea de comandos del compilador al compilar el código o agregue#define TRACEen la parte superior del archivo.To enable tracing in C#, add the /d:TRACE flag to the compiler command line when you compile your code, or add #define TRACE to the top of your file. En Visual Basic, agregue la marca de /d:TRACE=True a la línea de comandos del compilador.In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

Para establecer el nivel del agente de escucha, edite el archivo de configuración de la aplicación.To set the level of your listener, edit the configuration file for your application. 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 previamente establecidos por la aplicación.Within this file, you can add a listener, set its type and set its parameters, remove a listener, or clear all the listeners previously set by the application. El archivo de configuración debe tener el formato del siguiente ejemplo.The configuration file should be formatted like the following example.

Para que este ejemplo se ejecute, debe proporcionar el nombre completo del ensamblado.For this example to run, you must provide the fully qualified assembly name. Para obtener información sobre cómo obtener el nombre completo del ensamblado, vea nombres de ensamblados.For information about how to obtain the fully qualified assembly name, see Assembly Names.

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

Constructores

FileLogTraceListener()

Inicializa una nueva instancia de la clase FileLogTraceListener con el nombre predeterminado.Initializes a new instance of the FileLogTraceListener class with the default name.

FileLogTraceListener(String)

Inicializa una nueva instancia de la clase FileLogTraceListener con el nombre proporcionado.Initializes a new instance of the FileLogTraceListener class with the supplied name.

Propiedades

Append

Determina si el resultado se va a anexar al archivo actual o se va a escribir en un archivo nuevo o existente.Determines whether to append the output to the current file or write it to a new or existing file.

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.Gets the custom trace listener attributes defined in the application configuration file.

(Heredado de TraceListener)
AutoFlush

Indica si al escribir en el archivo de registro se vacía el búfer.Indicates whether or not the writing to the log file stream flushes the buffer.

BaseFileName

Obtiene o establece el nombre base de los archivos de registro, que se utiliza para crear su nombre completo.Gets or sets the base name for the log files, which is used to create the full log-file name.

CustomLocation

Obtiene o establece el directorio del archivo de registro cuando el valor de la propiedad Location se establece en Custom.Gets or sets the log file directory when the Location property is set to Custom.

Delimiter

Obtiene o establece el delimitador utilizado para delimitar los campos en un mensaje de registro.Gets or sets the delimiter used to delimit fields within a log message.

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.Determines what to do when writing to the log file and there is less free disk space available than specified by the ReserveDiskSpace property.

Encoding

Obtiene o establece la codificación que se va a utilizar al crear un nuevo archivo de registro.Gets or sets the encoding to use when creating a new log file.

Filter

Obtiene o establece el filtro de seguimiento para el agente de escucha de seguimiento.Gets or sets the trace filter for the trace listener.

(Heredado de TraceListener)
FullLogFileName

Obtiene el nombre completo del archivo de registro actual.Gets the current full log-file name.

IncludeHostName

Indica si el nombre de host del equipo de registro debe incluirse en el resultado.Indicates whether or not the host name of the logging machine should be included in the output.

IndentLevel

Obtiene o establece el nivel de sangría.Gets or sets the indent level.

(Heredado de TraceListener)
IndentSize

Obtiene o establece el número de espacios de una sangría.Gets or sets the number of spaces in an indent.

(Heredado de TraceListener)
IsThreadSafe

Obtiene un valor que indica si el agente de escucha de seguimiento es seguro para la ejecución de subprocesos.Gets a value indicating whether the trace listener is thread safe.

(Heredado de TraceListener)
Location

Obtiene o establece la ubicación de los archivos de registro.Gets or sets location for the log files.

LogFileCreationSchedule

Determina qué fecha se va a incluir en los nombres de los archivos de registro.Determines which date to include in the names of the log files.

MaxFileSize

Obtiene o establece el tamaño máximo permitido del archivo de registro, expresado en bytes.Gets or sets the maximum allowed size of the log file, in bytes.

Name

Obtiene o establece un nombre para este objeto TraceListener.Gets or sets a name for this TraceListener.

(Heredado de TraceListener)
NeedIndent

Obtiene o establece un valor que indica si se va a aplicar sangría a los resultados.Gets or sets a value indicating whether to indent the output.

(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.Gets or sets the amount of free disk space, in bytes, necessary before messages can be written to the log file.

TraceOutputOptions

Obtiene o establece las opciones de los resultados de seguimiento.Gets or sets the trace output options.

(Heredado de TraceListener)

Métodos

Close()

Cierra la secuencia subyacente del archivo de registro actual y libera los recursos asociados a la secuencia actual.Closes the underlying stream for the current log file and releases any resources associated with the current stream.

CreateObjRef(Type)

Crea un objeto que contiene toda la información relevante necesaria para generar un proxy utilizado para comunicarse con un objeto remoto.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Heredado de MarshalByRefObject)
Dispose()

Libera todos los recursos que usa TraceListener.Releases all resources used by the TraceListener.

(Heredado de TraceListener)
Dispose(Boolean)

Cierra la secuencia subyacente y, de manera opcional, libera los recursos administrados.Closes the underlying stream and optionally releases the managed resources.

Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Heredado de Object)
Fail(String)

Emite un mensaje de error para el agente de escucha que se crea al implementar la clase TraceListener.Emits an error message to the listener you create when you implement the TraceListener class.

(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.Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class.

(Heredado de TraceListener)
Flush()

Vacía la secuencia subyacente que escribe en el archivo de registro actual.Flushes the underlying stream that writes to the current log file.

GetHashCode()

Sirve como función hash predeterminada.Serves as the default hash function.

(Heredado de Object)
GetLifetimeService()

Recupera el objeto de servicio de duración actual que controla la directiva de duración de esta instancia.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
GetSupportedAttributes()

Obtiene los atributos de configuración XML personalizados que admite el agente de escucha de seguimiento.Gets the custom XML configuration attributes supported by the trace listener.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
InitializeLifetimeService()

Obtiene un objeto de servicio de duración para controlar la directiva de duración de esta instancia.Obtains a lifetime service object to control the lifetime policy for this instance.

(Heredado de MarshalByRefObject)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
MemberwiseClone(Boolean)

Crea una copia superficial del objeto MarshalByRefObject actual.Creates a shallow copy of the current MarshalByRefObject object.

(Heredado de MarshalByRefObject)
ToString()

Devuelve un valor de tipo string que representa el objeto actual.Returns a string that represents the current object.

(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.Writes trace information, a data object, and event information to the output file or stream.

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.Writes trace information, an array of data objects, and event information to the output file or stream.

TraceEvent(TraceEventCache, String, TraceEventType, Int32)

Escribe la información de seguimiento y de evento en los resultados específicos del agente de escucha.Writes trace and event information to the listener specific output.

(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.Writes trace information, a message and event information to the output file or stream.

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.Writes trace information, a formatted array of objects, and event information to the output file or stream.

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.Writes trace information, a message, a related activity identity and event information to the listener specific output.

(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.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(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.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Heredado de TraceListener)
Write(String)

Escribe literalmente un mensaje en el disco, sin información de contexto adicional.Writes a verbatim message to disk, without any additional context information.

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.Writes a category name and a message to the listener you create when you implement the TraceListener class.

(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.Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to 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.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class, followed by a line terminator.

(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.Writes a category name and the value of the object's ToString() method to the listener you create when you implement the TraceListener class, followed by a line terminator.

(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.Writes a verbatim message to disk, followed by the current line terminator, without any additional context information.

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.Writes a category name and a message to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Heredado de TraceListener)

Se aplica a

Consulte también: