方法: TraceSource とフィルターをトレースリスナーと共に使用する

[アーティクル]
05/09/2023

.NET Framework Version 2.0 の新機能の 1 つは、強化されたトレースシステムです。基本的な前提は変更されていません。トレースメッセージはスイッチ経由でリスナーに送信され、関連付けられている出力メディアに、データを報告します。バージョン 2.0 の主な違いは、TraceSource クラスのインスタンスを介してトレースを開始できることです。 TraceSource は、拡張されたトレースシステムとして機能することを目的としており、以前の Trace トレースクラスと Debug トレースクラスの静的メソッドの代わりに使用できます。使い慣れた Trace クラスと Debug クラスがまだ存在していますが、推奨される方法は、TraceSource クラスを使用したトレースです。

このトピックでは、アプリケーション構成ファイルと組み合わせた TraceSource の使用方法について説明します。可能であれば、推奨されませんが、構成ファイルを使用せずに TraceSource を使用してトレースすることもできます。構成ファイルを使わずにトレースする方法の詳細については、「How to: Create and Initialize Trace Sources」(方法: トレースソースを作成し初期化する) を参照してください。

トレースソースを作成して初期化するには

トレースをアプリケーションにインストルメント化する最初の手順では、トレースソースを作成します。各種のコンポーネントを含む大規模なプロジェクトでは、コンポーネントごとに個別のトレースソースを作成できます。トレースソース名にアプリケーション名を使用することをお勧めします。これにより、別のトレースを容易に別々に保管できます。次のコードでは、新しいトレースソース (mySource)) を作成し、イベントをトレースするメソッド (Activity1) を呼び出します。トレースメッセージは、既定のトレースリスナーによって書き込まれます。
```
using System;  
using System.Diagnostics;  
using System.Threading;  

namespace TraceSourceApp  
{  
    class Program  
    {  
        private static TraceSource mySource =
            new TraceSource("TraceSourceApp");  
        static void Main(string[] args)  
        {  
            Activity1();  
            mySource.Close();  
            return;  
        }  
        static void Activity1()  
        {  
            mySource.TraceEvent(TraceEventType.Error, 1,
                "Error message.");  
            mySource.TraceEvent(TraceEventType.Warning, 2,
                "Warning message.");  
        }  
    }  
}  
```

トレースリスナーとフィルターを作成し初期化するには

最初の手順で示すコードは、トレースリスナーまたはフィルターをプログラム的に識別しません。このコードだけでは、トレースメッセージが既定のトレースリスナーに書き込まれます。特定のトレースリスナーと関連付けられているフィルターを構成するには、アプリケーションの名前に対応する構成ファイルを編集します。このファイルで、リスナーの追加または削除、リスナーのプロパティとフィルターの設定、またはリスナーの削除を行うことができます。次の構成ファイルの例は、コンソールトレースリスナーと、前の手順で作成されたトレースソースのテキストライタートレースリスナーを初期化する方法を示しています。この構成ファイルは、トレースリスナーを設定するだけでなく、両方のリスナーについてフィルターを作成し、トレースソースのソーススイッチも作成します。トレースリスナーを追加する 2 つの方法が示されています。1 つは、リスナーをトレースソースに直接追加する方法で、もう 1 つは、リスナーを共有リスナーコレクションに追加したうえで、名前でリスナーをトレースソースに追加する方法です。 2 つのリスナーに対して識別されたフィルターは、異なるソースレベルで初期化されます。この結果、一部のメッセージが 2 つのリスナーのいずれか一方のみによって書き込まれます。
```
<configuration>  
  <system.diagnostics>  
    <sources>  
      <source name="TraceSourceApp"
        switchName="sourceSwitch"
        switchType="System.Diagnostics.SourceSwitch">  
        <listeners>  
          <add name="console"
            type="System.Diagnostics.ConsoleTraceListener">  
            <filter type="System.Diagnostics.EventTypeFilter"
              initializeData="Warning"/>  
          </add>  
          <add name="myListener"/>  
          <remove name="Default"/>  
        </listeners>  
      </source>  
    </sources>  
    <switches>  
      <add name="sourceSwitch" value="Warning"/>  
    </switches>  
    <sharedListeners>  
      <add name="myListener"
        type="System.Diagnostics.TextWriterTraceListener"
        initializeData="myListener.log">  
        <filter type="System.Diagnostics.EventTypeFilter"
          initializeData="Error"/>  
      </add>  
    </sharedListeners>  
  </system.diagnostics>  
</configuration>  
```

リスナーが、トレースメッセージを書き込むレベルを変更するには

構成ファイルは、アプリケーションが初期化されるときにトレースソースの設定を初期化します。それらの設定を変更するには、構成ファイルを変更してアプリケーションを再起動するか、または Trace.Refresh メソッドを使用して、プログラムによってアプリケーションを更新する必要があります。アプリケーションは、構成ファイルによって設定されたプロパティを動的に変更し、ユーザーによって指定された設定値をオーバーライドできます。たとえば、現在の構成設定とは無関係に、警告メッセージが常にテキストファイルに送られるようにすることもできます。

using System;  
using System.Diagnostics;  
using System.Threading;  

namespace TraceSourceApp  
{  
    class Program  
    {  
        private static TraceSource mySource =
            new TraceSource("TraceSourceApp");  
        static void Main(string[] args)  
        {  
            Activity1();  

            // Change the event type for which tracing occurs.  
            // The console trace listener must be specified
            // in the configuration file. First, save the original  
            // settings from the configuration file.  
            EventTypeFilter configFilter =
                (EventTypeFilter)mySource.Listeners["console"].Filter;  

            // Then create a new event type filter that ensures
            // critical messages will be written.  
            mySource.Listeners["console"].Filter =  
                new EventTypeFilter(SourceLevels.Critical);  
            Activity2();  

            // Allow the trace source to send messages to listeners
            // for all event types. This statement will override
            // any settings in the configuration file.  
            mySource.Switch.Level = SourceLevels.All;  

            // Restore the original filter settings.  
            mySource.Listeners["console"].Filter = configFilter;  
            Activity3();  
            mySource.Close();  
            return;  
        }  
        static void Activity1()  
        {  
            mySource.TraceEvent(TraceEventType.Error, 1,
                "Error message.");  
            mySource.TraceEvent(TraceEventType.Warning, 2,
                "Warning message.");  
        }  
        static void Activity2()  
        {  
            mySource.TraceEvent(TraceEventType.Critical, 3,
                "Critical message.");  
            mySource.TraceInformation("Informational message.");  
        }  
        static void Activity3()  
        {  
            mySource.TraceEvent(TraceEventType.Error, 4,
                "Error message.");  
            mySource.TraceInformation("Informational message.");  
        }  
    }  
}

Share via

方法: TraceSource とフィルターをトレースリスナーと共に使用する

トレースソースを作成して初期化するには

トレースリスナーとフィルターを作成し初期化するには

リスナーが、トレースメッセージを書き込むレベルを変更するには

関連項目

フィードバック

その他のリソース

Share via

方法: TraceSource とフィルターをトレース リスナーと共に使用する

トレース ソースを作成して初期化するには

トレース リスナーとフィルターを作成し初期化するには

リスナーが、トレース メッセージを書き込むレベルを変更するには

関連項目

フィードバック

その他のリソース

方法: TraceSource とフィルターをトレースリスナーと共に使用する

トレースソースを作成して初期化するには

トレースリスナーとフィルターを作成し初期化するには

リスナーが、トレースメッセージを書き込むレベルを変更するには