カスタム追跡

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

CustomTracking サンプルでは、カスタムの追跡参加要素を作成し、追跡データをコンソールに出力する方法を示します。また、ユーザー定義データが設定された CustomTrackingRecord オブジェクトを出力する方法も示します。コンソールベースの追跡参加要素は、コードで作成された追跡プロファイルオブジェクトを使用して、ワークフローで出力された TrackingRecord オブジェクトをフィルター処理します。

サンプルの詳細

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

コンポーネント	説明
追跡ランタイム	追跡レコードを出力するためのインフラストラクチャを提供します。
追跡参加要素	追跡レコードを処理します。 .NET Framework 4 には、追跡レコードを Event Tracing for Windows (ETW) イベントとして書き込む追跡参加要素が用意されています。
追跡プロファイル	ワークフローインスタンスから出力された追跡レコードのサブセットを追跡参加要素から定期受信するためのフィルター機構。

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

追跡レコード	説明
ワークフローインスタンスの追跡レコード	ワークフローインスタンスのライフサイクルを表します。たとえば、ワークフローの開始時または完了時にインスタンスレコードが出力されます。
アクティビティ状態の追跡レコード	アクティビティの実行状況を詳しく記録します。これらのレコードは、アクティビティをスケジュールしたとき、アクティビティが完了したとき、エラーがスローされたときなど、ワークフローアクティビティの状態を示します。
ブックマーク再開レコード	ワークフローインスタンス内のブックマークが再開されたときに出力されます。
カスタム追跡レコード	ワークフロー作成者はカスタム追跡レコードを作成し、カスタムアクティビティ内で出力できます。

追跡参加要素は、追跡プロファイルを使用して、出力された TrackingRecord オブジェクトのサブセットを定期受信します。追跡プロファイルには、特定の追跡レコードタイプを定期受信するための追跡クエリが含まれています。追跡プロファイルは、コードで指定したり、構成で指定したりすることができます。

カスタムの追跡参加要素

追跡参加要素 API では、ワークフローランタイムが出力する TrackingRecord オブジェクトを処理するためのカスタムロジックを含めることが可能なユーザー指定の追跡参加要素を使用して、追跡ランタイムを拡張できます。

追跡参加要素を書き込むには、ユーザーは TrackingParticipant を実装する必要があります。具体的には、カスタム参加要素で Track メソッドを実装する必要があります。このメソッドは、ワークフローランタイムによって TrackingRecord が出力されるときに呼び出されます。

public abstract class TrackingParticipant
{
    protected TrackingParticipant();

    public virtual TrackingProfile TrackingProfile { get; set; }
    public abstract void Track(TrackingRecord record, TimeSpan timeout);
}

完全な追跡参加要素は ConsoleTrackingParticipant.cs ファイルで実装します。次のコード例は、カスタム追跡参加要素の Track メソッドです。

protected override void Track(TrackingRecord record, TimeSpan timeout)
{
    ...
    WorkflowInstanceRecord workflowInstanceRecord = record as WorkflowInstanceRecord;
    if (workflowInstanceRecord != null)
    {
        Console.WriteLine(String.Format(CultureInfo.InvariantCulture,
            " Workflow InstanceID: {0} Workflow instance state: {1}",
            record.InstanceId, workflowInstanceRecord.State));
    }

    ActivityStateRecord activityStateRecord = record as ActivityStateRecord;
    if (activityStateRecord != null)
    {
        IDictionary<String, object> variables = activityStateRecord.Variables;
        StringBuilder vars = new StringBuilder();

        if (variables.Count > 0)
        {
            vars.AppendLine("\n\tVariables:");
            foreach (KeyValuePair<string, object> variable in variables)
            {
                vars.AppendLine(String.Format(
                    "\t\tName: {0} Value: {1}", variable.Key, variable.Value));
            }
        }
        Console.WriteLine(String.Format(CultureInfo.InvariantCulture,
            " :Activity DisplayName: {0} :ActivityInstanceState: {1} {2}",
                activityStateRecord.Activity.Name, activityStateRecord.State,
            ((variables.Count > 0) ? vars.ToString() : String.Empty)));
    }

    CustomTrackingRecord customTrackingRecord = record as CustomTrackingRecord;

    if ((customTrackingRecord != null) && (customTrackingRecord.Data.Count > 0))
    {
        ...
    }
    Console.WriteLine();

}

次のコード例では、ワークフロー呼び出しの起動者にコンソール参加要素を追加します。

ConsoleTrackingParticipant customTrackingParticipant = new ConsoleTrackingParticipant()
{
    ...
    // The tracking profile is set here, refer to Program.CS
...
}

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