追跡を使用した WF データの抽出

2011-02-24

このトピックの内容は、Windows Workflow Foundation 4 に該当します。

このサンプルでは、ワークフロー追跡を使用して、アクティビティからワークフロー変数と引数を抽出する方法を示します。また、追跡レコードへの注釈の追加、およびカスタム追跡レコード内のデータペイロードの抽出の例も示します。このサンプルでは、ワークフローからデータを抽出するために Event Tracing for Windows (ETW) 追跡参加要素を使用します。

サンプルの詳細

Windows Workflow Foundation (WF) には、ワークフローインスタンスの実行を視覚的に示す追跡機能が用意されています。追跡ランタイムでは、ワークフローの実行中にワークフロー追跡レコードが出力されます。このワークフロー追跡レコードと共に、ワークフローインスタンス内のデータをワークフローから抽出することができます。追跡レコードから抽出できるデータの種類の詳細を以下に示します。

アクティビティ内のワークフロー変数とアクティビティの実行時の追跡レコード。

ワークフロー変数を抽出するには、抽出する変数をプロファイルで指定します。抽出する変数は、ActivityStateQueries でのみ指定できます。アクティビティからワークフロー変数を抽出するために使用する追跡プロファイルのコード例を次に示します。
```
<activityStateQuery activityName="StockPriceService">
     <states>
          <state name="Closed"/>
     </states>
     <variables>
          <variable name="symbol"/>
     </variables>
</activityStateQuery>
```
アクティビティ引数とアクティビティ状態の追跡レコード。

引数は、アクティビティとのデータフローの方法を定義します。抽出する引数は、ActivityStateQuery を使用して指定します。Value 引数を抽出する追跡プロファイルのコード例を次に示します。
```
<activityStateQuery activityName="GetStockPrice">
     <states>
          <state name="Closed"/>
     </states>
     <arguments>
          <argument name="Value"/>
     </arguments>
</activityStateQuery>
```
注釈は、出力される追跡レコードに追加できるキーと値のペアです。

注釈は、追跡レコードのタグ付け機構として機能します。追跡プロファイルを通して追跡レコードに追加され、どの種類のワークフロー追跡クエリにも追加できます。追跡レコードに注釈を追加する方法を示す追跡プロファイルのコード例を次に示します。
```
<workflowInstanceQuery>
     <states>
          <state name="Started"/>
     </states>
     <annotations>
          <annotation name="StockPriceWorkflow" value="Begin"/>
     </annotations>
</workflowInstanceQuery>
```
カスタム追跡レコードは、ユーザー定義のアクティビティから出力されます。

カスタム追跡レコードは、対象のアクティビティ内で定義されたペイロードデータを伝達できます。追跡プロファイルでカスタム追跡レコードをサブスクライブすると、追跡レコード内のペイロードを抽出することができます。カスタム追跡レコードを抽出するには、カスタムの TrackingQuery を使用します。カスタム追跡レコードをそのペイロードと共に抽出する追跡プロファイルのコード例を次に示します。
```
<customTrackingQuery name="QuoteLookupEvent" activityName="GetStockPrice"/>
```

このサンプルでは、Web.config で指定されたプロファイルを使用して、変数、引数、およびカスタムレコードを抽出し、注釈を追加する例を示しています。サンプルのワークフローサービスでは、<etwTracking> 動作要素を追加して追跡を有効にしています。ExtractWorkflowVariables 追跡プロファイルの追跡を有効にするコード例を次に示します。

<serviceBehaviors>
     <behavior>
               <etwTracking profileName="ExtractWorkflowVariables"/>
     </behavior>
</serviceBehaviors>

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

Visual Studio 2010 を使用して、WFStockPriceApplication.sln ソリューションファイルを開きます。
ソリューションをビルドするには、F6 キーを押します。
ソリューションを実行するには、F5 キーを押します。

ブラウザーウィンドウが開き、アプリケーションのディレクトリの一覧が示されます。
ブラウザーで、StockPriceService.xamlx をクリックします。
ブラウザーに、[StockPriceService] ページが表示され、ローカルサービスの WSDL アドレスが示されます。このアドレスをコピーします。

ローカルサービスの WSDL アドレスの例を次に示します。https://localhost:53797/StockPriceService.xamlx?wsdl
サービスを呼び出す前に、イベントビューアーを起動し、ワークフローサービスから生成された追跡イベントをイベントログでリッスンしていることを確認します。
[スタート] メニューから、[管理ツール]、[イベントビューアー] の順に選択します。
イベントビューアーのツリービューで、[イベントビューアー]、[アプリケーションとサービスログ] の順に選択して [Microsoft] に移動します。[Microsoft] を右クリックし、[表示]、[分析およびデバッグログの表示] の順にクリックします。

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

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

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

前の手順でコピーしたローカルサービスの WSDL アドレスを入力ボックスに追加します。
WCF テストクライアントで、GetStockPrice をダブルクリックします。

GetStockPrice メソッドが開きます。この要求はパラメーターを 1 つ受け取ります。値 Contoso を使用します。
[起動] をクリックします。
イベントビューアーに戻り、[イベントビューアー]、[アプリケーションとサービスログ]、[Microsoft]、[Windows] の順に選択して [アプリケーションサーバー - アプリケーション] に移動します。[分析] を右クリックし、[更新] を選択します。ワークフローイベントのイベント ID の範囲は 100 ～ 199 です。

イベントには、イベントビューアーで表示できる注釈、変数、引数、およびカスタム追跡レコードが含まれます。

イベントビューアーでのクリーンアップ

イベントログの分析チャネルは、次の手順に従ってイベントビューアーでクリーンアップできます。

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

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

[クリア] オプションを選択してイベントをクリアします。

既知の問題

注 :
イベントビューアーの既知の問題により、ETW イベントをデコードできない場合があります。その場合、次のようなエラーメッセージが表示されます。 `ソース "Microsoft-Windows-Application Server-Applications" からのイベント ID <id> の説明が見つかりません。このイベントを発生させるコンポーネントがローカルコンピューターにインストールされていないか、インストールが壊れています。ローカルコンピューターにコンポーネントをインストールするか、コンポーネントを修復してください。` このエラーが発生した場合は、操作ウィンドウで [最新の情報に更新] をクリックしてください。これにより、イベントが正常にデコードされます。

注 :

イベントビューアーの既知の問題により、ETW イベントをデコードできない場合があります。その場合、次のようなエラーメッセージが表示されます。

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

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

注 :
サンプルは、既にコンピューターにインストールされている場合があります。続行する前に、次の (既定の) ディレクトリを確認してください。 `<InstallDrive>:\WF_WCF_Samples` このディレクトリが存在しない場合は、「.NET Framework 4 向けの Windows Communication Foundation (WCF) および Windows Workflow Foundation (WF) のサンプル」にアクセスして、Windows Communication Foundation (WCF) および WF のサンプルをすべてダウンロードしてください。このサンプルは、次のディレクトリに格納されます。 `<InstallDrive>:\WF_WCF_Samples\WF\Basic\Tracking\ExtractWfData`

注 :

サンプルは、既にコンピューターにインストールされている場合があります。続行する前に、次の (既定の) ディレクトリを確認してください。

<InstallDrive>:\WF_WCF_Samples

このディレクトリが存在しない場合は、「.NET Framework 4 向けの Windows Communication Foundation (WCF) および Windows Workflow Foundation (WF) のサンプル」にアクセスして、Windows Communication Foundation (WCF) および WF のサンプルをすべてダウンロードしてください。このサンプルは、次のディレクトリに格納されます。

<InstallDrive>:\WF_WCF_Samples\WF\Basic\Tracking\ExtractWfData