FileLogTraceListener Класс

Определение

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 предоставляет возможности автоматического обслуживания для архивации файлов журналов по мере необходимости на ежедневной основе или для каждого приложения. Эта функция автоматической архивации помогает сократить обязанности разработчиков и администраторов по обслуживанию.

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

Ниже перечислены main функции этого класса.

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

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

   • Часть baseName — это основное имя журнала, заданное свойством BaseFileName .

   • Часть dateStamp имеет формат "ГГГГ-ММ-ДД" и отображается, когда LogFileCreationSchedule имеет значение Daily или Weekly.

   • Если требуется несколько файлов журнала с одним и тем же baseName и dateStamp, version к имени файла добавляется часть , положительная Integer.

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

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

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

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

Расположение файла журнала

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

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

Имя файла журнала

• Базовое имя файла журнала указывается свойством BaseFileName .

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

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

• Минимальная частота создания новых файлов журнала определяется свойством LogFileCreationSchedule . Если значение равно Daily или Weekly, новый файл журнала создается по крайней мере один раз в день или неделю, а метка даты включается в FullLogFileName имя.

• Максимальный размер (в байтах) файла журнала определяется свойством MaxFileSize . Если размер файла журнала превышает этот размер, дополнительные сообщения, записанные в журнал, удаляются и, в зависимости DiskSpaceExhaustedBehavior от свойства, создается исключение.

• Свойство ReserveDiskSpace определяет, сколько свободного места (в байтах) должно быть доступно. Это гарантирует, что FileLogTraceListener класс не будет потреблять все доступное дисковое пространство. Используйте свойство , DiskSpaceExhaustedBehavior чтобы указать поведение операций записи в журнал при наличии меньше ReserveDiskSpace байтов.

Параметры вывода файла журнала

• Свойство AutoFlush указывает, следует ли автоматически очищать базовый поток после каждой записи в файл журнала.

• Свойство Append указывает, следует ли добавлять сообщения в текущий файл журнала, если это разрешено, или записывать их в новый файл журнала.

• Свойство Delimiter задает строку, используемую для разделения полей в сообщении журнала.

• Свойство Encoding задает кодировку, используемую при создании нового файла журнала.

Выходные данные файла журнала

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

• Метод Flush сбрасывает все сообщения, находящиеся в буфере вывода, в файл журнала.

• Метод Close закрывает файл журнала, чтобы его могли использовать другие процессы.

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

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

• Чтобы включить отладку /d:DEBUG в C#, добавьте флаг в командную строку компилятора при компиляции кода или добавьте #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>  

Для выполнения этого примера необходимо указать полное имя сборки. Сведения о том, как получить полное имя сборки, см. в разделе Имена сборок.

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

Свойства

Методы

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

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

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