FileLogTraceListener FileLogTraceListener FileLogTraceListener FileLogTraceListener Class

Определение

Предоставляет простой прослушиватель, который направляет вывод журнала в файл.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
Наследование
Атрибуты

Комментарии

FileLogTraceListener Класс предоставляет возможности по обслуживанию, автоматически архивировать файлы журналов, при необходимости на день или на уровне приложения.The FileLogTraceListener class provides automated maintenance capabilities to archive log files as needed, on a daily or per-application basis. Эти функции автоматической архивации помогает сократить обслуживания ответственности группы разработчиков и администраторов.This automatic archival functionality helps reduce the maintenance responsibilities of developers and administrators.

Экземпляр FileLogTraceListener могут добавляться к Debug.Listeners или Trace.Listeners коллекций для перенаправления выходных данных ведения журнала в текстовый файл.An instance of FileLogTraceListener can be added to the Debug.Listeners or Trace.Listeners collections to redirect output from logging to a text file. Экземпляры этого класса также добавляются в My.Application.Log или My.Log (для веб-приложений) в приложениях Visual Basic.Instances of this class can also be added to My.Application.Log or My.Log (for Web applications) in Visual Basic applications. Дополнительные сведения см. в разделе Пошаговое руководство: Изменение места записи информации для My.Application.Log.For more information, see Walkthrough: Changing Where My.Application.Log Writes Information.

Ниже приведены основные возможности этого класса.The main features of this class are:

  1. Функции архивации.Archival functionality. Файлы журналов, созданные этим классом присваиваются в соответствии с базовым именем и дату, а также номер для различения все последующие версии журнала в файле журнала.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. Новые файлы журнала создаются по мере необходимости.New log files are created on an as-needed basis.

    Явное имя файла имеет baseName[-dateStamp] [-version] .log, где:The explicit form of the file name is baseName[-dateStamp][-version].log, where:

    • baseName Входит имя фундаментальные журнала, заданное BaseFileName свойство.The baseName part is the fundamental log name, specified by the BaseFileName property.

    • dateStamp Часть имеет формат «Гггг-мм-дд», и он отображается, когда LogFileCreationScheduleDaily или Weekly.The dateStamp part has the format "YYYY-MM-DD", and it is shown when LogFileCreationSchedule is Daily or Weekly.

    • Если требуется несколько файлов журнала с тем же baseName и dateStamp, version часть положительное Integer, добавляется к имени файла.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. Несколько экземпляров класса.Multiple class instances. Если экземпляр FileLogTraceListener класс записывает в файл, который уже используется:If an instance of the FileLogTraceListener class writes to a file that is in use:

    • Класс совместно использует файл, если он используется другим экземпляром FileLogTraceListener класс в тот же процесс.The class shares the file if it is being used by another instance of the FileLogTraceListener class in the same process.

    • Класс создает новый файл журнала, используя следующее доступное имя, если файл уже используется другим процессом.The class creates a new log file using the next available name if the file is being used by another process.

  3. Потокобезопасность.Thread safety. FileLogTraceListener Класс является потокобезопасным.The FileLogTraceListener class is thread safe. Это позволяет безопасно записывать сообщения в журнал из нескольких потоков без использования блокировки.This allows you to safely write messages to the log from multiple threads without using locks.

Расположение файла журналаLog-File Location

  • Location Свойством LogFileLocation перечисления для указания одного из типичных каталоги для записи файла журнала.The Location property takes a LogFileLocation enumeration to specify one of the typical directories to write the log file to.

  • Для записи в журнал в другое расположение, задайте CustomLocation свойство к этому расположению.To write the log to another location, set the CustomLocation property to that location.

Имя файла журналаLog-File Name

  • Базовое имя для файла журнала задается BaseFileName свойство.The base name for the log file is specified by the BaseFileName property.

  • Имя текущего файла журнала могут быть считаны из FullLogFileName свойство.The current log file name can be read from the FullLogFileName property. Он является производным от еще несколько свойств и текущее состояние журнала в файловой системе.It is derived from several other properties and the current state of the logs in the file system.

Обслуживание журналаLog Maintenance

  • Минимальная частота создания новых файлов журнала определяется LogFileCreationSchedule свойство.The minimum frequency for creating new log files is determined by the LogFileCreationSchedule property. Если значение равно Daily или Weekly, новый файл журнала создается по крайней мере один раз каждый день или неделю, и Метка даты является частью 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.

  • Максимальный размер (в байтах) файла журнала определяется MaxFileSize свойство.The maximum size (in bytes) of the log file is determined by the MaxFileSize property. Если размер файла журнала превышает этот размер, дополнительные сообщения, записываемые в журнал отклоненных и, в зависимости от DiskSpaceExhaustedBehavior свойство, создается исключение.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.

  • ReserveDiskSpace Свойство определяет, какой объем свободного места (в байтах) должны быть доступны.The ReserveDiskSpace property determines how much free space (in bytes) must be available. Это позволит гарантировать, что FileLogTraceListener класс не использует свободное место на диске.This helps ensure that the FileLogTraceListener class will not consume all available disk space. Используйте DiskSpaceExhaustedBehavior свойство, чтобы указать поведение журнала записывает при наличии меньше, чем ReserveDiskSpace свободных байтов.Use the DiskSpaceExhaustedBehavior property to specify the behavior of log writes when there are less than ReserveDiskSpace bytes free.

Параметры выходного файла журналаLog-File Output Settings

  • AutoFlush Свойство указывает ли базовый поток должен очищаться автоматически после каждой операции записи в файл журнала.The AutoFlush property specifies whether the underlying stream should be flushed automatically after each write to the log file.

  • Append Свойство указывает, следует ли добавить сообщения к текущему файлу журнала, если это разрешено, или записывать их в новый файл журнала.The Append property specifies whether to append messages to the current log file, if allowed, or write them to a new log file.

  • Delimiter Свойство определяет строку, используемую для разграничения полей в сообщении журнала.The Delimiter property specifies the string to use for delimiting the fields within a log message.

  • Encoding Свойство указывает, кодировка, используемая при создании нового файла журнала.The Encoding property specifies the encoding to use when creating a new log file.

Вывод в файл журналаLog-File Output

  • TraceData И TraceEvent методы записывают сообщения в файл журнала.The TraceData and TraceEvent methods write messages to the log file. Эти методы проверяют LogFileCreationSchedule свойства, а также любые существующие журналы, с тем же базовым именем, чтобы определить, должен будет создан новый журнал.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.

  • Flush Метод очищает все сообщения, в настоящее время в буфер вывода в файле журнала.The Flush method flushes any messages currently in the output buffer to the log file.

  • Close Метод закрывает файл журнала, так что он может использоваться другими процессами.The Close method closes the log file so that it can be used by other processes.

Включение выходных данныхEnabling Output

Необходимо включить отладку, чтобы использовать прослушиватель трассировки или трассировки.You must enable tracing or debugging to use a trace listener. Следующий синтаксис зависит от компилятора.The following syntax is compiler specific. При использовании компиляторов, отличный от C# или Visual Basic, см. в документации по вашим компилятором.If you use compilers other than C# or Visual Basic, refer to the documentation for your compiler.

  • Чтобы включить отладку в C#, добавьте /d:DEBUG флаг в командную строку компилятора при компиляции кода, или можно добавить #define DEBUG в начало файла.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. В Visual Basic добавьте /d:DEBUG=True флаг в командную строку компилятора.In Visual Basic, add the /d:DEBUG=True flag to the compiler command line.

  • Чтобы включить трассировку в C#, добавьте /d:TRACE флаг в командную строку компилятора при компиляции кода, или добавьте #define TRACE в начало файла.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. В Visual Basic добавьте /d:TRACE=True флаг в командную строку компилятора.In Visual Basic, add the /d:TRACE=True flag to the compiler command line.

Чтобы задать уровень прослушивателя, измените файл конфигурации для приложения.To set the level of your listener, edit the configuration file for your application. В этом файле можно добавить прослушиватель, задайте для нее тип и параметры, удалить прослушиватель или удалить все прослушиватели, ранее установленный приложением.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. Файл конфигурации форматирования как в следующем примере.The configuration file should be formatted like the following example.

Для выполнения этого примера необходимо указать полное имя сборки.For this example to run, you must provide the fully qualified assembly name. Сведения о том, как получить полное имя сборки, см. в разделе имена сборок.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>  

Конструкторы

FileLogTraceListener() FileLogTraceListener() FileLogTraceListener() FileLogTraceListener()

Инициализирует новый экземпляр класса FileLogTraceListener с именем, используемым по умолчанию.Initializes a new instance of the FileLogTraceListener class with the default name.

FileLogTraceListener(String) FileLogTraceListener(String) FileLogTraceListener(String) FileLogTraceListener(String)

Инициализирует новый экземпляр класса FileLogTraceListener с использованием предоставленного имени.Initializes a new instance of the FileLogTraceListener class with the supplied name.

Свойства

Append Append Append Append

Определяет, следует ли добавить выходные данные в текущий файл или следует записать их в новый файл.Determines whether to append the output to the current file or write it to a new file.

Attributes Attributes Attributes Attributes

Получает настраиваемые атрибуты прослушивателя трассировки, определенные в файле конфигурации приложения.Gets the custom trace listener attributes defined in the application configuration file.

(Inherited from TraceListener)
AutoFlush AutoFlush AutoFlush AutoFlush

Указывает, очищается ли буфер при записи в файл журнала.Indicates whether or not the writing to the log file stream flushes the buffer.

BaseFileName BaseFileName BaseFileName BaseFileName

Получает или задает базовое имя файлов журнала, используемое для создания полного имени файлов журнала.Gets or sets the base name for the log files, which is used to create the full log-file name.

CustomLocation CustomLocation CustomLocation CustomLocation

Получает или задает каталог файлов журнала, если для свойства Location задано значение Custom.Gets or sets the log file directory when the Location property is set to Custom.

Delimiter Delimiter Delimiter Delimiter

Получает или задает разделитель, используемый для разделения полей в сообщении журнала.Gets or sets the delimiter used to delimit fields within a log message.

DiskSpaceExhaustedBehavior DiskSpaceExhaustedBehavior DiskSpaceExhaustedBehavior DiskSpaceExhaustedBehavior

Определяет, что делать при выполнении записи в файл журнала, когда на диске осталось меньше свободного места, чем указано в свойстве 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 Encoding Encoding Encoding

Получает или задает кодировку, которая должна использоваться при создании нового файла журнала.Gets or sets the encoding to use when creating a new log file.

Filter Filter Filter Filter

Получает или задает фильтр трассировки для прослушивателя трассировки.Gets or sets the trace filter for the trace listener.

(Inherited from TraceListener)
FullLogFileName FullLogFileName FullLogFileName FullLogFileName

Получает текущее полное имя файла журнала.Gets the current full log-file name.

IncludeHostName IncludeHostName IncludeHostName IncludeHostName

Указывает, следует ли включать в выходные данные имя сайта компьютера, на котором ведется журнал.Indicates whether or not the host name of the logging machine should be included in the output.

IndentLevel IndentLevel IndentLevel IndentLevel

Возвращает или задает уровень отступа.Gets or sets the indent level.

(Inherited from TraceListener)
IndentSize IndentSize IndentSize IndentSize

Возвращает или задает число пробелов в отступе.Gets or sets the number of spaces in an indent.

(Inherited from TraceListener)
IsThreadSafe IsThreadSafe IsThreadSafe IsThreadSafe

Получает значение, указывающее, является ли прослушиватель трассировки потокобезопасным.Gets a value indicating whether the trace listener is thread safe.

(Inherited from TraceListener)
Location Location Location Location

Получает или задает расположение файлов журнала.Gets or sets location for the log files.

LogFileCreationSchedule LogFileCreationSchedule LogFileCreationSchedule LogFileCreationSchedule

Определяет, какую дату включать в имена файлов журнала.Determines which date to include in the names of the log files.

MaxFileSize MaxFileSize MaxFileSize MaxFileSize

Получает или задает максимальный допустимый размер файла журнала (в байтах).Gets or sets the maximum allowed size of the log file, in bytes.

Name Name Name Name

Возвращает или задает имя данного TraceListener.Gets or sets a name for this TraceListener.

(Inherited from TraceListener)
NeedIndent NeedIndent NeedIndent NeedIndent

Возвращает или задает значение, показывающее, нужен ли отступ в выходных данных.Gets or sets a value indicating whether to indent the output.

(Inherited from TraceListener)
ReserveDiskSpace ReserveDiskSpace ReserveDiskSpace ReserveDiskSpace

Получает или задает объем необходимого свободного дискового пространства в байтах перед записью сообщений в файл журнала.Gets or sets the amount of free disk space, in bytes, necessary before messages can be written to the log file.

TraceOutputOptions TraceOutputOptions TraceOutputOptions TraceOutputOptions

Возвращает или задает параметры выхода трассировки.Gets or sets the trace output options.

(Inherited from TraceListener)

Методы

Close() Close() Close() Close()

Закрывает основной поток для текущего файла журнала и освобождает все ресурсы, связанные с текущим потоком.Closes the underlying stream for the current log file and releases any resources associated with the current stream.

CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type) CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Inherited from MarshalByRefObject)
Dispose() Dispose() Dispose() Dispose()

Освобождает все ресурсы, занятые модулем TraceListener.Releases all resources used by the TraceListener.

(Inherited from TraceListener)
Dispose(Boolean) Dispose(Boolean) Dispose(Boolean) Dispose(Boolean)

Закрывает основной поток и при необходимости освобождает управляемые ресурсы.Closes the underlying stream and optionally releases the managed resources.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Fail(String) Fail(String) Fail(String) Fail(String)

Посылает сообщение об ошибке в прослушиватель, создаваемый при реализации класса TraceListener.Emits an error message to the listener you create when you implement the TraceListener class.

(Inherited from TraceListener)
Fail(String, String) Fail(String, String) Fail(String, String) Fail(String, String)

Выдает простое и подробное сообщения об ошибке в прослушиватель, создаваемый при реализации класса TraceListener.Emits an error message and a detailed error message to the listener you create when you implement the TraceListener class.

(Inherited from TraceListener)
Flush() Flush() Flush() Flush()

Очищает основной поток, выполняющий запись в текущий файл журнала.Flushes the underlying stream that writes to the current log file.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetLifetimeService() GetLifetimeService() GetLifetimeService() GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
GetSupportedAttributes() GetSupportedAttributes() GetSupportedAttributes() GetSupportedAttributes()

Возвращает настраиваемые атрибуты конфигурации XML, поддерживаемые прослушивателем трассировки.Gets the custom XML configuration attributes supported by the trace listener.

GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService() InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Inherited from MarshalByRefObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean) MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Inherited from MarshalByRefObject)
ToString() ToString() ToString() ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)
TraceData(TraceEventCache, String, TraceEventType, Int32, Object) TraceData(TraceEventCache, String, TraceEventType, Int32, Object) TraceData(TraceEventCache, String, TraceEventType, Int32, Object) TraceData(TraceEventCache, String, TraceEventType, Int32, Object)

Записывает сведения трассировки, объект данных и сведения о событии в исходящий файл или поток.Writes trace information, a data object, and event information to the output file or stream.

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

Записывает сведения трассировки, массив объектов данных и сведения о событии в выходной файл или поток.Writes trace information, an array of data objects, and event information to the output file or stream.

TraceEvent(TraceEventCache, String, TraceEventType, Int32) TraceEvent(TraceEventCache, String, TraceEventType, Int32) TraceEvent(TraceEventCache, String, TraceEventType, Int32) TraceEvent(TraceEventCache, String, TraceEventType, Int32)

Записывает сведения трассировки и сведения о событиях в специфические выходные данные прослушивателя.Writes trace and event information to the listener specific output.

(Inherited from TraceListener)
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String) TraceEvent(TraceEventCache, String, TraceEventType, Int32, String) TraceEvent(TraceEventCache, String, TraceEventType, Int32, String) TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)

Записывает сведения трассировки, сообщение и сведения о событии в выходной файл или поток.Writes trace information, a message and event information to the output file or stream.

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

Записывает сведения трассировки, форматированный массив объектов данных и сведения о событии в исходящий файл или поток.Writes trace information, a formatted array of objects, and event information to the output file or stream.

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

Записывает сведения трассировки, сообщение, идентификатор сопутствующего действия и сведения о событиях в специфические выходные данные прослушивателя.Writes trace information, a message, a related activity identity and event information to the listener specific output.

(Inherited from TraceListener)
Write(Object) Write(Object) Write(Object) Write(Object)

Записывает значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса TraceListener.Writes the value of the object's ToString() method to the listener you create when you implement the TraceListener class.

(Inherited from TraceListener)
Write(Object, String) Write(Object, String) Write(Object, String) Write(Object, String)

Записывает имя категории и значение метода ToString() объекта в прослушиватель, создаваемый при реализации класса 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.

(Inherited from TraceListener)
Write(String) Write(String) Write(String) Write(String)

Дословно записывает сообщение на диск без какой-либо дополнительной контекстной информации.Writes a verbatim message to disk, without any additional context information.

Write(String, String) Write(String, String) Write(String, String) Write(String, String)

Записывает имя категории и сообщение в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and a message to the listener you create when you implement the TraceListener class.

(Inherited from TraceListener)
WriteIndent() WriteIndent() WriteIndent() WriteIndent()

Записывает отступ в прослушиватель, создаваемый при реализации этого класса, и восстанавливает свойству NeedIndent значение false.Writes the indent to the listener you create when you implement this class, and resets the NeedIndent property to false.

(Inherited from TraceListener)
WriteLine(Object) WriteLine(Object) WriteLine(Object) WriteLine(Object)

Записывает значение метода ToString() объекта, заканчивающееся знаком ограничителя строки, в прослушиватель, создаваемый при реализации класса TraceListener.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.

(Inherited from TraceListener)
WriteLine(Object, String) WriteLine(Object, String) WriteLine(Object, String) WriteLine(Object, String)

Записывает имя категории и значение метода ToString() объекта, заканчивающееся знаком ограничителя строки, в прослушиватель, создаваемый при реализации класса 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, followed by a line terminator.

(Inherited from TraceListener)
WriteLine(String) WriteLine(String) WriteLine(String) WriteLine(String)

Дословно записывает сообщение на диск без какой-либо дополнительной контекстной информации, после сообщения ставится текущий разделитель строк.Writes a verbatim message to disk, followed by the current line terminator, without any additional context information.

WriteLine(String, String) WriteLine(String, String) WriteLine(String, String) WriteLine(String, String)

Записывает имя категории и сообщение, заканчивающееся знаком ограничителя строки, в прослушиватель, создаваемый при реализации класса TraceListener.Writes a category name and a message to the listener you create when you implement the TraceListener class, followed by a line terminator.

(Inherited from TraceListener)

Применяется к

Дополнительно