FileLogTraceListener Класс

Определение

Пространство имен:

Microsoft.VisualBasic.Logging

Сборка:

Microsoft.VisualBasic.Forms.dll

Исходный код:

FileLogTraceListener.vb

Предоставляет простой прослушиватель, который направляет выходные данные ведения журнала в файл.

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

Наследование

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Атрибуты

ComVisibleAttribute

Комментарии

Класс FileLogTraceListener предоставляет возможности автоматического обслуживания для архивации файлов журналов по мере необходимости на основе ежедневного или каждого приложения. Эта функция автоматического архивации помогает сократить обязанности по обслуживанию разработчиков и администраторов.

Экземпляр можно добавить в Debug.Listeners или Trace.Listeners коллекции для перенаправления выходных FileLogTraceListener данных из ведения журнала в текстовый файл. Экземпляры этого класса также можно добавлять в My.Application.Log приложения Visual Basic или My.Log (для веб-приложений). Дополнительные сведения см. в пошаговом руководстве. Изменение места записи сведений my.Application.Log.

Основными функциями этого класса являются:

1. Функции архивации. Файлы журнала, созданные этим классом, называются в соответствии с базовым именем и датой, а также числом, чтобы отличить файл журнала от последовательных версий журнала. Новые файлы журнала создаются по мере необходимости.

   Явная форма имени файла — baseName[-dateStamp][-version].log, где:

   • Часть baseName — это базовое имя журнала, указанное свойством BaseFileName .
   • Часть dateStamp имеет формат YYYY-MM-DD, и отображается, когда LogFileCreationSchedule это Daily или Weekly.
   • Если требуется несколько файлов журнала с одним и тем же baseNamedateStampversion, а часть — положительнымInteger, добавляется в имя файла.

2. Несколько экземпляров классов. Если экземпляр FileLogTraceListener класса записывается в используемый файл:

   • Класс использует файл, если он используется другим экземпляром FileLogTraceListener класса в том же процессе.
   • Класс создает новый файл журнала, используя следующее доступное имя, если файл используется другим процессом.

3. Безопасность потоков. Класс FileLogTraceListener является потокобезопасной. Это позволяет безопасно записывать сообщения в журнал из нескольких потоков без использования блокировок.

расположениеLog-File

• Свойство Location принимает LogFileLocation перечисление, чтобы указать один из типичных каталогов для записи файла журнала в.

• Чтобы записать журнал в другое расположение, задайте CustomLocation для свойства значение этого расположения.

имяLog-File

• Базовое имя файла журнала указывается свойством BaseFileName .
• Текущее имя файла журнала можно считывать из FullLogFileName свойства. Он является производным от нескольких других свойств и текущего состояния журналов в файловой системе.

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

• Минимальная частота создания новых файлов журнала определяется свойством LogFileCreationSchedule . При значении Daily или Weeklyсоздании нового файла журнала по крайней мере один раз в день или неделю, а метка даты включается в FullLogFileName имя.
• Максимальный размер файла журнала (в байтах) определяется свойством MaxFileSize . Если размер файла журнала превышает этот размер, дополнительные сообщения, записанные в журнал, удаляются и в зависимости от DiskSpaceExhaustedBehavior свойства возникает исключение.
• Свойство ReserveDiskSpace определяет, сколько свободного пространства (в байтах) должно быть доступно. Это помогает убедиться, что FileLogTraceListener класс не будет потреблять все доступное место на диске. DiskSpaceExhaustedBehavior Используйте свойство, чтобы указать поведение записи журналов при наличии меньше ReserveDiskSpace байтов бесплатно.

параметры выводаLog-File

• Свойство AutoFlush указывает, следует ли автоматически сбрасывать базовый поток после каждой записи в файл журнала.
• Свойство Append указывает, следует ли добавлять сообщения в текущий файл журнала, если разрешено, или записывать их в новый файл журнала.
• Свойство Delimiter задает строку, используемую для разделителя полей в сообщении журнала.
• Свойство Encoding указывает кодировку, используемую при создании нового файла журнала.

выходные данныеLog-File

• TraceEvent Методы TraceData записи сообщений в файл журнала. Эти методы проверяют LogFileCreationSchedule свойство, а также все существующие журналы с тем же базовым именем, чтобы определить, следует ли создать новый журнал.
• Метод Flush очищает все сообщения в выходном буфере в файл журнала.
• Метод Close закрывает файл журнала, чтобы его можно было использовать другими процессами.

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

Необходимо включить трассировку или отладку для использования прослушивателя трассировки. Следующий синтаксис является определенным компилятором. Если вы используете компиляторы, отличные от C# или Visual Basic, обратитесь к документации для компилятора.

• Чтобы включить отладку в C#, добавьте /d:DEBUG флаг в командную строку компилятора при компиляции кода или добавьте #define DEBUG в начало файла. В Visual Basic добавьте /d:DEBUG=True флаг в командную строку компилятора.
• Чтобы включить трассировку в C#, добавьте /d:TRACE флаг в командную строку компилятора при компиляции кода или добавьте #define TRACE в начало файла. В Visual Basic добавьте /d:TRACE=True флаг в командную строку компилятора.

В приложениях .NET Framework можно задать уровень прослушивателя, изменив файл конфигурации для приложения. В этом файле можно добавить прослушиватель, задать тип и задать его параметры, удалить прослушиватель или очистить все прослушиватели, заданные приложением ранее. Файл конфигурации должен быть отформатирован, как показано в следующем примере.

<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(String)	Инициализирует новый экземпляр FileLogTraceListener класса с указанным именем.

Свойства

Имя	Описание
Append	Определяет, следует ли добавлять выходные данные в текущий файл или записывать его в новый или существующий файл.
AutoFlush	Указывает, очищает ли поток файлов журнала запись в буфер.
BaseFileName	Возвращает или задает базовое имя файлов журнала, которое используется для создания полного имени файла журнала.
CustomLocation	Возвращает или задает каталог файла журнала, если Location для свойства задано значение Custom.
Delimiter	Возвращает или задает разделитель, используемый для разделителя полей в сообщении журнала.
DiskSpaceExhaustedBehavior	Определяет, что делать при записи в файл журнала и доступно меньше свободного места на диске, чем указано свойством ReserveDiskSpace .
Encoding	Возвращает или задает кодировку, используемую при создании нового файла журнала.
FullLogFileName	Возвращает текущее полное имя файла журнала.
IncludeHostName	Указывает, следует ли включать имя узла компьютера ведения журнала в выходные данные.
Location	Возвращает или задает расположение для файлов журнала.
LogFileCreationSchedule	Определяет дату включения в имена файлов журнала.
MaxFileSize	Возвращает или задает максимальный допустимый размер файла журнала в байтах.
ReserveDiskSpace	Возвращает или задает объем свободного места на диске в байтах, необходимый для записи сообщений в файл журнала.

Методы

Имя	Описание
Close()	Закрывает базовый поток для текущего файла журнала и освобождает все ресурсы, связанные с текущим потоком.
Dispose(Boolean)	Закрывает базовый поток и при необходимости освобождает управляемые ресурсы.
Flush()	Удаляет базовый поток, который записывается в текущий файл журнала.
GetSupportedAttributes()	Возвращает настраиваемые атрибуты конфигурации XML, поддерживаемые прослушивателем трассировки.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Записывает сведения трассировки, объект данных и сведения о событиях в выходной файл или поток.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Записывает данные трассировки, массив объектов данных и сведения о событиях в выходной файл или поток.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Записывает данные трассировки, форматированный массив объектов и сведения о событиях в выходной файл или поток.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Записывает сведения трассировки, сообщения и события в выходной файл или поток.
Write(String)	Записывает подробное сообщение на диск без дополнительных сведений о контексте.
WriteLine(String)	Записывает подробное сообщение на диск, за которым следует текущий терминатор строки без дополнительных сведений о контексте.

См. также раздел

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Пошаговое руководство по изменению места записи информации в My.Application.Log