FileLogTraceListener Osztály

Definíció

Névtér:

Microsoft.VisualBasic.Logging

Szerelvény:

Microsoft.VisualBasic.Forms.dll

Forrás:

FileLogTraceListener.vb

Egy egyszerű figyelőt biztosít, amely a naplózási kimenetet fájlba irányítja.

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

Öröklődés

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Attribútumok

ComVisibleAttribute

Megjegyzések

Az FileLogTraceListener osztály automatizált karbantartási képességeket biztosít a naplófájlok szükség szerinti, napi vagy alkalmazásonkénti archiválásához. Ez az automatikus archiválási funkció segít csökkenteni a fejlesztők és rendszergazdák karbantartási feladatait.

Egy példány FileLogTraceListener hozzáadható a gyűjteményekhez, Debug.Listeners hogy átirányítsa a Trace.Listeners kimenetet a naplózásból egy szövegfájlba. Az osztály példányai My.Application.Log vagy My.Log (webalkalmazásokhoz) is hozzáadhatók Visual Basic alkalmazásokban. További információkért lásd: Útmutató: Ahová a My.Application.Log írja az információkat.

Az osztály fő jellemzői a következők:

1. Archiválási funkció. Az osztály által létrehozott naplófájlok neve az alapnév és a dátum szerint van elnevezve, valamint egy szám, amely megkülönbözteti a naplófájlt a napló egymást követő verzióitól. Az új naplófájlok szükség szerint jönnek létre.

   A fájlnév baseNameexplicit formája a [-dateStamp][-version].log, ahol:

   • A baseName rész a tulajdonság által BaseFileName megadott alapvető naplónév.
   • A dateStamp rész formátuma "YYYY-MM-DD", és akkor jelenik meg, ha LogFileCreationSchedule van Daily vagy Weekly.
   • Ha több naplófájlra van szükség ugyanazzal baseName a fájllal, és dateStampa version rész pozitív Integer, hozzáadódik a fájl nevéhez.

2. Több osztálypéldány. Ha az FileLogTraceListener osztály egy példánya egy használatban lévő fájlba ír:

   • Az osztály akkor osztja meg a fájlt, ha az osztály egy másik példánya FileLogTraceListener használja ugyanabban a folyamatban.
   • Az osztály létrehoz egy új naplófájlt a következő elérhető névvel, ha a fájlt egy másik folyamat használja.

3. Menetbiztonság. Az FileLogTraceListener osztály szálbiztos. Ez lehetővé teszi, hogy zárolások nélkül biztonságosan írjon üzeneteket a naplóba több szálról.

Log-File hely

• A Location tulajdonság enumerálással LogFileLocation adja meg az egyik tipikus könyvtárat a naplófájl írásához.

• Ha a naplót egy másik helyre szeretné írni, állítsa a tulajdonságot erre a CustomLocation helyre.

Log-File neve

• A naplófájl alapnevét a BaseFileName tulajdonság adja meg.
• Az aktuális naplófájl neve olvasható a FullLogFileName tulajdonságból. Számos más tulajdonságból és a fájlrendszer naplóinak aktuális állapotából származik.

Naplókarbantartás

• Az új naplófájlok létrehozásának minimális gyakoriságát a LogFileCreationSchedule tulajdonság határozza meg. Ha az érték vagy DailyWeeklyaz érték, a rendszer naponta vagy hetente legalább egyszer létrehoz egy új naplófájlt, és egy dátumbélyeget ad a FullLogFileName névbe.
• A naplófájl maximális méretét (bájtban) a MaxFileSize tulajdonság határozza meg. Ha a naplófájl mérete meghaladja ezt a méretet, a rendszer a naplóba írt további üzeneteket elveti, és a DiskSpaceExhaustedBehavior tulajdonságtól függően kivételt küld.
• A ReserveDiskSpace tulajdonság határozza meg, hogy mennyi szabad területnek kell rendelkezésre állnia (bájtban). Ez segít biztosítani, hogy az osztály ne használja fel az FileLogTraceListener összes rendelkezésre álló lemezterületet. DiskSpaceExhaustedBehavior A tulajdonság használatával megadhatja a naplóírások viselkedését, ha a bájtok száma kisebb, mint ReserveDiskSpace a bájtok száma.

Log-File kimeneti beállítások

• A AutoFlush tulajdonság azt határozza meg, hogy az alapul szolgáló streamet automatikusan ki kell-e üríteni a naplófájlba való írás után.
• A Append tulajdonság azt határozza meg, hogy hozzáfűz-e üzeneteket az aktuális naplófájlhoz, ha van ilyen, vagy új naplófájlba írja őket.
• A Delimiter tulajdonság megadja a naplóüzenet mezőinek elválasztásához használandó sztringet.
• A Encoding tulajdonság megadja az új naplófájlok létrehozásakor használni kívánt kódolást.

Log-File kimenet

• A TraceData naplófájlba írt üzenetek és TraceEvent metódusok. Ezek a metódusok ellenőrzik a LogFileCreationSchedule tulajdonságot, valamint az azonos alapnévvel rendelkező meglévő naplókat annak megállapításához, hogy létre kell-e hozni egy új naplót.
• A Flush metódus kiüríti a kimeneti pufferben lévő üzeneteket a naplófájlba.
• A Close metódus bezárja a naplófájlt, hogy más folyamatok is használhassák.

Kimenet engedélyezése

A nyomkövetési vagy hibakeresési figyelő használatához engedélyeznie kell a nyomkövetést vagy a hibakeresést. Az alábbi szintaxis fordítóspecifikus. Ha nem C# vagy Visual Basic fordítót használ, tekintse meg a fordító dokumentációját.

• Ha engedélyezni szeretné a hibakeresést a C#-ban, vegye fel a /d:DEBUG jelölőt a fordító parancssorba a kód lefordításakor, vagy felveheti #define DEBUG a fájl tetejére. A Visual Basic adja hozzá a /d:DEBUG=True jelzőt a fordító parancssorához.
• Ha c#-ban szeretné engedélyezni a nyomkövetést, adja hozzá a /d:TRACE jelölőt a fordító parancssorához a kód lefordításakor, vagy vegye fel #define TRACE a fájl tetejére. A Visual Basic adja hozzá a /d:TRACE=True jelzőt a fordító parancssorához.

A .NET Framework-alkalmazásokban beállíthatja a figyelő szintjét az alkalmazás konfigurációs fájljának szerkesztésével. Ebben a fájlban hozzáadhat egy figyelőt, beállíthatja annak típusát és paramétereit, eltávolíthat egy figyelőt, vagy törölheti az alkalmazás által korábban beállított összes figyelőt. A konfigurációs fájlt az alábbi példához hasonlóan kell formázni.

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

Ahhoz, hogy ez a példa fusson, meg kell adnia a teljes szerelvénynevet. A teljes szerelvénynév beszerzéséről további információt a szerelvénynevek című témakörben talál.

Konstruktorok

Name	Description
FileLogTraceListener()	Inicializálja az osztály új példányát FileLogTraceListener az alapértelmezett névvel.
FileLogTraceListener(String)	Inicializálja az FileLogTraceListener osztály új példányát a megadott névvel.

Tulajdonságok

Name	Description
Append	Meghatározza, hogy hozzá szeretné-e fűzni a kimenetet az aktuális fájlhoz, vagy új vagy meglévő fájlba írni.
AutoFlush	Azt jelzi, hogy a naplófájlfolyamba való írás kiüríti-e a puffert.
BaseFileName	Lekéri vagy beállítja a naplófájlok alapnevét, amely a teljes naplófájlnév létrehozásához használatos.
CustomLocation	A tulajdonság beállításakor lekéri vagy beállítja a Location naplófájl könyvtárát Custom.
Delimiter	Lekéri vagy beállítja a naplóüzenet mezőinek elválasztásához használt elválasztót.
DiskSpaceExhaustedBehavior	Meghatározza, hogy mi a teendő a naplófájlba való íráskor, és a tulajdonság által ReserveDiskSpace megadottnál kevesebb szabad lemezterület áll rendelkezésre.
Encoding	Lekéri vagy beállítja az új naplófájlok létrehozásakor használni kívánt kódolást.
FullLogFileName	Lekéri az aktuális teljes naplófájlnevet.
IncludeHostName	Azt jelzi, hogy a naplózási gép állomásneve szerepel-e a kimenetben.
Location	Lekéri vagy beállítja a naplófájlok helyét.
LogFileCreationSchedule	Meghatározza, hogy a naplófájlok nevei mely dátumot tartalmazzák.
MaxFileSize	Lekéri vagy beállítja a naplófájl megengedett maximális méretét bájtban.
ReserveDiskSpace	Lekéri vagy beállítja a szükséges szabad lemezterületet bájtban, mielőtt üzeneteket írhatna a naplófájlba.

Metódusok

Name	Description
Close()	Bezárja az aktuális naplófájl alapjául szolgáló streamet, és felszabadítja az aktuális adatfolyamhoz társított összes erőforrást.
Dispose(Boolean)	Bezárja a mögöttes streamet, és opcionálisan felszabadítja a felügyelt erőforrásokat.
Flush()	Kiüríti a mögöttes adatfolyamot, amely az aktuális naplófájlba ír.
GetSupportedAttributes()	Lekéri a nyomkövetési figyelő által támogatott egyéni XML-konfigurációs attribútumokat.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Nyomkövetési információkat, adatobjektumokat és eseményadatokat ír a kimeneti fájlba vagy streambe.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Nyomkövetési információkat, adatobjektumok tömbét és eseményinformációkat ír a kimeneti fájlba vagy streambe.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Nyomkövetési információkat, formázott objektumtömböt és eseményadatokat ír a kimeneti fájlba vagy streambe.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Nyomkövetési információkat, üzenetet és eseményadatokat ír a kimeneti fájlba vagy streambe.
Write(String)	Verbatim üzenetet ír a lemezre további környezeti információk nélkül.
WriteLine(String)	Verbatim üzenetet ír a lemezre, amelyet az aktuális sor terminátora követ további környezeti információk nélkül.

Lásd még

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Útmutató: A My.Application.Log írási adatainak módosítása