ワークフローの追跡の構成

[アーティクル]
05/09/2023

ワークフローは、次の 3 つの方法で実行できます。

でホストされる WorkflowServiceHost
WorkflowApplication として実行する
WorkflowInvoker を使用して直接実行する

ワークフローのホストオプションに応じて、コードまたは構成ファイルによって追跡参加要素を追加できます。ここでは、追跡参加要素を WorkflowApplication および WorkflowServiceHost に追加して追跡を構成する方法、および WorkflowInvoker の使用時に追跡を有効にする方法について説明します。

ワークフローアプリケーション追跡の構成

ワークフローは、WorkflowApplication クラスを使用して実行できます。このトピックでは、追跡参加要素を WorkflowApplication ワークフローホストに追加することで、.NET Framework 4.6.1 ワークフローアプリケーション用に追跡を構成する方法を示します。この場合、ワークフローはワークフローアプリケーションとして実行されます。 WorkflowApplication クラスを使用する自己ホスト型の .exe ファイルであるコードを介して (構成ファイルを使用せずに)、ワークフローアプリケーションを構成します。追跡参加要素は WorkflowApplication インスタンスの拡張として追加します。これを行うには、TrackingParticipant を WorkflowApplication インスタンスの拡張コレクションに追加します。

ワークフローアプリケーションの場合、次のコードのように EtwTrackingParticipant 動作拡張を追加できます。

LogActivity activity = new LogActivity();

WorkflowApplication instance = new WorkflowApplication(activity);
EtwTrackingParticipant trackingParticipant =
    new EtwTrackingParticipant
{

        TrackingProfile = new TrackingProfile
           {
               Name = "SampleTrackingProfile",
               ActivityDefinitionId = "ProcessOrder",
               Queries = new WorkflowInstanceQuery
               {
                  States = { "*" }
              }
          }
       };
instance.Extensions.Add(trackingParticipant);

ワークフローサービス追跡の構成

ワークフローは、WorkflowServiceHost サービスホストでホストされると、WCF サービスとして公開できます。 WorkflowServiceHost は、ワークフローベースのサービスの .NET ServiceHost の特殊な実装です。このセクションでは、WorkflowServiceHost で実行されている .NET Framework 4.6.1 ワークフローサービスの追跡を構成する方法について説明します。 Web.config ファイル (Web ホストサービスの場合) または App.config ファイル (コンソールアプリケーションなどのスタンドアロンアプリケーションでホストされるサービスの場合) を介し、サービス動作を指定して構成するか、またはコードを介し、サービスホスト用に Behaviors コレクションに追跡固有の動作を追加して構成できます。

WorkflowServiceHost でホストされるワークフローサービスの場合、次の例のように、構成ファイル内で <behavior> 要素を使用して EtwTrackingParticipant を追加できます。

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

また、WorkflowServiceHost でホストされるワークフローサービスの場合、コードを介して EtwTrackingParticipant 動作拡張を追加できます。カスタムの追跡参加要素を追加するには、次のコード例のように、新しい動作拡張を作成し、それを ServiceHost に追加します。

注意

カスタムの追跡参加要素を追加するカスタムの動作要素を作成する方法を示すサンプルコードを確認するには、「追跡」のサンプルを参照してください。

ServiceHost svcHost = new ServiceHost(typeof(WorkflowService), new
                                 Uri("http://localhost:8001/Sample"));
EtwTrackingBehavior trackingBehavior =
    new EtwTrackingBehavior
    {
        ProfileName = "Sample Tracking Profile"
    };
svcHost.Description.Behaviors.Add(trackingBehavior);
svcHost.Open();

追跡参加要素は、動作の拡張としてワークフローサービスホストに追加されます。

以下のサンプルコードは、構成ファイルから追跡プロファイルを読み取る方法の例です。

TrackingProfile GetProfile(string profileName, string displayName)
        {
            TrackingProfile trackingProfile = null;
            TrackingSection trackingSection = (TrackingSection)WebConfigurationManager.GetSection("system.serviceModel/tracking");
            if (trackingSection == null)
            {
                return null;
            }

            profileName ??= "";

            //Find the profile with the specified profile name in the list of profile found in config
            var match = from p in new List<TrackingProfile>(trackingSection.TrackingProfiles)
                        where (p.Name == profileName) && ((p.ActivityDefinitionId == displayName) || (p.ActivityDefinitionId == "*"))
                        select p;

            if (match.Count() == 0)
            {
                //return an empty profile
                trackingProfile = new TrackingProfile()
                {
                    ActivityDefinitionId = displayName
                };

            }
            else
            {
                trackingProfile = match.First();
            }

            return trackingProfile;

このサンプルコードは、ワークフローホストに追跡プロファイルを追加する方法の例です。

WorkflowServiceHost workflowServiceHost = serviceHostBase as WorkflowServiceHost;
if (null != workflowServiceHost)
{
    string workflowDisplayName = workflowServiceHost.Activity.DisplayName;
    TrackingProfile trackingProfile = GetProfile(this.profileName, workflowDisplayName);
    workflowServiceHost.WorkflowExtensions.Add(()  => new EtwTrackingParticipant {
        TrackingProfile = trackingProfile
    });
 }

注意

追跡プロファイルの詳細については、「追跡プロファイル」を参照してください。

WorkflowInvoker を使用した追跡の構成

WorkflowInvoker を使用して実行するワークフローの追跡を構成するには、追跡プロバイダーを拡張として WorkflowInvoker インスタンスに追加します。次のコード例は、「カスタム追跡」のサンプルから抜粋したものです。

WorkflowInvoker invoker = new WorkflowInvoker(BuildSampleWorkflow());
invoker.Extensions.Add(customTrackingParticipant);
invoker.Invoke();

イベントビューアーでの追跡レコードの表示

WF 実行 - 分析ログとデバッグログ - を追跡すると、特に興味深い 2 つのイベントビューアーのログ記録があります。 2 つとも [Microsoft]、[Windows]、[アプリケーションサーバー - アプリケーション] ノードの下にあります。このセクション含まれるログは、システム全体に影響を及ぼすイベントではなく、1 つのアプリケーションからのイベントを格納します。

デバッグトレースのイベントがデバッグログに書き込まれます。イベントビューアー内の WF のデバッグトレースイベントを収集するには、デバッグログを有効にします。

イベントビューアーを開くには、[スタート] をクリックし、[ファイル名を指定して実行] をクリックします。[ファイル名を指定して実行] ダイアログボックスで、「eventvwr」と入力します。
[イベントビューアー] ダイアログボックスで、 [アプリケーションとサービスログ] ノードを展開します。
[Microsoft] 、 [Windows] 、 [アプリケーションサーバー - アプリケーション] の順にノードを展開します。
[アプリケーションサーバー - アプリケーション] ノードの下の [デバッグ] ノードを右クリックし、 [ログの有効化] をクリックします。
トレースが有効になっているアプリケーションを実行して追跡イベントを生成します。
[デバッグ] ノードを右クリックし、[最新の情報に更新] を選択します。トレースイベントが中央ペインに表示されます。

WF 4 には、追跡レコードを ETW (Event Tracing for Windows) セッションに書き込む追跡参加要素が用意されています。 ETW 追跡参加要素は、追跡レコードを定期受信するように追跡プロファイルで構成されています。追跡が有効な場合は、エラーの追跡レコードが ETW に出力されます。 ETW 追跡参加要素によって出力される追跡イベントに対応する ETW 追跡イベント (100 ～ 113 の範囲にある) が分析ログに書き込まれます。

追跡レコードを表示するには、次の手順を実行します。

イベントビューアーを開くには、[スタート] をクリックし、[ファイル名を指定して実行] をクリックします。[ファイル名を指定して実行] ダイアログボックスで、「eventvwr」と入力します。
[イベントビューアー] ダイアログボックスで、 [アプリケーションとサービスログ] ノードを展開します。
[Microsoft] 、 [Windows] 、 [アプリケーションサーバー - アプリケーション] の順にノードを展開します。
[アプリケーションサーバー - アプリケーション] ノードの下の [分析] ノードを右クリックし、 [ログの有効化] をクリックします。
追跡が有効になっているアプリケーションを実行して追跡レコードを生成します。
[分析] ノードを右クリックし、[最新の情報に更新] を選択します。追跡レコードが中央ペインに表示されます。

次の図は、イベントビューアーでの追跡イベントを示しています。

Screenshot of the Event Viewer showing tracking records.

アプリケーション固有のプロバイダー ID の登録

イベントを特定のアプリケーションログに書き込む必要がある場合は、次の手順に従って新しいプロバイダーマニフェストを登録します。

アプリケーション構成ファイルでプロバイダー ID を宣言します。

<system.serviceModel>
    <diagnostics etwProviderId="2720e974-9fe9-477a-bb60-81fe3bf91eec"/>
</system.serviceModel>

マニフェストファイルを %windir%\Microsoft.NET\Framework\<.NET Framework 4.6.1 の最新バージョン>\Microsoft.Windows.ApplicationServer.Applications.man から一時的な場所にコピーし、その名前を Microsoft.Windows.ApplicationServer.Applications_Provider1.man に変更します

マニフェストファイルの GUID を新しい GUID に変更します。

<provider name="Microsoft-Windows-Application Server-Applications" guid="{2720e974-9fe9-477a-bb60-81fe3bf91eec}" />

既定のプロバイダーをアンインストールしない場合は、プロバイダー名を変更します。

<provider name="Microsoft-Windows-Application Server-Applications" guid="{2720e974-9fe9-477a-bb60-81fe3bf91eec}" />

前の手順でプロバイダー名を変更した場合は、マニフェストファイルのチャネル名を新しいプロバイダー名に変更します。

<channel name="Microsoft-Windows-Application Server-Applications_Provider1/Admin" chid="ADMIN_CHANNEL" symbol="ADMIN_CHANNEL" type="Admin" enabled="false" isolation="Application" message="$(string.MICROSOFT_WINDOWS_APPLICATIONSERVER_APPLICATIONS.channel.ADMIN_CHANNEL.message)" />
<channel name="Microsoft-Windows-Application Server-Applications_Provider1/Operational" chid="OPERATIONAL_CHANNEL" symbol="OPERATIONAL_CHANNEL" type="Operational" enabled="false" isolation="Application" message="$(string.MICROSOFT_WINDOWS_APPLICATIONSERVER_APPLICATIONS.channel.OPERATIONAL_CHANNEL.message)" />
<channel name="Microsoft-Windows-Application Server-Applications_Provider1/Analytic" chid="ANALYTIC_CHANNEL" symbol="ANALYTIC_CHANNEL" type="Analytic" enabled="false" isolation="Application" message="$(string.MICROSOFT_WINDOWS_APPLICATIONSERVER_APPLICATIONS.channel.ANALYTIC_CHANNEL.message)" />
<channel name="Microsoft-Windows-Application Server-Applications_Provider1/Debug" chid="DEBUG_CHANNEL" symbol="DEBUG_CHANNEL" type="Debug" enabled="false" isolation="Application" message="$(string.MICROSOFT_WINDOWS_APPLICATIONSERVER_APPLICATIONS.channel.DEBUG_CHANNEL.message)" />
<channel name="Microsoft-Windows-Application Server-Applications_Provider1/Perf" chid="PERF_CHANNEL" symbol="PERF_CHANNEL" type="Analytic" enabled="false" isolation="Application" message="$(string.MICROSOFT_WINDOWS_APPLICATIONSERVER_APPLICATIONS.channel.PERF_CHANNEL.message)" />

次の手順に従ってリソース DLL を生成します。
1. Windows SDK をインストールします。 Windows SDK には、メッセージコンパイラ (mc.exe) およびリソースコンパイラ (rc.exe) が含まれています。
2. Windows SDK コマンドプロンプトで、新しいマニフェストファイルに対して mc.exe を実行します。
```
mc.exe Microsoft.Windows.ApplicationServer.Applications_Provider1.man
```
3. 前の手順で生成されたリソースファイルに対して rc.exe を実行します。
```
rc.exe  Microsoft.Windows.ApplicationServer.Applications_Provider1.rc
```
4. NewProviderReg.cs という名前の空の cs ファイルを作成します。
5. C# コンパイラを使用してリソース DLL を作成します。
```
csc /target:library /win32res:Microsoft.Windows.ApplicationServer.Applications_Provider1.res NewProviderReg.cs /out:Microsoft.Windows.ApplicationServer.Applications_Provider1.dll
```
6. マニフェストファイル内のリソースとメッセージの dll 名を Microsoft.Windows.ApplicationServer.Applications.Provider1.man から新しい dll 名に変更します。
```
<provider name="Microsoft-Windows-Application Server-Applications_Provider1" guid="{2720e974-9fe9-477a-bb60-81fe3bf91eec}" symbol="Microsoft_Windows_ApplicationServer_ApplicationEvents" resourceFileName="<dll directory>\Microsoft.Windows.ApplicationServer.Applications_Provider1.dll" messageFileName="<dll directory>\Microsoft.Windows.ApplicationServer.Applications_Provider1.dll" />
```
7. wevtutil を使用してマニフェストを登録します。
```
wevtutil im Microsoft.Windows.ApplicationServer.Applications_Provider1.man
```

次の方法で共有

ワークフローの追跡の構成

ワークフローアプリケーション追跡の構成

ワークフローサービス追跡の構成

WorkflowInvoker を使用した追跡の構成

イベントビューアーでの追跡レコードの表示

アプリケーション固有のプロバイダー ID の登録

関連項目

その他のリソース

次の方法で共有

ワークフローの追跡の構成

ワークフロー アプリケーション追跡の構成

ワークフロー サービス追跡の構成

WorkflowInvoker を使用した追跡の構成

イベント ビューアーでの追跡レコードの表示

アプリケーション固有のプロバイダー ID の登録

関連項目

その他のリソース

ワークフローアプリケーション追跡の構成

ワークフローサービス追跡の構成

イベントビューアーでの追跡レコードの表示