FileLogTraceListener Klass

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

Arv

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Attribut

ComVisibleAttribute

Kommentarer

Klassen FileLogTraceListener tillhandahåller automatiserade underhållsfunktioner för att arkivera loggfiler efter behov, dagligen eller per program. Den här automatiska arkiveringsfunktionen hjälper till att minska underhållsansvaret för utvecklare och administratörer.

En instans av FileLogTraceListener kan läggas till i samlingarna Debug.Listeners eller Trace.Listeners för att omdirigera utdata från loggning till en textfil. Instanser av den här klassen kan också läggas till i My.Application.Log eller My.Log (för webbprogram) i Visual Basic program. Mer information finns i Genomgång: Ändra var my.application.log skriver information.

De viktigaste funktionerna i den här klassen är:

1. Arkiveringsfunktioner. Loggfilerna som genereras av den här klassen namnges enligt basnamnet och datumet, tillsammans med ett tal för att skilja loggfilen från efterföljande versioner av loggen. Nya loggfiler skapas efter behov.

   Den explicita formen av filnamnet är baseName[-dateStamp][-version].log, där:

   • Delen baseName är det grundläggande loggnamnet som anges av BaseFileName egenskapen.
   • Delen dateStamp har formatet "ÅÅÅÅ-MM-DD", och det visas när LogFileCreationSchedule är Daily eller Weekly.
   • Om mer än en loggfil behövs med samma baseName och dateStamp, version läggs delen, en positiv Integer, till i filnamnet.

2. Flera klassinstanser. Om en instans av FileLogTraceListener klassen skriver till en fil som används:

   • Klassen delar filen om den används av en annan instans av FileLogTraceListener klassen i samma process.
   • Klassen skapar en ny loggfil med nästa tillgängliga namn om filen används av en annan process.

3. Trådsäkerhet. Klassen FileLogTraceListener är trådsäker. På så sätt kan du på ett säkert sätt skriva meddelanden till loggen från flera trådar utan att använda lås.

Log-File plats

• Egenskapen Location tar en LogFileLocation uppräkning för att ange en av de typiska kataloger som loggfilen ska skrivas till.

• Om du vill skriva loggen till en annan plats anger du egenskapen till den CustomLocation platsen.

Log-File namn

• Basnamnet för loggfilen anges av BaseFileName egenskapen .
• Det aktuella loggfilnamnet kan läsas från egenskapen FullLogFileName . Den härleds från flera andra egenskaper och det aktuella tillståndet för loggarna i filsystemet.

Loggunderhåll

• Den minsta frekvensen för att skapa nya loggfiler bestäms av LogFileCreationSchedule egenskapen . När värdet är Daily eller Weeklyskapas en ny loggfil minst en gång varje dag eller vecka och en datumstämpel införlivas i FullLogFileName namnet.
• Den maximala storleken (i byte) för loggfilen bestäms av MaxFileSize egenskapen . Om loggfilens storlek överskrider den här storleken ignoreras ytterligare meddelanden som skrivits till loggen och, beroende på DiskSpaceExhaustedBehavior egenskapen, genereras ett undantag.
• Egenskapen ReserveDiskSpace avgör hur mycket ledigt utrymme (i byte) som måste vara tillgängligt. Detta säkerställer att FileLogTraceListener klassen inte förbrukar allt tillgängligt diskutrymme. Använd egenskapen DiskSpaceExhaustedBehavior för att ange beteendet för loggskrivningar när det är mindre än ReserveDiskSpace byte kostnadsfritt.

Log-File utdatainställningar

• Egenskapen AutoFlush anger om den underliggande strömmen ska tömmas automatiskt efter varje skrivning till loggfilen.
• Egenskapen Append anger om meddelanden ska läggas till i den aktuella loggfilen, om det tillåts eller skriva dem till en ny loggfil.
• Egenskapen Delimiter anger vilken sträng som ska användas för att avgränsa fälten i ett loggmeddelande.
• Egenskapen Encoding anger vilken kodning som ska användas när du skapar en ny loggfil.

Log-File utdata

• Metoderna TraceData och TraceEvent skriver meddelanden till loggfilen. Dessa metoder kontrollerar LogFileCreationSchedule egenskapen, tillsammans med befintliga loggar med samma basnamn för att avgöra om en ny logg ska skapas.
• Metoden Flush rensar alla meddelanden som för närvarande finns i utdatabufferten till loggfilen.
• Metoden Close stänger loggfilen så att den kan användas av andra processer.

Aktivera utdata

Du måste aktivera spårning eller felsökning för att kunna använda en spårningslyssnare. Följande syntax är kompilatorspecifik. Om du använder andra kompilatorer än C# eller Visual Basic läser du dokumentationen för kompilatorn.

• Om du vill aktivera felsökning i C# lägger du till /d:DEBUG flaggan på kommandoraden för kompilatorn när du kompilerar koden, eller så kan du lägga till #define DEBUG överst i filen. I Visual Basic lägger du till flaggan /d:DEBUG=True på kommandoraden för kompilatorn.
• Om du vill aktivera spårning i C# lägger du till /d:TRACE flaggan på kommandoraden för kompilatorn när du kompilerar koden eller lägger till #define TRACE den överst i filen. I Visual Basic lägger du till flaggan /d:TRACE=True på kommandoraden för kompilatorn.

I .NET Framework-appar kan du ange lyssnarnivån genom att redigera konfigurationsfilen för ditt program. I den här filen kan du lägga till en lyssnare, ange dess typ och ange dess parametrar, ta bort en lyssnare eller rensa alla lyssnare som tidigare angetts av programmet. Konfigurationsfilen ska formateras som i följande exempel.

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

För att det här exemplet ska kunna köras måste du ange det fullständigt kvalificerade sammansättningsnamnet. Information om hur du hämtar det fullständigt kvalificerade sammansättningsnamnet finns i Sammansättningsnamn.

Se även

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Genomgång: Ändra var my.application.log skriver information