チュートリアル: My.Application.Log の出力のフィルター処理 (Visual Basic)

[アーティクル]
02/21/2013

このチュートリアルでは、My.Application.Log オブジェクトの既定のログフィルター処理を変更する方法を説明します。これにより、Log オブジェクトからリスナーに渡される情報やリスナーによって書き込まれる情報を制御できます。構成情報はアプリケーションの構成ファイルに格納されているため、ログの動作は、アプリケーションをビルドした後でも変更できます。

作業の開始

My.Application.Log が書き込む各メッセージには、重大度レベルが関連付けられています。フィルター処理では、この重大度レベルを使用してログ出力が制御されるしくみになっています。このサンプルアプリケーションでは、My.Application.Log のメソッドを使用して、重大度レベルが異なるいくつかのログメッセージを書き込みます。

サンプルアプリケーションをビルドするには

新しい Visual Basic Windows アプリケーションプロジェクトを開きます。
Button1 という名前のボタンを Form1 に追加します。

Button1 の Click イベントハンドラーに次のコードを追加します。

' Activity tracing information
My.Application.Log.WriteEntry("Entering Button1_Click", TraceEventType.Start)

' Tracing information
My.Application.Log.WriteEntry("In Button1_Click", TraceEventType.Information)

' Create an exception to log.
Dim ex As New ApplicationException
' Exception information
My.Application.Log.WriteException(ex)

' Activity tracing information
My.Application.Log.WriteEntry("Leaving Button1_Click", TraceEventType.Stop)

アプリケーションをデバッガーで実行します。
Button1 をクリックします。

アプリケーションのデバッグ出力およびログファイルに次の情報が書き込まれます。

DefaultSource Information: 0 : In Button1_Click

DefaultSource Error: 2 : Error in the application.
アプリケーションを閉じます。

アプリケーションのデバッグ出力ウィンドウを表示する方法については、「[出力] ウィンドウ」を参照してください。アプリケーションのログファイルの場所については、「チュートリアル: My.Application.Log による情報の書き込み先の確認 (Visual Basic)」を参照してください。

[!メモ]

既定では、アプリケーションは、アプリケーションの終了時にログファイル出力をフラッシュします。

上の例では、2 番目の WriteEntry メソッドの呼び出しと WriteException メソッドの呼び出しではログ出力が生成され、最初と最後の WriteEntry メソッドの呼び出しでは生成されません。その理由は、WriteEntry と WriteException の重大度レベルは "Information" と "Error" であり、いずれも My.Application.Log オブジェクトの既定のログフィルター処理を通過するからです。一方、重大度レベルが "Start" と "Stop" のイベントは、ログ出力は生成されません。

すべての My.Application.Log リスナーのフィルター処理

My.Application.Log オブジェクトは、WriteEntry メソッドおよび WriteException メソッドからのどのメッセージをログリスナーに渡すかを、DefaultSwitch という名前の SourceSwitch を使用して制御します。DefaultSwitch を構成するには、アプリケーションの構成ファイルで、その値をいずれかの SourceLevels 列挙値に設定します。既定では、この値は "Information" です。

この表は、所定の DefaultSwitch 設定に応じて、Log がリスナーにメッセージを書き込むのに必要な重大度レベルを示します。

DefaultSwitch 値	メッセージの出力に必要な重大度レベル
Critical	Critical
Error	Critical または Error
Warning	Critical、Error、または Warning
Information	Critical、Error、Warning、または Information
Verbose	Critical、Error、Warning、Information、または Verbose
ActivityTracing	Start、Stop、Suspend、Resume、または Transfer
All	すべてのメッセージが通過する
Off	すべてのメッセージがブロックされる

[!メモ]

WriteEntry メソッドと WriteException メソッドには、重大度レベルを指定しないオーバーロードがそれぞれあります。暗黙の重大度レベルは、WriteEntry のオーバーロードでは "Information"、WriteException のオーバーロードでは "Error" です。

この表を、前の例で示したログ出力に照らしてみると、既定の DefaultSwitch 設定である "Information" では WriteEntry メソッドの 2 番目の呼び出しと WriteException メソッドの呼び出しだけでログ出力が生成されるということの説明が付きます。

処理トレースイベントのみをログに記録するには

ソリューションエクスプローラーで app.config を右クリックし、[開く] をクリックします。

または

app.config ファイルがない場合は、次の操作を行います。
1. [プロジェクト] メニューの [新しい項目の追加] をクリックします。
2. [新しい項目の追加] ダイアログボックスで、[アプリケーション構成ファイル] をクリックします。
3. [追加] をクリックします。
最上位の <configuration> セクション内の <system.diagnostics> セクションで、<switches> セクションを見つけます。
スイッチのコレクションに DefaultSwitch を追加している要素を見つけます。次のような要素です。

<add name="DefaultSwitch" value="Information" />
value 属性の値を "ActivityTracing" に変更します。

app.config ファイルの内容は次の XML のようになります。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.diagnostics>
    <sources>
      <!-- This section configures My.Application.Log -->
      <source name="DefaultSource" switchName="DefaultSwitch">
        <listeners>
          <add name="FileLog"/>
        </listeners>
      </source>
    </sources>
    <switches>
      <add name="DefaultSwitch" value="ActivityTracing" />
    </switches>
    <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>

アプリケーションをデバッガーで実行します。
Button1 をクリックします。

アプリケーションのデバッグ出力およびログファイルに次の情報が書き込まれます。

DefaultSource Start: 4 : Entering Button1_Click

DefaultSource Stop: 5 : Leaving Button1_Click
アプリケーションを閉じます。
value 属性の値を "Information" に戻します。

[!メモ]

DefaultSwitch スイッチの設定で制御されるのは My.Application.Log のみです。.NET Framework の System.Diagnostics.Trace クラスと System.Diagnostics.Debug クラスの動作は変更されません。

My.Application.Log リスナーの個別のフィルター処理

前の例では、My.Application.Log のすべての出力のフィルター処理を変更する方法を示しました。この例では、個別のログリスナーをフィルター処理する方法を説明します。既定では、アプリケーションには、アプリケーションのデバッグ出力に書き込むリスナーとログファイルに書き込むリスナーの 2 つがあります。

構成ファイルでは、それぞれのログリスナーにフィルターを設定でき、それによりログリスナーの動作を制御します。このフィルターは、My.Application.Log のスイッチと同様のものです。ログリスナーは、ログの DefaultSwitch とログリスナーのフィルターの両方で認められている重大度レベルのメッセージのみを出力します。

この例では、新しいデバッグリスナーのフィルター処理を構成し、Log オブジェクトに追加する方法を説明します。この新しいデバッグリスナーからデバッグメッセージが来たということが明確になるように、既定のデバッグリスナーは Log オブジェクトから削除する必要があります。

処理トレースイベントのみをログに記録するには

ソリューションエクスプローラーで app.config を右クリックし、[開く] をクリックします。

または

app.config ファイルがない場合は、次の操作を行います。
1. [プロジェクト] メニューの [新しい項目の追加] をクリックします。
2. [新しい項目の追加] ダイアログボックスで、[アプリケーション構成ファイル] をクリックします。
3. [追加] をクリックします。
ソリューションエクスプローラーで、app.config を右クリックします。[開く] をクリックします。
<sources> セクション内にある、name 属性が "DefaultSource" の <source> セクションで、<listeners> セクションを見つけます。<sources> セクションは、最上位の <configuration> セクション内の <system.diagnostics> セクションにあります。

<listeners> セクションに次の要素を追加します。

<!-- Remove the default debug listener. -->
<remove name="Default"/>
<!-- Add a filterable debug listener. -->
<add name="NewDefault"/>

最上位の <configuration> セクション内の <system.diagnostics> セクションで、<sharedListeners> セクションを見つけます。

その <sharedListeners> セクションに次の要素を追加します。

<add name="NewDefault" 
     type="System.Diagnostics.DefaultTraceListener, 
           System, Version=2.0.0.0, Culture=neutral, 
           PublicKeyToken=b77a5c561934e089, 
           processorArchitecture=MSIL">
    <filter type="System.Diagnostics.EventTypeFilter" 
            initializeData="Error" />
</add>

EventTypeFilter フィルターの initializeData 属性は、いずれかの SourceLevels 列挙値をとります。

app.config ファイルの内容は次の XML のようになります。

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.diagnostics>
    <sources>
      <!-- This section configures My.Application.Log -->
      <source name="DefaultSource" switchName="DefaultSwitch">
        <listeners>
          <add name="FileLog"/>
          <!-- Remove the default debug listener. -->
          <remove name="Default"/>
          <!-- Add a filterable debug listener. -->
          <add name="NewDefault"/>
        </listeners>
      </source>
    </sources>
    <switches>
      <add name="DefaultSwitch" value="Information" />
    </switches>
    <sharedListeners>
      <add name="FileLog"
           type="Microsoft.VisualBasic.Logging.FileLogTraceListener, 
                 Microsoft.VisualBasic, Version=8.0.0.0, 
                 Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, 
                 processorArchitecture=MSIL" 
           initializeData="FileLogWriter"/>
      <add name="NewDefault" 
           type="System.Diagnostics.DefaultTraceListener, 
                 System, Version=2.0.0.0, Culture=neutral, 
                 PublicKeyToken=b77a5c561934e089, 
                 processorArchitecture=MSIL">
        <filter type="System.Diagnostics.EventTypeFilter" 
                initializeData="Error" />
      </add>
    </sharedListeners>
  </system.diagnostics>
</configuration>

アプリケーションをデバッガーで実行します。
Button1 をクリックします。

アプリケーションのログファイルに次の情報が書き込まれます。

Default Information: 0 : In Button1_Click

Default Error: 2 : Error in the application.

フィルター処理での絞り込みが多くなった分、アプリケーションがデバッグ出力に書き込む情報は少なくなります。

Default Error 2 Error
アプリケーションを閉じます。