FileLogTraceListener Kelas

Definisi

Ruang nama:

Microsoft.VisualBasic.Logging

Rakitan:

Microsoft.VisualBasic.Forms.dll

Sumber:

FileLogTraceListener.vb

Menyediakan listener sederhana yang mengarahkan output pengelogan ke file.

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

Warisan

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

Atribut

ComVisibleAttribute

Keterangan

Kelas ini FileLogTraceListener menyediakan kemampuan pemeliharaan otomatis untuk mengarsipkan file log sesuai kebutuhan, setiap hari atau per aplikasi. Fungsi arsip otomatis ini membantu mengurangi tanggung jawab pemeliharaan pengembang dan administrator.

Instans FileLogTraceListener dapat ditambahkan ke Debug.Listeners koleksi atau Trace.Listeners untuk mengalihkan output dari pengelogan ke file teks. Instans kelas ini juga dapat ditambahkan ke My.Application.Log atau My.Log (untuk aplikasi Web) dalam aplikasi Visual Basic. Untuk informasi selengkapnya, lihat Panduan: Mengubah Di Mana My.Application.Log Menulis Informasi.

Fitur utama kelas ini adalah:

1. Fungsi arsip. File log yang dihasilkan oleh kelas ini dinamai sesuai dengan nama dasar dan tanggal, bersama dengan angka untuk membedakan file log dari versi log berturut-turut. File log baru dibuat sesuai kebutuhan.

   Bentuk eksplisit dari nama file adalah baseName[-dateStamp][-version].log, di mana:

   • Bagian baseName ini adalah nama log mendasar, yang ditentukan oleh BaseFileName properti .
   • Bagian dateStamp ini memiliki format "YYYY-MM-DD", dan ditunjukkan ketika LogFileCreationSchedule adalah Daily atau Weekly.
   • Jika lebih dari satu file log diperlukan dengan yang sama baseName dan dateStamp, version bagian , positif Integer, ditambahkan ke nama file.

2. Beberapa instans kelas. Jika instans FileLogTraceListener kelas menulis ke file yang sedang digunakan:

   • Kelas berbagi file jika sedang digunakan oleh instans lain dari FileLogTraceListener kelas dalam proses yang sama.
   • Kelas membuat file log baru menggunakan nama berikutnya yang tersedia jika file sedang digunakan oleh proses lain.

3. Keamanan utas. Kelas FileLogTraceListener aman utas. Ini memungkinkan Anda menulis pesan dengan aman ke log dari beberapa utas tanpa menggunakan kunci.

LokasiLog-File

• Properti Location mengambil LogFileLocation enumerasi untuk menentukan salah satu direktori umum untuk menulis file log.

• Untuk menulis log ke lokasi lain, atur properti ke lokasi tersebut CustomLocation .

NamaLog-File

• Nama dasar untuk file log ditentukan oleh BaseFileName properti .
• Nama file log saat ini dapat dibaca dari FullLogFileName properti . Ini berasal dari beberapa properti lain dan status log saat ini dalam sistem file.

Pemeliharaan Log

• Frekuensi minimum untuk membuat file log baru ditentukan oleh LogFileCreationSchedule properti . Ketika nilai adalah Daily atau Weekly, file log baru dibuat setidaknya sekali setiap hari atau minggu, dan stempel tanggal dimasukkan ke FullLogFileName dalam nama.
• Ukuran maksimum (dalam byte) dari file log ditentukan oleh MaxFileSize properti . Jika ukuran file log melebihi ukuran ini, pesan tambahan yang ditulis ke log dibuang dan, tergantung pada DiskSpaceExhaustedBehavior properti , pengecualian akan dilemparkan.
• Properti ReserveDiskSpace menentukan berapa banyak ruang kosong (dalam byte) yang harus tersedia. Ini membantu memastikan bahwa FileLogTraceListener kelas tidak akan menggunakan semua ruang disk yang tersedia. DiskSpaceExhaustedBehavior Gunakan properti untuk menentukan perilaku penulisan log ketika ada kurang dari ReserveDiskSpace byte gratis.

Pengaturan OutputLog-File

• Properti AutoFlush menentukan apakah aliran yang mendasar harus dihapus secara otomatis setelah setiap menulis ke file log.
• Properti Append menentukan apakah akan menambahkan pesan ke file log saat ini, jika diizinkan, atau menulisnya ke file log baru.
• Properti Delimiter menentukan string yang akan digunakan untuk memisahkan bidang dalam pesan log.
• Properti Encoding menentukan pengodean yang akan digunakan saat membuat file log baru.

OutputLog-File

• Metode TraceData dan TraceEvent menulis pesan ke file log. Metode ini memeriksa LogFileCreationSchedule properti, bersama dengan log yang ada dengan nama dasar yang sama untuk menentukan apakah log baru harus dibuat.
• Metode menghapus Flush pesan apa pun yang saat ini berada di buffer output ke file log.
• Metode Close menutup file log sehingga dapat digunakan oleh proses lain.

Mengaktifkan Output

Anda harus mengaktifkan pelacakan atau penelusuran kesalahan untuk menggunakan pendengar jejak. Sintaks berikut adalah kompilator spesifik. Jika Anda menggunakan pengkompilasi selain C# atau Visual Basic, lihat dokumentasi untuk pengkompilasi Anda.

• Untuk mengaktifkan penelusuran kesalahan di C#, tambahkan /d:DEBUG bendera ke baris perintah pengkompilasi saat Mengkompilasi kode, atau Anda dapat menambahkan #define DEBUG ke bagian atas file Anda. Di Visual Basic, tambahkan /d:DEBUG=True bendera ke baris perintah pengkompilasi.
• Untuk mengaktifkan pelacakan di C#, tambahkan /d:TRACE bendera ke baris perintah pengkompilasi saat Anda mengkompilasi kode Anda, atau tambahkan #define TRACE ke bagian atas file Anda. Di Visual Basic, tambahkan /d:TRACE=True bendera ke baris perintah pengkompilasi.

Di aplikasi .NET Framework, Anda dapat mengatur tingkat pendengar dengan mengedit file konfigurasi untuk aplikasi Anda. Dalam file ini, Anda dapat menambahkan pendengar, mengatur jenisnya dan mengatur parameternya, menghapus pendengar, atau menghapus semua pendengar yang sebelumnya ditetapkan oleh aplikasi. File konfigurasi harus diformat seperti contoh berikut.

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

Agar contoh ini berjalan, Anda harus memberikan nama rakitan yang sepenuhnya memenuhi syarat. Untuk informasi tentang cara mendapatkan nama rakitan yang sepenuhnya memenuhi syarat, lihat Nama Rakitan.

Konstruktor

Nama	Deskripsi
FileLogTraceListener()	Menginisialisasi instans FileLogTraceListener baru kelas dengan nama default.
FileLogTraceListener(String)	Menginisialisasi instans FileLogTraceListener baru kelas dengan nama yang disediakan.

Properti

Nama	Deskripsi
Append	Menentukan apakah akan menambahkan output ke file saat ini atau menulisnya ke file baru atau yang sudah ada.
AutoFlush	Menunjukkan apakah penulisan ke aliran file log menghapus buffer atau tidak.
BaseFileName	Mendapatkan atau mengatur nama dasar untuk file log, yang digunakan untuk membuat nama file log lengkap.
CustomLocation	Mendapatkan atau mengatur direktori file log saat Location properti diatur ke Custom.
Delimiter	Mendapatkan atau mengatur pemisah yang digunakan untuk memisahkan bidang dalam pesan log.
DiskSpaceExhaustedBehavior	Menentukan apa yang harus dilakukan saat menulis ke file log dan ada lebih sedikit ruang disk kosong yang tersedia daripada yang ditentukan oleh ReserveDiskSpace properti .
Encoding	Mendapatkan atau mengatur pengodean yang akan digunakan saat membuat file log baru.
FullLogFileName	Mendapatkan nama file log lengkap saat ini.
IncludeHostName	Menunjukkan apakah nama host komputer pengelogan harus disertakan dalam output atau tidak.
Location	Mendapatkan atau mengatur lokasi untuk file log.
LogFileCreationSchedule	Menentukan tanggal mana yang akan disertakan dalam nama file log.
MaxFileSize	Mendapatkan atau mengatur ukuran maksimum file log yang diizinkan, dalam byte.
ReserveDiskSpace	Mendapatkan atau mengatur jumlah ruang disk kosong, dalam byte, yang diperlukan sebelum pesan dapat ditulis ke file log.

Metode

Nama	Deskripsi
Close()	Menutup aliran yang mendasar untuk file log saat ini dan merilis sumber daya apa pun yang terkait dengan aliran saat ini.
Dispose(Boolean)	Menutup aliran yang mendasar dan secara opsional merilis sumber daya terkelola.
Flush()	Menghapus aliran yang mendasar yang menulis ke file log saat ini.
GetSupportedAttributes()	Mendapatkan atribut konfigurasi XML kustom yang didukung oleh pendengar jejak.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object)	Menulis informasi pelacakan, objek data, dan informasi peristiwa ke file atau aliran output.
TraceData(TraceEventCache, String, TraceEventType, Int32, Object[])	Menulis informasi pelacakan, array objek data, dan informasi peristiwa ke file atau aliran output.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String, Object[])	Menulis informasi pelacakan, array objek yang diformat, dan informasi peristiwa ke file atau aliran output.
TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)	Menulis informasi pelacakan, pesan, dan informasi peristiwa ke file output atau aliran.
Write(String)	Menulis pesan verbatim ke disk, tanpa informasi konteks tambahan.
WriteLine(String)	Menulis pesan verbatim ke disk, diikuti oleh terminator baris saat ini, tanpa informasi konteks tambahan.

Lihat juga

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• Panduan Langkah demi Langkah: Mengubah Tempat My.Application.Log Mencatat Informasi