FileLogTraceListener クラス

定義

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

継承

Object

MarshalByRefObject

TraceListener

FileLogTraceListener

属性

ComVisibleAttribute

注釈

クラスは FileLogTraceListener 、毎日またはアプリケーションごとに、必要に応じてログ ファイルをアーカイブするための自動メンテナンス機能を提供します。 この自動アーカイブ機能は、開発者と管理者のメンテナンスの責任を軽減するのに役立ちます。

のFileLogTraceListenerインスタンスを コレクションまたは Trace.Listeners コレクションにDebug.Listeners追加して、出力をログからテキスト ファイルにリダイレクトできます。 このクラスのインスタンスは、Visual Basic アプリケーションの または My.Log (Web アプリケーションの場合) に追加My.Application.Logすることもできます。 詳細については、「 Walkthrough: Changing Where My.Application.Log Writes Information」を参照してください。

このクラスのメイン機能は次のとおりです。

1. アーカイブ機能。 このクラスによって生成されるログ ファイルの名前は、基本名と日付に従って、ログ ファイルとログの連続したバージョンを区別するための番号と共に指定されます。 新しいログ ファイルは、必要に応じて作成されます。

   ファイル名の明示的な形式は baseName[-dateStamp][-version].logで、次のようになります。

   • 部分は baseName 、 プロパティで BaseFileName 指定された基本的なログ名です。

   • パーツの形式は dateStamp "YYYY-MM-DD" で、 が または Weeklyの場合にLogFileCreationScheduleDaily表示されます。

   • 同じ baseName と dateStampversion を持つ複数のログ ファイルが必要な場合は、ファイル名に正Integerの 部分 が追加されます。

2. 複数のクラス インスタンス。 クラスのインスタンスが FileLogTraceListener 使用中のファイルに書き込む場合:

   • クラスは、同じプロセスで クラスの別のインスタンスによって使用されている場合に FileLogTraceListener ファイルを共有します。

   • クラスは、ファイルが別のプロセスで使用されている場合、次に使用できる名前を使用して新しいログ ファイルを作成します。

3. スレッド セーフ。 クラスは FileLogTraceListener スレッド セーフです。 これにより、ロックを使用せずに、複数のスレッドからログにメッセージを安全に書き込むことができます。

ログ ファイルの場所

• プロパティは Location 、ログ ファイルを LogFileLocation 書き込む一般的なディレクトリの 1 つを指定する列挙体を受け取ります。

• ログを別の場所に書き込むには、 プロパティを CustomLocation その場所に設定します。

ログ ファイル名

• ログ ファイルのベース名は、 プロパティで BaseFileName 指定します。

• 現在のログ ファイル名は、 プロパティから FullLogFileName 読み取ることができます。 これは、他のいくつかのプロパティと、ファイル システム内のログの現在の状態から派生します。

ログのメンテナンス

• 新しいログ ファイルを作成するための最小頻度は、 LogFileCreationSchedule プロパティによって決まります。 値が または Weeklyの場合、Daily新しいログ ファイルが毎日または週に少なくとも 1 回作成され、日付スタンプが名前に組み込FullLogFileNameまれます。

• ログ ファイルの最大サイズ (バイト単位) は、 プロパティによって MaxFileSize 決まります。 ログ ファイルのサイズがこのサイズを超えると、ログに書き込まれた追加のメッセージが破棄され、プロパティに DiskSpaceExhaustedBehavior 応じて例外がスローされます。

• プロパティは ReserveDiskSpace 、使用可能な空き領域の量 (バイト単位) を決定します。 これにより、クラスが FileLogTraceListener 使用可能なすべてのディスク領域を消費しないようにすることができます。 DiskSpaceExhaustedBehavior空きバイト数未満ReserveDiskSpaceの場合のログ書き込みの動作を指定するには、 プロパティを使用します。

ログ ファイルの出力設定

• プロパティは AutoFlush 、ログ ファイルへの書き込みのたびに、基になるストリームを自動的にフラッシュするかどうかを指定します。

• プロパティは Append 、許可されている場合は現在のログ ファイルにメッセージを追加するか、新しいログ ファイルに書き込むかを指定します。

• プロパティは Delimiter 、ログ メッセージ内のフィールドを区切るために使用する文字列を指定します。

• プロパティは Encoding 、新しいログ ファイルを作成するときに使用するエンコードを指定します。

ログ ファイルの出力

• メソッドと TraceEvent メソッドはTraceData、ログ ファイルにメッセージを書き込みます。 これらのメソッドは、 プロパティと同じベース名をLogFileCreationSchedule持つ既存のログをチェックして、新しいログを作成する必要があるかどうかを判断します。

• メソッドは Flush 、現在出力バッファー内のすべてのメッセージをログ ファイルにフラッシュします。

• メソッドは Close 、他のプロセスで使用できるようにログ ファイルを閉じます。

出力の有効化

トレース リスナーを使用するには、トレースまたはデバッグを有効にする必要があります。 次の構文はコンパイラ固有です。 C# または Visual Basic 以外のコンパイラを使用する場合は、コンパイラのドキュメントを参照してください。

• C# でデバッグを有効にするには、コードの /d:DEBUG コンパイル時にコンパイラ コマンド ラインに フラグを追加するか、ファイルの先頭に を追加 #define DEBUG します。 Visual Basic で、 フラグを /d:DEBUG=True コンパイラ コマンド ラインに追加します。

• C# でトレースを有効にするには、コードの /d:TRACE コンパイル時にコンパイラ コマンド ラインに フラグを追加するか、ファイルの先頭に を追加 #define TRACE します。 Visual Basic で、 フラグを /d:TRACE=True コンパイラ コマンド ラインに追加します。

.NET Framework アプリでは、アプリケーションの構成ファイルを編集してリスナーのレベルを設定できます。 このファイル内では、リスナーの追加、その型の設定、パラメーターの設定、リスナーの削除、またはアプリケーションによって以前に設定されたすべてのリスナーのクリアを行うことができます。 構成ファイルは、次の例のように書式設定する必要があります。

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

この例を実行するには、完全修飾アセンブリ名を指定する必要があります。 完全修飾アセンブリ名を取得する方法については、「アセンブリ 名」を参照してください。

コンストラクター

プロパティ

メソッド

適用対象

こちらもご覧ください

• BaseFileName
• TraceData(TraceEventCache, String, TraceEventType, Int32, Object)
• TraceEvent(TraceEventCache, String, TraceEventType, Int32, String)
• Flush()
• Close()
• チュートリアル: My.Application.Log による情報の書き込み先の変更