トレースの構成

ここでは、トレースを有効にする方法、トレースを出力し、トレース レベルを設定するようにトレース ソースを構成する方法、エンドツーエンドのトレース相関をサポートするようにアクティビティ トレースと伝達を設定する方法、およびトレースにアクセスするようにトレース リスナーを設定する方法について説明します。

運用環境またはデバッグ環境でのトレースの推奨設定については、「トレースとメッセージ ログの推奨設定」を参照してください。

トレースの有効化

Windows Communication Foundation (WCF) は次の診断トレース データを出力します。

• 操作呼び出し、コード例外、警告、その他の重要な処理イベントなど、アプリケーションのすべてのコンポーネントにおける処理マイルストーンのトレース。

• トレース機能が正しく動作しないときの Windows エラー イベント。 イベント ログに関する記事を参照してください。

WCF トレースは、System.Diagnostics に基づいています。 トレースを使用するには、構成ファイルまたはコードでトレース ソースを定義する必要があります。 WCF は、WCF アセンブリごとにトレース ソースを定義します。 System.ServiceModel トレース ソースは最も一般的な WCF トレース ソースで、トランスポートへの出入りからユーザー コードへの出入りまで、WCF 通信スタック全体の処理マイルストーンを記録します。 System.ServiceModel.MessageLogging トレース ソースは、システムを通過するすべてのメッセージを記録します。

既定では、トレースは無効です。 トレースを有効にするには、トレース リスナーを作成し、構成で選択したトレース ソースのトレース レベルを "Off" 以外に設定する必要があります。それ以外の場合、WCF はトレースを生成しません。 リスナーを指定しないと、トレースは自動的に無効になります。 リスナーを定義してもトレース レベルを指定しないと、トレース レベルは既定で "Off" に設定され、トレースが出力されなくなります。

WCF 機能拡張ポイント (カスタム操作の呼び出し元など) を使用する場合、独自のトレースを出力する必要があります。 これは、機能拡張ポイントを実装すると、WCF が既定のパスに標準のトレースを出力できなくなるためです。 トレースを出力することで手動トレースのサポートを実装しない場合、予測したトレースが得られない場合があります。

トレースは、アプリケーションの構成ファイル (Web ホスト型アプリケーションの場合は Web.config、自己ホスト型アプリケーションの場合は Appname.exe.config) を編集することで構成できます。 以下は、このような編集の例です。 これらの設定の詳細については、「トレースを使用するためのトレース リスナーの構成」のセクションを参照してください。

<configuration>  
   <system.diagnostics>  
      <sources>  
         <source name="System.ServiceModel"
                    switchValue="Information, ActivityTracing"  
                    propagateActivity="true">  
            <listeners>  
               <add name="traceListener"
                   type="System.Diagnostics.XmlWriterTraceListener"
                   initializeData= "c:\log\Traces.svclog" />  
            </listeners>  
         </source>  
      </sources>  
   </system.diagnostics>  
</configuration>  

トレースを出力するためのトレース ソースの構成

WCF は、アセンブリごとにトレース ソースを定義します。 アセンブリ内で生成されたトレースは、該当するソースで定義されているリスナーによってアクセスされます。 次のトレース ソースが定義されます。

• System.ServiceModel: 構成の読み取り、トランスポートでのメッセージの処理、セキュリティ処理、ユーザー コードでのメッセージのディスパッチなど、WCF 処理のすべての段階を記録します。

• System.ServiceModel.MessageLogging: システムを通過するすべてのメッセージを記録します。

• System.IdentityModel

• System.ServiceModel.Activation

• System.IO.Log: Common Log File System (CLFS) への .NET Framework インターフェイスを記録します。

• System.Runtime.Serialization: オブジェクトの読み取りまたは書き込みを記録します。

• CardSpace

各トレース ソースは、次の構成例に示すように同じ (共有) リスナーを使用するように構成できます。

<configuration>  
    <system.diagnostics>  
        <sources>  
            <source name="System.ServiceModel"
                    switchValue="Information, ActivityTracing"  
                    propagateActivity="true">  
                <listeners>  
                    <add name="xml" />  
                </listeners>  
            </source>  
            <source name="CardSpace">  
                <listeners>  
                    <add name="xml" />  
                </listeners>  
            </source>  
            <source name="System.IO.Log">  
                <listeners>  
                    <add name="xml" />  
                </listeners>  
            </source>  
            <source name="System.Runtime.Serialization">  
                <listeners>  
                    <add name="xml" />  
                </listeners>  
            </source>  
            <source name="System.IdentityModel">  
                <listeners>  
                    <add name="xml" />  
                </listeners>  
            </source>  
        </sources>  
  
        <sharedListeners>  
            <add name="xml"  
                 type="System.Diagnostics.XmlWriterTraceListener"  
                 initializeData="c:\log\Traces.svclog" />  
        </sharedListeners>  
    </system.diagnostics>  
</configuration>  

さらに、次の例に示すように、ユーザー定義のトレース ソースを追加してユーザー コード トレースを出力することもできます。

<system.diagnostics>  
   <sources>  
       <source name="UserTraceSource" switchValue="Warning, ActivityTracing" >  
          <listeners>  
              <add name="xml"  
                 type="System.Diagnostics.XmlWriterTraceListener"  
                 initializeData="C:\logs\UserTraces.svclog" />  
          </listeners>  
       </source>  
   </sources>  
   <trace autoflush="true" />
</system.diagnostics>  

ユーザー定義のトレース ソースの作成の詳細については、「トレースの拡張」を参照してください。

トレースを使用するためのトレース リスナーの構成

WCF により、実行時にトレース データを処理するリスナーにデータが送信されます。 WCF は System.Diagnostics に出力の形式が異なる複数の定義済みリスナーを提供します。 カスタム リスナーの種類を追加することもできます。

add を使用して、使用するトレース リスナーの名前と種類を指定できます。 この例の構成では、リスナーに traceListener という名前を付け、使用する種類として標準の .NET Framework トレース リスナー (System.Diagnostics.XmlWriterTraceListener) を追加しています。 ソースごとに任意の数のトレース リスナーを追加できます。 トレース リスナーがトレースをファイルに出力する場合は、構成ファイルで出力ファイルの場所と名前を指定する必要があります。 指定するには、initializeData をそのリスナーのファイルの名前に設定します。 ファイル名を指定しないと、使用するリスナーの種類に基づいて任意のファイル名が生成されます。 XmlWriterTraceListener を使用した場合は、拡張子のないファイル名が生成されます。 カスタム リスナーを実装した場合は、この属性を使用して、ファイル名以外の初期化データを受け取ることもできます。 たとえば、この属性にデータベース識別子を指定できます。

カスタム トレース リスナーは、ネットワーク上のリモート データベースなどにトレースを送信するように構成できます。 アプリケーションを展開するユーザーは、リモート コンピューターのトレース ログに適切なアクセス制御を適用する必要があります。

また、トレース リスナーはプログラムによって構成することもできます。 詳細については、「方法: トレース リスナーを作成し初期化する」と「Creating a Custom TraceListener」を参照してください。

トレース レベル

トレース レベルは、トレース ソースの switchValue 設定で制御します。 使用できるトレース レベルを次の表に示します。

Verbose から Critical までのレベルは相互にスタックされます。つまり、各トレース レベルには、そのレベルよりも上位のすべてのレベルが含まれます (Off レベルを除く)。 たとえば、Warning レベルでリッスンしているリスナーは、Critical、Error、Warning の各トレースを受け取ります。 All レベルには、Verbose から Critical までのイベントとアクティビティ トレース イベントが含まれます。

アクティビティ トレースと伝達の関連付けの構成

activityTracing 属性に指定する switchValue 値を使用してアクティビティ トレースを有効にし、エンドポイント内のアクティビティの境界と転送のトレースを出力できます。

propagateActivity 属性は、メッセージ交換に参加している他のエンドポイントにアクティビティを伝達する必要があるかどうかを示します。 この値を true に設定すると、任意の 2 つのエンドポイントで生成されたトレース ファイルを取得し、一方のエンドポイントのトレース セットがもう一方のエンドポイントのトレース セットにどのように転送されるかを監視できます。

アクティビティのトレースと伝達の詳細については、「伝達」を参照してください。

propagateActivity ブール値と ActivityTracing ブール値は共に System.ServiceModel TraceSource に適用されます。 また、ActivityTracing 値は、WCF またはユーザー定義トレース ソースを含む任意のトレース ソースに適用されます。

ユーザー定義のトレース ソースでは、propagateActivity 属性を使用できません。 ユーザー コード アクティビティ ID の伝達では、ServiceModel ActivityTracing 属性を propagateActivity に設定しているときは、ServiceModel true を設定しないでください。

関連項目

• トレース
• 管理と診断
• 方法: トレース リスナーを作成し初期化する
• カスタム TraceListener の作成