FileLogTraceListener Třída

Definice

Obor názvů:

Microsoft.VisualBasic.Logging

Sestavení:

Microsoft.VisualBasic.Forms.dll

Zdroj:

FileLogTraceListener.vb

Poskytuje jednoduchý naslouchací proces, který směruje výstup protokolování do souboru.

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

Dědičnost

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Atributy

ComVisibleAttribute

Poznámky

Třída FileLogTraceListener poskytuje možnosti automatizované údržby pro archivaci souborů protokolu podle potřeby za den nebo pro jednotlivé aplikace. Tato automatická funkce archivace pomáhá snižovat odpovědnost za údržbu vývojářů a správců.

Do kolekcí Trace.Listeners je možné přidat Debug.Listeners instanciFileLogTraceListener, která přesměruje výstup z protokolování do textového souboru. Instance této třídy lze také přidat do My.Application.Log nebo My.Log (pro webové aplikace) v aplikacích jazyka Visual Basic. Další informace naleznete v tématu Návod: Změna umístění zápisu my.application.log informace.

Hlavní funkce této třídy jsou:

1. Funkce archivace. Soubory protokolu vygenerované touto třídou jsou pojmenovány podle základního názvu a data spolu s číslem pro rozlišení souboru protokolu od následných verzí protokolu. Nové soubory protokolu se vytvářejí podle potřeby.

   Explicitní forma názvu souboru je baseName[-dateStamp][-version].log, kde:

   • Součástí baseName je základní název protokolu určený BaseFileName vlastností.
   • Část dateStamp má formát "RRRR-MM-DD" a zobrazí se, když LogFileCreationSchedule je Daily nebo Weekly.
   • Pokud je k názvu souboru přidáno více než jeden soubor protokolu se stejným baseName souborem a dateStampčást version , je k názvu souboru přidána kladná Integerhodnota.

2. Více instancí třídy. Pokud instance FileLogTraceListener třídy zapíše do souboru, který se používá:

   • Třída sdílí soubor, pokud ho FileLogTraceListener používá jiná instance třídy ve stejném procesu.
   • Třída vytvoří nový soubor protokolu pomocí dalšího dostupného názvu, pokud soubor používá jiný proces.

3. Bezpečnost vláken. Třída FileLogTraceListener je bezpečná pro vlákno. Díky tomu můžete bezpečně zapisovat zprávy do protokolu z více vláken bez použití zámků.

umístěníLog-File

• Vlastnost Location přebírá LogFileLocation výčet určující jeden z typických adresářů pro zápis souboru protokolu do.

• Pokud chcete protokol zapsat do jiného umístění, nastavte CustomLocation vlastnost na toto umístění.

názevLog-File

• Základní název souboru protokolu je určen vlastností BaseFileName .
• Aktuální název souboru protokolu lze načíst z FullLogFileName vlastnosti. Je odvozen z několika dalších vlastností a aktuálního stavu protokolů v systému souborů.

Údržba protokolů

• Vlastnost určuje LogFileCreationSchedule minimální četnost vytváření nových souborů protokolu. Pokud je Daily hodnota nebo Weekly, nový soubor protokolu se vytvoří alespoň jednou každý den nebo týden a razítko data se začlení do FullLogFileName názvu.
• Vlastnost určuje MaxFileSize maximální velikost souboru protokolu (v bajtech). Pokud velikost souboru protokolu překračuje tuto velikost, zahodí se další zprávy zapsané do protokolu a v závislosti na DiskSpaceExhaustedBehavior vlastnosti se vyvolá výjimka.
• Vlastnost ReserveDiskSpace určuje, kolik volného místa (v bajtech) musí být k dispozici. To pomáhá zajistit, aby FileLogTraceListener třída nespotřebovávat veškeré dostupné místo na disku. DiskSpaceExhaustedBehavior Pomocí vlastnosti můžete určit chování zápisů protokolu, pokud je méně než ReserveDiskSpace bajty volné.

nastavení výstupuLog-File

• Vlastnost AutoFlush určuje, zda se má podkladový datový proud vyprázdnit automaticky po každém zápisu do souboru protokolu.
• Vlastnost Append určuje, zda chcete připojit zprávy k aktuálnímu souboru protokolu, pokud je povoleno, nebo je zapisovat do nového souboru protokolu.
• Vlastnost Delimiter určuje řetězec, který se má použít k oddělovači polí v protokolu zprávy.
• Vlastnost Encoding určuje kódování, které se má použít při vytváření nového souboru protokolu.

výstupLog-File

• Metody TraceData a TraceEvent metody zapisuje zprávy do souboru protokolu. Tyto metody zkontrolují LogFileCreationSchedule vlastnost spolu s existujícími protokoly se stejným základním názvem a určí, jestli se má vytvořit nový protokol.
• Metoda Flush vyprázdní všechny zprávy aktuálně ve výstupní vyrovnávací paměti do souboru protokolu.
• Metoda Close zavře soubor protokolu, aby ho mohly používat jiné procesy.

Povolení výstupu

Pokud chcete použít naslouchací proces trasování, musíte povolit trasování nebo ladění. Následující syntaxe je specifická pro kompilátor. Pokud používáte jiné kompilátory než C# nebo Visual Basic, projděte si dokumentaci pro váš kompilátor.

• Pokud chcete povolit ladění v jazyce C#, přidejte /d:DEBUG příznak do příkazového řádku kompilátoru při kompilaci kódu nebo můžete přidat #define DEBUG na začátek souboru. V jazyce Visual Basic přidejte /d:DEBUG=True příznak do příkazového řádku kompilátoru.
• Pokud chcete povolit trasování v jazyce C#, přidejte /d:TRACE příznak do příkazového řádku kompilátoru při kompilaci kódu nebo přidejte #define TRACE na začátek souboru. V jazyce Visual Basic přidejte /d:TRACE=True příznak do příkazového řádku kompilátoru.

V aplikacích .NET Framework můžete nastavit úroveň naslouchacího procesu úpravou konfiguračního souboru pro vaši aplikaci. V tomto souboru můžete přidat naslouchací proces, nastavit jeho typ a nastavit jeho parametry, odebrat naslouchací proces nebo vymazat všechny naslouchací procesy dříve nastavené aplikací. Konfigurační soubor by měl být naformátovaný jako v následujícím příkladu.

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

Pro spuštění tohoto příkladu je nutné zadat plně kvalifikovaný název sestavení. Informace o získání plně kvalifikovaného názvu sestavení naleznete v tématu Názvy sestavení.

Konstruktory

Name	Description
FileLogTraceListener()	Inicializuje novou instanci FileLogTraceListener třídy s výchozím názvem.
FileLogTraceListener(String)	Inicializuje novou instanci FileLogTraceListener třídy se zadaným názvem.

Vlastnosti

Name	Description
Append	Určuje, zda se má výstup připojit k aktuálnímu souboru, nebo jej zapsat do nového nebo existujícího souboru.
AutoFlush	Určuje, zda zápis do datového proudu souboru protokolu vyprázdní vyrovnávací paměť.
BaseFileName	Získá nebo nastaví základní název pro soubory protokolu, který se používá k vytvoření úplného názvu souboru protokolu.
CustomLocation	Získá nebo nastaví adresář souboru protokolu, když Location je vlastnost nastavena na Custom.
Delimiter	Získá nebo nastaví oddělovač použitý k oddělovači polí v protokolu zprávy.
DiskSpaceExhaustedBehavior	Určuje, co dělat při zápisu do souboru protokolu a je k dispozici méně volného místa na disku, než je určeno ReserveDiskSpace vlastností.
Encoding	Získá nebo nastaví kódování, které se má použít při vytváření nového souboru protokolu.
FullLogFileName	Získá aktuální úplný název souboru protokolu.
IncludeHostName	Určuje, jestli má být do výstupu zahrnutý název hostitele počítače protokolování nebo ne.
Location	Získá nebo nastaví umístění pro soubory protokolu.
LogFileCreationSchedule	Určuje datum, které se má zahrnout do názvů souborů protokolu.
MaxFileSize	Získá nebo nastaví maximální povolenou velikost souboru protokolu v bajtech.
ReserveDiskSpace	Získá nebo nastaví množství volného místa na disku v bajtech potřebné před zápisem zpráv do souboru protokolu.

Metody

Name	Description
Close()	Zavře základní datový proud pro aktuální soubor protokolu a uvolní všechny prostředky přidružené k aktuálnímu datovému proudu.
Dispose(Boolean)	Zavře základní datový proud a volitelně uvolní spravované prostředky.
Flush()	Vyprázdní podkladový datový proud, který zapíše do aktuálního souboru protokolu.
GetSupportedAttributes()	Získá vlastní atributy konfigurace XML podporované naslouchací proces trasování.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Zapisuje informace o trasování, datový objekt a informace o událostech do výstupního souboru nebo datového proudu.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Zapisuje informace o trasování, pole datových objektů a informace o událostech do výstupního souboru nebo datového proudu.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Zapisuje informace o trasování, formátované pole objektů a informace o událostech do výstupního souboru nebo datového proudu.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Zapíše informace o trasování, zprávu a informace o události do výstupního souboru nebo datového proudu.
Write(String)	Zapíše doslovnou zprávu na disk bez dalších informací o kontextu.
WriteLine(String)	Zapíše doslovnou zprávu na disk následovanou ukončovacím znakem aktuálního řádku bez dalších informací o kontextu.

Viz také

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Návod: Změna místa zápisu informací my.application.log