FileLogTraceListener Klas

Definitie

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

Overname

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Kenmerken

ComVisibleAttribute

Opmerkingen

De FileLogTraceListener klasse biedt geautomatiseerde onderhoudsmogelijkheden voor het archiveren van logboekbestanden indien nodig, dagelijks of per toepassing. Deze automatische archiveringsfunctionaliteit helpt de onderhoudsverantwoordelijkheden van ontwikkelaars en beheerders te verminderen.

Een exemplaar van FileLogTraceListener kan worden toegevoegd aan de Debug.Listeners verzamelingen om Trace.Listeners uitvoer om te leiden van logboekregistratie naar een tekstbestand. Exemplaren van deze klasse kunnen ook worden toegevoegd aan My.Application.Log of My.Log (voor webtoepassingen) in Visual Basic toepassingen. Zie Walkthrough: Wijzigen waar My.Application.Log informatie schrijft voor meer informatie.

De belangrijkste functies van deze klasse zijn:

1. Archiveringsfunctionaliteit. De logboekbestanden die door deze klasse worden gegenereerd, hebben een naam op basis van de basisnaam en de datum, samen met een getal om het logboekbestand te onderscheiden van opeenvolgende versies van het logboek. Nieuwe logboekbestanden worden zo nodig gemaakt.

   De expliciete vorm van de bestandsnaam is baseName[-dateStamp][-version].log, waarbij:

   • Het baseName onderdeel is de fundamentele logboeknaam die is opgegeven door de BaseFileName eigenschap.
   • Het dateStamp onderdeel heeft de notatie 'JJJJ-MM-DD' en wordt weergegeven wanneer LogFileCreationScheduleDaily of Weekly.
   • Als er meer dan één logboekbestand nodig is met hetzelfde baseName en dateStamp, het version deel, wordt een positief Integerbestand toegevoegd aan de bestandsnaam.

2. Meerdere klasse-exemplaren. Als een exemplaar van de FileLogTraceListener klasse naar een bestand schrijft dat wordt gebruikt:

   • De klasse deelt het bestand als het wordt gebruikt door een ander exemplaar van de FileLogTraceListener klasse in hetzelfde proces.
   • De klasse maakt een nieuw logboekbestand met behulp van de volgende beschikbare naam als het bestand wordt gebruikt door een ander proces.

3. Draadveiligheid. De FileLogTraceListener klasse is thread veilig. Hierdoor kunt u veilig berichten naar het logboek schrijven vanuit meerdere threads zonder vergrendelingen te gebruiken.

Log-File locatie

• De Location eigenschap neemt een opsomming om een LogFileLocation van de typische directory's op te geven waar het logboekbestand naar moet worden geschreven.

• Als u het logboek naar een andere locatie wilt schrijven, stelt u de CustomLocation eigenschap in op die locatie.

Log-File naam

• De basisnaam voor het logboekbestand wordt opgegeven door de BaseFileName eigenschap.
• De naam van het huidige logboekbestand kan worden gelezen uit de FullLogFileName eigenschap. Het is afgeleid van verschillende andere eigenschappen en de huidige status van de logboeken in het bestandssysteem.

Logboekonderhoud

• De minimale frequentie voor het maken van nieuwe logboekbestanden wordt bepaald door de LogFileCreationSchedule eigenschap. Wanneer de waarde is Daily of Weekly, wordt er ten minste één keer per dag of week een nieuw logboekbestand gemaakt en wordt er een datumstempel in de FullLogFileName naam opgenomen.
• De maximale grootte (in bytes) van het logboekbestand wordt bepaald door de MaxFileSize eigenschap. Als de grootte van het logboekbestand deze grootte overschrijdt, worden extra berichten die naar het logboek worden geschreven, verwijderd en wordt er, afhankelijk van de DiskSpaceExhaustedBehavior eigenschap, een uitzondering gegenereerd.
• De ReserveDiskSpace eigenschap bepaalt hoeveel vrije ruimte (in bytes) beschikbaar moet zijn. Dit zorgt ervoor dat de FileLogTraceListener klasse niet alle beschikbare schijfruimte verbruikt. Gebruik de DiskSpaceExhaustedBehavior eigenschap om het gedrag van logboekschrijfbewerkingen op te geven wanneer er minder dan ReserveDiskSpace bytes vrij zijn.

Log-File uitvoerinstellingen

• De AutoFlush eigenschap geeft aan of de onderliggende stroom automatisch moet worden leeggemaakt na elke schrijfbewerking naar het logboekbestand.
• De Append eigenschap geeft aan of berichten moeten worden toegevoegd aan het huidige logboekbestand, indien toegestaan of naar een nieuw logboekbestand moeten worden geschreven.
• De Delimiter eigenschap geeft de tekenreeks op die moet worden gebruikt voor het scheiden van de velden in een logboekbericht.
• De Encoding eigenschap geeft de codering op die moet worden gebruikt bij het maken van een nieuw logboekbestand.

uitvoer vanLog-File

• De TraceData en TraceEvent methoden schrijven berichten naar het logboekbestand. Met deze methoden wordt de LogFileCreationSchedule eigenschap gecontroleerd, samen met eventuele bestaande logboeken met dezelfde basisnaam om te bepalen of er een nieuw logboek moet worden gemaakt.
• Met Flush de methode worden alle berichten die zich momenteel in de uitvoerbuffer bevinden, leeggemaakt naar het logboekbestand.
• De Close methode sluit het logboekbestand, zodat het kan worden gebruikt door andere processen.

Uitvoer inschakelen

U moet tracering of foutopsporing inschakelen om een traceringslistener te gebruiken. De volgende syntaxis is specifiek voor compileren. Als u andere compilers dan C# of Visual Basic gebruikt, raadpleegt u de documentatie voor uw compiler.

• Als u foutopsporing in C# wilt inschakelen, voegt u de /d:DEBUG vlag toe aan de opdrachtregel van de compiler wanneer u uw code compileert of kunt u toevoegen #define DEBUG aan het begin van het bestand. Voeg in Visual Basic de vlag /d:DEBUG=True toe aan de opdrachtregel van de compiler.
• Als u tracering in C# wilt inschakelen, voegt u de /d:TRACE vlag toe aan de opdrachtregel van de compiler wanneer u uw code compileert of voegt u deze toe #define TRACE aan het begin van het bestand. Voeg in Visual Basic de vlag /d:TRACE=True toe aan de opdrachtregel van de compiler.

In .NET Framework-apps kunt u het niveau van uw listener instellen door het configuratiebestand voor uw toepassing te bewerken. In dit bestand kunt u een listener toevoegen, het type instellen en de parameters instellen, een listener verwijderen of alle listeners wissen die eerder door de toepassing zijn ingesteld. Het configuratiebestand moet worden opgemaakt zoals in het volgende voorbeeld.

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

Als u dit voorbeeld wilt uitvoeren, moet u de volledig gekwalificeerde assemblynaam opgeven. Zie Assemblynamen voor informatie over het verkrijgen van de volledig gekwalificeerde assemblynaam.

Zie ook

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Walkthrough: Wijzigen waar My.Application.Log informatie schrijft