FileLogTraceListener Klasse

Definition

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

Vererbung

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Attribute

ComVisibleAttribute

Hinweise

Die FileLogTraceListener Klasse bietet automatisierte Wartungsfunktionen, um Protokolldateien nach Bedarf täglich oder pro Anwendung zu archivieren. Diese automatische Archivierungsfunktion trägt dazu bei, die Wartungsaufgaben von Entwicklern und Administratoren zu verringern.

Eine Instanz von FileLogTraceListener kann den Auflistungen Trace.Listeners hinzugefügt werden, um die Ausgabe von der Debug.Listeners Protokollierung an eine Textdatei umzuleiten. Instanzen dieser Klasse können auch zu Oder My.Log (für Webanwendungen) in Visual Basic-Anwendungen hinzugefügt My.Application.Log werden. Weitere Informationen finden Sie unter Walkthrough: Changing Where My.Application.Log Writes Information.

Die Hauptmerkmale dieser Klasse sind:

1. Archivierungsfunktionen. Die von dieser Klasse generierten Protokolldateien werden nach dem Basisnamen und dem Datum benannt, zusammen mit einer Zahl, um die Protokolldatei von aufeinander folgenden Versionen des Protokolls zu unterscheiden. Neue Protokolldateien werden nach Bedarf erstellt.

   Die explizite Form des Dateinamens lautet baseName[-dateStamp][-version].log, wobei:

   • Der baseName Teil ist der grundlegende Protokollname, der von der BaseFileName Eigenschaft angegeben wird.
   • Der dateStamp Teil hat das Format "JJJJ-MM-DD", und es wird angezeigt, wann LogFileCreationSchedule oder DailyWeekly.
   • Wenn mehrere Protokolldateien mit demselben baseName und dateStampdem version Teil benötigt werden, wird dem Dateinamen ein positiver IntegerWert hinzugefügt.

2. Mehrere Klasseninstanzen. Wenn eine Instanz der FileLogTraceListener Klasse in eine datei schreibt, die verwendet wird:

   • Die Klasse gibt die Datei frei, wenn sie von einer anderen Instanz der FileLogTraceListener Klasse im selben Prozess verwendet wird.
   • Die Klasse erstellt eine neue Protokolldatei unter Verwendung des nächsten verfügbaren Namens, wenn die Datei von einem anderen Prozess verwendet wird.

3. Threadsicherheit. Die FileLogTraceListener Klasse ist threadsicher. Auf diese Weise können Sie Nachrichten sicher aus mehreren Threads in das Protokoll schreiben, ohne Sperren zu verwenden.

standortLog-File

• Die Location Eigenschaft verwendet eine Aufzählung, um eines LogFileLocation der typischen Verzeichnisse anzugeben, in die die Protokolldatei geschrieben werden soll.

• Um das Protokoll an einen anderen Speicherort zu schreiben, legen Sie die CustomLocation Eigenschaft auf diesen Speicherort fest.

Log-File Name

• Der Basisname für die Protokolldatei wird durch die BaseFileName Eigenschaft angegeben.
• Der aktuelle Protokolldateiname kann aus der FullLogFileName Eigenschaft gelesen werden. Sie wird von mehreren anderen Eigenschaften und dem aktuellen Status der Protokolle im Dateisystem abgeleitet.

Protokollwartung

• Die Mindesthäufigkeit für das Erstellen neuer Protokolldateien wird durch die LogFileCreationSchedule Eigenschaft bestimmt. Wenn der Wert oder DailyWeekly, wird mindestens einmal täglich oder woche eine neue Protokolldatei erstellt, und ein Datumsstempel wird in den FullLogFileName Namen integriert.
• Die maximale Größe (in Byte) der Protokolldatei wird durch die MaxFileSize Eigenschaft bestimmt. Wenn die Größe der Protokolldatei diese Größe überschreitet, werden zusätzliche Nachrichten, die in das Protokoll geschrieben wurden, verworfen und je nach DiskSpaceExhaustedBehavior Eigenschaft wird eine Ausnahme ausgelöst.
• Die ReserveDiskSpace Eigenschaft bestimmt, wie viel freier Speicherplatz (in Bytes) verfügbar sein muss. Dadurch wird sichergestellt, dass die FileLogTraceListener Klasse nicht den gesamten verfügbaren Speicherplatz belegt. Verwenden Sie die DiskSpaceExhaustedBehavior Eigenschaft, um das Verhalten von Protokollschreibvorgängen anzugeben, wenn weniger als ReserveDiskSpace Byte frei sind.

Log-File Ausgabeeinstellungen

• Die AutoFlush Eigenschaft gibt an, ob der zugrunde liegende Datenstrom nach jedem Schreiben in die Protokolldatei automatisch geleert werden soll.
• Die Append Eigenschaft gibt an, ob Nachrichten an die aktuelle Protokolldatei angefügt werden sollen, falls zulässig, oder in eine neue Protokolldatei schreiben.
• Die Delimiter Eigenschaft gibt die Zeichenfolge an, die zum Trennen der Felder in einer Protokollnachricht verwendet werden soll.
• Die Encoding Eigenschaft gibt die Codierung an, die beim Erstellen einer neuen Protokolldatei verwendet werden soll.

Log-File Ausgabe

• Die TraceData Und TraceEvent Methoden schreiben Nachrichten in die Protokolldatei. Diese Methoden überprüfen die LogFileCreationSchedule Eigenschaft zusammen mit vorhandenen Protokollen mit demselben Basisnamen, um festzustellen, ob ein neues Protokoll erstellt werden soll.
• Die Flush Methode löscht alle Nachrichten, die sich derzeit im Ausgabepuffer befinden, in die Protokolldatei.
• Die Close Methode schließt die Protokolldatei, damit sie von anderen Prozessen verwendet werden kann.

Aktivieren der Ausgabe

Sie müssen die Ablaufverfolgung oder das Debuggen aktivieren, um einen Ablaufverfolgungslistener zu verwenden. Die folgende Syntax ist compilerspezifisch. Wenn Sie andere Compiler als C# oder Visual Basic verwenden, lesen Sie die Dokumentation für den Compiler.

• Um das Debuggen in C# zu aktivieren, fügen Sie die /d:DEBUG Kennzeichnung der Compiler-Befehlszeile hinzu, wenn Sie den Code kompilieren, oder Sie können am Anfang der Datei hinzufügen #define DEBUG . Fügen Sie in Visual Basic der Compiler-Befehlszeile das /d:DEBUG=True Flag hinzu.
• Um die Ablaufverfolgung in C# zu aktivieren, fügen Sie die /d:TRACE Kennzeichnung der Compiler-Befehlszeile hinzu, wenn Sie den Code kompilieren oder am Anfang der Datei hinzufügen #define TRACE . Fügen Sie in Visual Basic der Compiler-Befehlszeile das /d:TRACE=True Flag hinzu.

In .NET Framework-Apps können Sie die Ebene Ihres Listeners festlegen, indem Sie die Konfigurationsdatei für Ihre Anwendung bearbeiten. In dieser Datei können Sie einen Listener hinzufügen, dessen Typ festlegen und seine Parameter festlegen, einen Listener entfernen oder alle listener löschen, die zuvor von der Anwendung festgelegt wurden. Die Konfigurationsdatei sollte wie im folgenden Beispiel formatiert werden.

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

Damit dieses Beispiel ausgeführt werden kann, müssen Sie den vollqualifizierten Assemblynamen angeben. Informationen zum Abrufen des vollqualifizierten Assemblynamens finden Sie unter Assemblynamen.

Weitere Informationen

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Anleitung: Ändern, wo My.Application.Log Informationen schreibt