FileLogTraceListener クラス

.NET Framework クラス ライブラリ リファレンス

FileLogTraceListener クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

ログ出力をファイルにリダイレクトするシンプルなリスナを提供します。

名前空間: Microsoft.VisualBasic.Logging
アセンブリ: Microsoft.VisualBasic (microsoft.visualbasic.dll 内)
構文

Visual Basic (宣言)

<ComVisibleAttribute(False)> _
Public Class FileLogTraceListener
    Inherits TraceListener

Visual Basic (使用法)

Dim instance As FileLogTraceListener

C#

[ComVisibleAttribute(false)] 
public class FileLogTraceListener : TraceListener

C++

[ComVisibleAttribute(false)] 
public ref class FileLogTraceListener : public
 TraceListener

J#

/** @attribute ComVisibleAttribute(false) */ 
public class FileLogTraceListener extends TraceListener

JScript

ComVisibleAttribute(false) 
public class FileLogTraceListener extends
 TraceListener

解説

FileLogTraceListener クラスは、ログ ファイルを必要に応じて (毎日またはアプリケーション単位など) 自動的にアーカイブするための保守機能を提供します。自動アーカイブ機能を使用することで、開発者および管理者の保守作業の負担を減らすことができます。

FileLogTraceListener のインスタンスを Debug.Listeners コレクションまたは Trace.Listeners コレクションに追加することにより、ログ出力をテキスト ファイルにリダイレクトできます。Visual Basic アプリケーションでは、このクラスのインスタンスを、My.Application.Log または My.Log (Web アプリケーションの場合) に追加することもできます。詳細については、「チュートリアル : My.Application.Log による情報の書き込み先の変更.」を参照してください。

このクラスの主な機能を次に示します。

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

   具体的には、baseName[-dateStamp][-version].log という形式で命名されます。

   • baseName の部分は、BaseFileName プロパティによって指定された基本的なログ名になります。

   • dateStamp の部分は、LogFileCreationSchedule が Daily または Weekly の場合に、"YYYY-MM-DD" 形式で表記されます。

   • 同じ baseName および dateStamp を持つ複数のログ ファイルが必要となった場合は、そのファイル名に加えて、version の部分に正の Integer が入ります。

2. 複数のクラス インスタンスに対応。FileLogTraceListener クラスのインスタンスが出力しようとしているファイルが使用中であった場合、次のような処理が行われます。

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

   • ファイルが別のプロセスによって使用されていた場合は、次に利用可能な名前を使って新しいログ ファイルが作成されます。

ログ ファイルの場所

• Location プロパティは、ログ ファイルの一般的な出力先ディレクトリを示す、LogFileLocation 列挙体のいずれかの値を引数として受け取ります。

• ログを他の場所に出力する場合は、CustomLocation プロパティを目的の場所に設定してください。

ログ ファイルの名前

• ログ ファイルの基本名は、BaseFileName プロパティによって指定されます。

• 現在のログ ファイル名を取得するには FullLogFileName プロパティを使用します。このプロパティの値は、いくつかの他のプロパティ、および、ファイル システムにおけるログの状態に基づいて取得されます。

ログの保守

• LogFileCreationSchedule プロパティは、新しいログ ファイルが作成される最小頻度を決定します。この値が Daily または Weekly の場合、少なくとも 1 日に 1 回または 1 週間に 1 回の割合で新しいログ ファイルが作成され、その日付が FullLogFileName に追加されます。

• MaxFileSize プロパティは、ログ ファイルの最大サイズ (バイト) を決定します。ログ ファイルのサイズがこの値を超えた場合は、それ以降、ログに出力されたメッセージは破棄され、DiskSpaceExhaustedBehavior プロパティの値によっては例外がスローされます。

• ReserveDiskSpace プロパティは、確保される空き領域 (バイト) を決定します。これにより、空きディスク領域が FileLogTraceListener クラスによってすべて消費されてしまうのを確実に防ぐことができます。ディスクの空き領域が ReserveDiskSpace で指定されたバイト数を下回った場合のログ出力の動作を指定するには、DiskSpaceExhaustedBehavior プロパティを使用します。

ログ ファイルの出力設定

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

• Append プロパティは、既存のログ ファイルが存在する場合に、メッセージをそのログ ファイルに追記するか、新しいログ ファイルに出力するかを指定します。

• Delimiter プロパティは、ログ メッセージ内でフィールドの区切り記号として使用する文字列を指定します。

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

ログ ファイル出力

• TraceData メソッドおよび TraceEvent メソッドでは、ログ ファイルにメッセージが出力されます。これらのメソッドは、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 フラグを追加します。

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

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

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

継承階層

System.Object
   System.MarshalByRefObject
     System.Diagnostics.TraceListener
      Microsoft.VisualBasic.Logging.FileLogTraceListener

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
FileLogTraceListener メンバ
Microsoft.VisualBasic.Logging 名前空間
BaseFileName
TraceData
TraceEvent
Flush
Close
その他の技術情報
チュートリアル : My.Application.Log による情報の書き込み先の変更