Windows でのイベントトレースへのイベントの追跡

2025-06-22

EtwTracking サンプルでは、ワークフローサービスで Windows Workflow Foundation (WF) 追跡を有効にし、Windows イベントトレーシング (ETW) で追跡イベントを出力する方法を示します。ワークフロー追跡レコードを ETW に出力するために、サンプルでは ETW 追跡参加要素 (EtwTrackingParticipant) を使用します。

サンプルのワークフローは要求を受け取り、入力データの逆数を入力変数に割り当て、逆数をクライアントに返します。入力データが 0 の場合、ワークフローを中止するハンドルされない 0 除算例外が発生します。追跡を有効にすると、エラー追跡レコードが ETW に出力されます。これは、後でエラーのトラブルシューティングを行うのに役立ちます。 ETW 追跡参加要素は、追跡レコードをサブスクライブする追跡プロファイルで構成されます。追跡プロファイルは、Web.config ファイルで定義され、構成パラメーターとして ETW 追跡参加要素に提供されます。 ETW 追跡参加要素は、ワークフローサービスの Web.config ファイルで構成され、サービスの動作としてサービスに適用されます。このサンプルでは、イベントビューアーを使用して、イベントログに追跡イベントを表示します。

ワークフロー追跡の詳細

Windows Workflow Foundation には、ワークフローインスタンスの実行を追跡するための追跡インフラストラクチャが用意されています。追跡ランタイムは、ワークフローライフサイクルに関連するイベント、ワークフローアクティビティからのイベント、およびカスタムイベントを出力するワークフローインスタンスを作成します。次の表では、追跡インフラストラクチャの主要なコンポーネントについて詳しく説明します。

コンポーネント	説明
追跡ランタイム	追跡レコードを出力するインフラストラクチャを提供します。
参加者の追跡	追跡レコードにアクセスします。 .NET Framework 4.6.1 には、Windows イベントトレーシング (ETW) イベントとして追跡レコードを書き込む追跡参加要素が付属しています。
追跡プロファイル	追跡参加要素がワークフローインスタンスから出力された追跡レコードのサブセットをサブスクライブできるようにするフィルター処理メカニズム。

次の表は、ワークフローランタイムが出力する追跡レコードの詳細を示しています。

追跡レコード	説明
ワークフローインスタンス追跡レコード。	ワークフローインスタンスのライフサイクルについて説明します。たとえば、ワークフローの開始時または完了時にインスタンスレコードが出力されます。
アクティビティ状態追跡レコード。	アクティビティの実行の詳細。これらのレコードは、アクティビティがスケジュールされたとき、アクティビティが完了したとき、またはエラーがスローされたときなど、ワークフローアクティビティの状態を示します。
ブックマーク再開レコード。	ワークフローインスタンス内のブックマークが再開されるたびに生成されます。
カスタム追跡レコード。	ワークフロー作成者は、カスタム追跡レコードを作成し、カスタムアクティビティ内でそれらを出力できます。
ActivityScheduledRecord	このレコードは、アクティビティが別のアクティビティをスケジュールするときに生成されます。
FaultPropagationRecord	このレコードは、アクティビティから障害が伝達されたときに生成されます。
CancelRequestedRecord	このレコードは、アクティビティが別のアクティビティによって取り消されたときに生成されます。

追跡参加要素は、追跡プロファイルを使用して、出力された追跡レコードのサブセットをサブスクライブします。追跡プロファイルには、特定の追跡レコードの種類をサブスクライブできる追跡クエリが含まれています。追跡プロファイルは、コードまたは構成で指定できます。

このサンプルを使用するには

Visual Studio を使用して、EtwTrackingParticipantSample.sln ソリューションファイルを開きます。
ソリューションをビルドするには、Ctrl キーと Shift キーを押しながら B キーを押します。
ソリューションを実行するには、F5 キーを押します。

既定では、サービスはポート 53797 (http://localhost:53797/SampleWorkflowService.xamlx) でリッスンしています。
エクスプローラーを使用して、WCF テストクライアントを開きます。

WCF テストクライアント (WcfTestClient.exe) は、 <Visual Studio のインストールフォルダー>\Common7\IDE\ フォルダーにあります。

既定の Visual Studio インストールフォルダーは C:\Program Files\Microsoft Visual Studio 10.0 です。
WCF テストクライアントで、[ファイル] メニューから [サービスの追加] を選択します。

入力ボックスにエンドポイントアドレスを追加します。既定値は http://localhost:53797/SampleWorkflowService.xamlxです。
イベントビューアーアプリケーションを開きます。

サービスを呼び出す前に、[スタート] メニューからイベントビューアーを起動し、[ 実行 ] を選択し、 eventvwr.exe入力します。イベントログがワークフローサービスから出力された追跡イベントをリッスンしていることを確認します。
イベントビューアーのツリービューで、 イベントビューアー、 アプリケーションとサービスログ、 および Microsoft に移動します。 Microsoft を右クリックし、[表示] を選択し、[分析ログとデバッグログの表示] を選択して、分析ログとデバッグログを有効にします

[ 分析ログとデバッグログの表示 ] オプションがオンになっていることを確認します。
イベントビューアーのツリービューで、 イベントビューアー、 アプリケーションおよびサービスログ、 Microsoft、 Windows、 Application Server-Applications に移動します。 [分析] を右クリックし、[ログの有効化] を選択して分析ログを有効にします。
をダブルクリックして、WCF テストクライアントを使用してサービスをテストします。

これにより、 GetData メソッドが開きます。要求は 1 つのパラメーターを受け取り、値が 0 (既定値) であることを確認します。

[ 呼び出し] をクリックします。
ワークフローから生成されたイベントを確認します。

イベントビューアーに戻り、 イベントビューアー、 アプリケーション、サービスログ、 Microsoft、 Windows、 Application Server-Applications に移動します。 [分析] を右クリックし、[最新の情報に更新] を選択します。

ワークフローイベントがイベントビューアーに表示されます。ワークフロー実行イベントが表示され、そのうちの 1 つがワークフロー内のエラーに対応するハンドルされない例外であることに注意してください。また、ワークフローアクティビティから警告イベントが生成されます。これは、アクティビティがエラーをスローしていることを示します。
エラーがスローされないように、0 以外のデータの入力で手順 9 と 10 を繰り返します。

追跡プロファイルを使用すると、ワークフローインスタンスの状態が変化したときにランタイムによって生成されるイベントをサブスクライブできます。監視の要件に応じて、非常に粗いプロファイルを作成できます。このプロファイルは、ワークフロー上の少数の高レベルの状態変更をサブスクライブします。一方、実行を後で再構築するのに十分な量の出力を持つ、非常に正確なプロファイルを作成できます。このサンプルでは、 HealthMonitoring Tracking Profileを使用してワークフローランタイムから ETW に出力されるイベントを示します。これは、少数のイベントセットを出力します。さらに多くのワークフロー追跡イベントを出力する別のプロファイルも、 Troubleshooting Tracking Profileという名前の Web.config で提供されます。 .NET Framework 4.6.1 をインストールすると、Machine.config ファイルに空の名前の既定のプロファイルが構成されます。このプロファイルは、プロファイル名または空のプロファイル名が指定されていない場合に、ETW 追跡動作構成によって使用されます。

正常性監視追跡プロファイルは、ワークフローインスタンスレコードとアクティビティエラー伝達レコードを出力します。このプロファイルは、次の追跡プロファイルを Web.config 構成ファイルに追加することによって作成されます。

<tracking>
  <profiles>
    <trackingProfile name="HealthMonitoring Tracking Profile">
      <workflow activityDefinitionId="*">
        <workflowInstanceQueries>
          <workflowInstanceQuery>
            <states>
              <state name="Started"/>
              <state name="Completed"/>
              <state name="Aborted"/>
              <state name="UnhandledException"/>
            </states>
          </workflowInstanceQuery>
        </workflowInstanceQueries>
        <faultPropagationQueries>
          <faultPropagationQuery faultSourceActivityName ="*" faultHandlerActivityName="*"/>
        </faultPropagationQueries>
      </workflow>
    </trackingProfile>
  </profiles>
</tracking>

プロファイルは、 EtwTrackingParticipant 構成を次のように変更することで変更できます。

<behaviors>
  <serviceBehaviors>
    <behavior>
      <etwTracking profileName="HealthMonitoring Tracking Profile"/>
    </behavior>
  </serviceBehaviors>
</behaviors>

クリーンアップするには (省略可能)

イベントビューアーを開きます。
イベントビューアー、アプリケーション、サービスログ、Microsoft、Windows、Application Server-Applications に移動します。 [分析] を右クリックし、[ログの無効化] を選択します。
イベントビューアー、アプリケーション、サービスログ、Microsoft、Windows、Application Server-Applications に移動します。 [分析] を右クリックし、[ログのクリア] を選択します。
[ クリア ] オプションを選択してイベントをクリアします。

既知の問題

注

イベントビューアーには、ETW イベントのデコードに失敗する可能性がある既知の問題があります。次のようなエラーメッセージが表示される場合があります。

ソース MicrosoftWindows-Application Server-Applications からのイベント ID <id> の説明が見つかりません。このイベントを発生させるコンポーネントがローカルコンピューターにインストールされていないか、インストールが壊れています。ローカルコンピューターにコンポーネントをインストールするか、コンポーネントを修復してください。

このエラーが発生した場合は、操作ウィンドウで [更新] をクリックします。これで、イベントが正しくデコードされます。

こちらも参照ください

AppFabric 監視のサンプル