方法: トレース ソースを作成および初期化する

TraceSource クラスは、アプリケーションに関連付けることができるトレースを生成するためにアプリケーションによって使用されます。 TraceSource には、イベントやデータをトレースし、情報トレースを発行するためのトレースメソッドが簡単に利用できます。 TraceSourceからのトレース出力は、構成ファイルを使用するか使用せずに作成および初期化できます。 このトピックでは、両方のオプションの手順について説明します。 ただし、実行時にトレース ソースによって生成されるトレースの再構成を容易にするために、構成ファイルを使用することをお勧めします。

構成ファイルを使用してトレース ソースを作成および初期化するには

1. Visual Studio コンソール アプリケーション プロジェクト (.NET Framework) を作成し、指定されたコードを次のコードに置き換えます。 このコードは、エラーと警告をログに記録し、その一部をコンソールに出力し、その一部を構成ファイル内のエントリによって作成された myListener ファイルに出力します。

   using System;
   using System.Diagnostics;
   
   class TraceTest
   {
   
       private static TraceSource mySource =
               new TraceSource("TraceSourceApp");
           static void Main(string[] args)
           {
              // Issue an error and a warning message. Only the error message
               // should be logged.
               Activity1();
   
               // Save the original settings from the configuration file.
               EventTypeFilter configFilter =
                   (EventTypeFilter)mySource.Listeners["console"].Filter;
   
               // Create a new event type filter that ensures
               // warning messages will be written.
               mySource.Listeners["console"].Filter =
                   new EventTypeFilter(SourceLevels.Warning);
   
               // Allow the trace source to send messages to listeners
               // for all event types. This statement will override
               // any settings in the configuration file.
               // If you do not change the switch level, the event filter
               // changes have no effect.
               mySource.Switch.Level = SourceLevels.All;
   
               // Issue a warning and a critical message. Both should be logged.
               Activity2();
   
               // 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.TraceEvent(TraceEventType.Warning, 2,
                   "Warning message.");
           }
           static void Activity3()
           {
               mySource.TraceEvent(TraceEventType.Error, 4,
                   "Error message.");
               mySource.TraceInformation("Informational message.");
           }
       }
   

   Imports System.Diagnostics
   
   Class TraceTest
   
       Private Shared mySource As New TraceSource("TraceSourceApp")
   
       Shared Sub Main(ByVal args() As String)
           ' Issue an error and a warning message. Only the error message
           ' should be logged.
           Activity1()
   
           ' Save the original settings from the configuration file.
           Dim configFilter As EventTypeFilter = CType(mySource.Listeners("console").Filter, EventTypeFilter)
   
           ' Create a new event type filter that ensures 
           ' warning messages will be written.
           mySource.Listeners("console").Filter = New EventTypeFilter(SourceLevels.Warning)
   
           ' Allow the trace source to send messages to listeners 
           ' for all event types. This statement will override 
           ' any settings in the configuration file.
           ' If you do not change the switch level, the event filter
           ' changes have no effect.
           mySource.Switch.Level = SourceLevels.All
   
           ' Issue a warning and a critical message. Both should be logged.
           Activity2()
   
           ' Restore the original filter settings.
           mySource.Listeners("console").Filter = configFilter
           Activity3()
           mySource.Close()
           Return
   
       End Sub
   
       Shared Sub Activity1()
           mySource.TraceEvent(TraceEventType.Error, 1, "Error message.")
           mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message.")
   
       End Sub
   
       Shared Sub Activity2()
           mySource.TraceEvent(TraceEventType.Critical, 3, "Critical message.")
           mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message.")
   
       End Sub
   
       Shared Sub Activity3()
           mySource.TraceEvent(TraceEventType.Error, 4, "Error message.")
           mySource.TraceInformation("Informational message.")
   
       End Sub
   End Class
   

2. アプリケーション構成ファイルが存在しない場合は、プロジェクトに追加して、手順 1 のコード例で TraceSourceApp という名前のトレース ソースを初期化します。

3. 既定の構成ファイルの内容を次の設定に置き換えて、手順 1 で作成したトレース ソースのコンソール トレース リスナーとテキスト ライター トレース リスナーを初期化します。

   <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="Error"/>
             </add>
             <add name="myListener"/>
             <remove name="Default"/>
           </listeners>
         </source>
       </sources>
       <switches>
         <add name="sourceSwitch" value="Error"/>
       </switches>
       <sharedListeners>
         <add name="myListener"
           type="System.Diagnostics.TextWriterTraceListener"
           initializeData="myListener.log">
           <filter type="System.Diagnostics.EventTypeFilter"
             initializeData="Error"/>
         </add>
       </sharedListeners>
     </system.diagnostics>
   </configuration>
   

   構成ファイルは、トレース リスナーの構成に加えて、両方のリスナーのフィルターを作成し、トレース ソースのソース スイッチを作成します。 トレース リスナーを追加するには、リスナーをトレース ソースに直接追加し、共有リスナー コレクションにリスナーを追加してから、名前でトレース ソースに追加する方法の 2 つの手法を示します。 2 つのリスナーに対して識別されるフィルターは、異なるソース レベルで初期化されます。 これにより、一部のメッセージが 2 つのリスナーの 1 つだけによって書き込まれます。

   構成ファイルは、アプリケーションの初期化時にトレース ソースの設定を初期化します。 アプリケーションは、構成ファイルによって設定されたプロパティを動的に変更して、ユーザーが指定した設定をオーバーライドできます。 たとえば、現在の構成設定に関係なく、重要なメッセージが常にテキスト ファイルに送信されるようにすることができます。 このコード例では、構成ファイルの設定をオーバーライドして、重要なメッセージがトレース リスナーに出力されるようにする方法を示します。

   アプリケーションの実行中に構成ファイルの設定を変更しても、初期設定は変更されません。 設定を変更するには、アプリケーションを再起動するか、 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)
          {
              mySource.Switch = new SourceSwitch("sourceSwitch", "Error");
              mySource.Listeners.Remove("Default");
              TextWriterTraceListener textListener =
                  new TextWriterTraceListener("myListener.log");
              ConsoleTraceListener console =
                  new ConsoleTraceListener(false);
              console.Filter =
                  new EventTypeFilter(SourceLevels.Information);
              console.Name = "console";
              textListener.Filter =
                  new EventTypeFilter(SourceLevels.Error);
              mySource.Listeners.Add(console);
              mySource.Listeners.Add(textListener);
              Activity1();
  
              // Allow the trace source to send messages to
              // listeners for all event types. Currently only
              // error messages or higher go to the listeners.
              // Messages must get past the source switch to
              // get to the listeners, regardless of the settings
              // for the listeners.
              mySource.Switch.Level = SourceLevels.All;
  
              // Set the filter settings for the
              // console trace listener.
              mySource.Listeners["console"].Filter =
                  new EventTypeFilter(SourceLevels.Critical);
              Activity2();
  
              // Change the filter settings for the console trace listener.
              mySource.Listeners["console"].Filter =
                  new EventTypeFilter(SourceLevels.Information);
              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.");
          }
      }
  }
  
  

  Imports System.Diagnostics
  Imports System.Threading
  
  
  
  Class Program
      Private Shared mySource As New TraceSource("TraceSourceApp")
  
      Shared Sub Main(ByVal args() As String)
          mySource.Switch = New SourceSwitch("sourceSwitch", "Error")
          mySource.Listeners.Remove("Default")
          Dim textListener As New TextWriterTraceListener("myListener.log")
          Dim console As New ConsoleTraceListener(False)
          console.Filter = New EventTypeFilter(SourceLevels.Information)
          console.Name = "console"
          textListener.Filter = New EventTypeFilter(SourceLevels.Error)
          mySource.Listeners.Add(console)
          mySource.Listeners.Add(textListener)
          Activity1()
  
          ' Allow the trace source to send messages to 
          ' listeners for all event types. Currently only 
          ' error messages or higher go to the listeners.
          ' Messages must get past the source switch to 
          ' get to the listeners, regardless of the settings 
          ' for the listeners.
          mySource.Switch.Level = SourceLevels.All
  
          ' Set the filter settings for the 
          ' console trace listener.
          mySource.Listeners("console").Filter = New EventTypeFilter(SourceLevels.Critical)
          Activity2()
  
          ' Change the filter settings for the console trace listener.
          mySource.Listeners("console").Filter = New EventTypeFilter(SourceLevels.Information)
          Activity3()
          mySource.Close()
          Return
  
      End Sub
  
      Shared Sub Activity1()
          mySource.TraceEvent(TraceEventType.Error, 1, "Error message.")
          mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message.")
  
      End Sub
  
      Shared Sub Activity2()
          mySource.TraceEvent(TraceEventType.Critical, 3, "Critical message.")
          mySource.TraceInformation("Informational message.")
  
      End Sub
  
      Shared Sub Activity3()
          mySource.TraceEvent(TraceEventType.Error, 4, "Error message.")
          mySource.TraceInformation("Informational message.")
  
      End Sub
  End Class
  
  

こちらも参照ください

• TraceSource
• TextWriterTraceListener
• ConsoleTraceListener
• EventTypeFilter
• アプリケーションのトレースとインストルメント化