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

Eine instance von FileLogTraceListener kann der - oder Trace.Listeners -Auflistung hinzugefügt werden, um die Debug.Listeners Ausgabe von der Protokollierung in eine Textdatei umzuleiten. Instanzen dieser Klasse können auch zu My.Application.Log oder My.Log (für Webanwendungen) in Visual Basic-Anwendungen hinzugefügt werden. Weitere Informationen finden Sie unter Exemplarische Vorgehensweise: Ändern des Ortes, in den "My.Application.Log" Informationen schreibt.

Die Standard Features 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 den nachfolgenden Versionen des Protokolls zu unterscheiden. Neue Protokolldateien werden nach Bedarf erstellt.

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

   • Der baseName Teil ist der grundlegende Protokollname, der von der BaseFileName -Eigenschaft angegeben wird.

   • Der dateStamp Teil hat das Format "YYYY-MM-TT" und wird angezeigt, wenn LogFileCreationSchedule oder WeeklyistDaily.

   • Wenn mehrere Protokolldateien mit demselben baseName und dateStampbenötigt werden, wird der version Teil, ein positiver Integer, dem Dateinamen hinzugefügt.

2. Mehrere Klasseninstanzen. Wenn ein instance der FileLogTraceListener -Klasse in eine verwendete Datei schreibt:

   • Die -Klasse gibt die Datei frei, wenn sie von einem anderen instance der FileLogTraceListener -Klasse im selben Prozess verwendet wird.

   • Die -Klasse erstellt eine neue Protokolldatei mit dem nächsten verfügbaren Namen, wenn die Datei von einem anderen Prozess verwendet wird.

3. Threadsicherheit. Die FileLogTraceListener -Klasse ist threadsicher. Dadurch können Sie ohne Sperren sicher Nachrichten aus mehreren Threads in das Protokoll schreiben.

Speicherort der Protokolldatei

• Die Location -Eigenschaft verwendet eine LogFileLocation -Enumeration, um eines 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.

Name der Protokolldatei

• Der Basisname für die Protokolldatei wird von der BaseFileName -Eigenschaft angegeben.

• Der aktuelle Protokolldateiname kann aus der FullLogFileName -Eigenschaft gelesen werden. Es wird von mehreren anderen Eigenschaften und dem aktuellen Status der Protokolle im Dateisystem abgeleitet.

Protokollwartung

• Die Mindesthäufigkeit zum Erstellen neuer Protokolldateien wird durch die LogFileCreationSchedule -Eigenschaft bestimmt. Wenn der Wert oder WeeklyistDaily, wird mindestens einmal pro Tag oder Woche eine neue Protokolldatei erstellt, und ein Datumsstempel wird in den FullLogFileName Namen integriert.

• Die maximale Größe (in Bytes) der Protokolldatei wird durch die MaxFileSize -Eigenschaft bestimmt. Wenn die Größe der Protokolldatei diese Größe überschreitet, werden zusätzliche Nachrichten verworfen, die in das Protokoll geschrieben wurden, und je nach Eigenschaft DiskSpaceExhaustedBehavior wird eine Ausnahme ausgelöst.

• Die ReserveDiskSpace -Eigenschaft bestimmt, wie viel freier Speicherplatz (in Bytes) verfügbar sein muss. Dadurch wird sichergestellt, dass die Klasse nicht den FileLogTraceListener gesamten verfügbaren Speicherplatz belegt. Verwenden Sie die DiskSpaceExhaustedBehavior -Eigenschaft, um das Verhalten von Protokollschreibvorgängen anzugeben, wenn weniger als ReserveDiskSpace Bytes frei sind.

Protokolldateiausgabeeinstellungen

• Die AutoFlush -Eigenschaft gibt an, ob der zugrunde liegende Stream nach jedem Schreibvorgang in die Protokolldatei automatisch geleert werden soll.

• Die Append -Eigenschaft gibt an, ob Nachrichten an die aktuelle Protokolldatei angefügt oder in eine neue Protokolldatei geschrieben werden sollen.

• Die Delimiter -Eigenschaft gibt die Zeichenfolge an, die zum Trennen der Felder innerhalb einer Protokollmeldung verwendet werden soll.

• Die Encoding -Eigenschaft gibt die Codierung an, die beim Erstellen einer neuen Protokolldatei verwendet werden soll.

Protokolldateiausgabe

• Die TraceData Methoden und TraceEvent schreiben Nachrichten in die Protokolldatei. Diese Methoden überprüfen die LogFileCreationSchedule -Eigenschaft zusammen mit allen vorhandenen Protokollen mit demselben Basisnamen, um zu bestimmen, ob ein neues Protokoll erstellt werden soll.

• Die Flush -Methode leert alle Nachrichten, die sich derzeit im Ausgabepuffer befinden, in die Protokolldatei.

• Die Close -Methode schließt die Protokolldatei, sodass sie von anderen Prozessen verwendet werden kann.

Aktivieren der Ausgabe

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

• Um das Debuggen in C# zu aktivieren, fügen Sie das /d:DEBUG Flag der Compilerbefehlszeile hinzu, wenn Sie Ihren Code kompilieren, oder Sie können am Anfang der Datei hinzufügen #define DEBUG . Fügen Sie in Visual Basic der Compilerbefehlszeile das /d:DEBUG=True Flag hinzu.

• Um die Ablaufverfolgung in C# zu aktivieren, fügen Sie das /d:TRACE Flag der Compilerbefehlszeile hinzu, wenn Sie Ihren Code kompilieren, oder fügen Sie am Anfang der Datei hinzu #define TRACE . Fügen Sie in Visual Basic der Compilerbefehlszeile 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 sein.

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

Konstruktoren

Eigenschaften

Methoden

Gilt für:

Weitere Informationen

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Exemplarische Vorgehensweise: Ändern des Orts, in den „My.Application.Log“ Informationen schreibt