Modèles de suivi

Les modèles de suivi contiennent des requêtes de suivi qui permettent à un participant au suivi de s’abonner à des événements de flux de travail émis lorsque l’état d’une instance de flux de travail change au moment de l’exécution.

Modèles de suivi

Les modèles de suivi sont utilisés pour indiquer les informations suivi émises pour une instance de workflow. Si aucun profil n'est spécifié, tous les événements de suivi sont émis. Si un profil est spécifié, les événements de suivi spécifiés dans le profil seront émis. Selon vos exigences d’analyse, vous pouvez écrire un profil très général, qui s’abonne à un petit jeu de modifications d’état de haut niveau d’un flux de travail. Inversement, vous pouvez créer un profil très détaillé dont les événements résultants sont assez riches pour reconstruire ultérieurement un flux d'exécution détaillé.

Les modèles de suivi se présentent comme des éléments XML dans un fichier de configuration .NET Framework standard ou sont spécifiés dans le code. L’exemple suivant illustre un modèle de suivi .NET Framework 4.6.1 dans un fichier de configuration qui permet à un participant au suivi de s’abonner aux événements de flux de travail Started et Completed.

<system.serviceModel>
    ...
    <tracking>
     <profiles>
      <trackingProfile name="Sample Tracking Profile">
        <workflow activityDefinitionId="*">
          <workflowInstanceQueries>
            <workflowInstanceQuery>
              <states>
                <state name="Started"/>
                <state name="Completed"/>
              </states>
            </workflowInstanceQuery>
          </workflowInstanceQueries>
        </workflow>
      </trackingProfile>
    </profiles>
  </tracking>
    ...
</system.serviceModel>

L'exemple suivant illustre le modèle de suivi équivalent créé à l'aide du code.

TrackingProfile profile = new TrackingProfile()
{
    Name = "CustomTrackingProfile",
    Queries =
    {
        new WorkflowInstanceQuery()
        {
            // Limit workflow instance tracking records for started and
            // completed workflow states.
            States = { WorkflowInstanceStates.Started, WorkflowInstanceStates.Completed },
        }
    }
};

Les enregistrements de suivi sont filtrés en mode de visibilité à l'aide de l'attribut ImplementationVisibility dans un modèle de suivi. Une activité composite est une activité de niveau supérieur qui contient d'autres activités qui forment son implémentation. Le mode de visibilité spécifie les enregistrements de suivi émis à partir d'activités composites dans une activité de flux de travail, afin de définir si les activités qui forment l'implémentation sont suivies. Le mode de visibilité s'applique au niveau du modèle de suivi. Les requêtes dans le modèle de suivi contrôlent le filtrage des enregistrements de suivi pour chaque activité d'un flux de travail. Pour plus d’informations, consultez la section Types de requêtes de modèle de suivi de ce document.

Les deux modes de visibilité spécifiés par l'attribut implementationVisibility dans le modèle de suivi sont RootScope et All. Le mode RootScope supprime les enregistrements de suivi pour les activités qui forment l'implémentation d'une activité, dans le cas où une activité composite n'est pas la racine d'un flux de travail. Cela implique que, lorsqu'une activité implémentée à l'aide d'autres activités est ajoutée à un flux de travail et que l'attribut implementationVisibility est défini sur RootScope, seule l'activité de niveau supérieur dans cette activité composite est suivie. Si une activité est la racine du flux de travail, l'implémentation de cette activité est le flux de travail lui-même et les enregistrements de suivi sont émis pour les activités qui forment l'implémentation. Le mode All permet d'émettre tous les enregistrements de suivi pour l'activité racine et l'ensemble de ses activités composites.

Par exemple, supposez que MyActivity soit une activité composite dont l’implémentation contiendrait deux activités, Activity1 et Activity2. Lorsque cette activité serait ajoutée à un flux de travail et que le suivi serait activé avec un modèle de suivi dont l’attribut implementationVisibility serait défini sur RootScope, les enregistrements de suivi seraient émis uniquement pour MyActivity. En revanche, aucun enregistrement ne serait émis pour les activités Activity1 et Activity2.

Toutefois, si l’attribut implementationVisibility du modèle de suivi était défini sur All, les enregistrements de suivi seraient émis non seulement pour MyActivity, mais aussi pour les activités Activity1 et Activity2.

L'indicateur implementationVisibility s'applique aux types d'enregistrements de suivi suivants :

• ActivityStateRecord

• FaultPropagationRecord

• CancelRequestedRecord

• ActivityScheduledRecord

Dans le code, la fonctionnalité implementationVisibility du modèle de suivi est spécifiée comme suit : RootScope.

TrackingProfile sampleTrackingProfile = new TrackingProfile()
{
    Name = "Sample Tracking Profile",
    ImplementationVisibility = ImplementationVisibility.RootScope
};

Dans un fichier de configuration, la fonctionnalité implementationVisibility du modèle de suivi est spécifiée comme suit : All.

<tracking>
      <profiles>
        <trackingProfile name="Shipping Monitoring" implementationVisibility="All">
          <workflow activityDefinitionId="*">
...
         </workflow>
        </trackingProfile>
      </profiles>
</tracking>

Le paramètre ImplementationVisibility du modèle de suivi est facultatif. Par défaut, sa valeur est définie sur RootScope. De plus, les valeurs de cet attribut sont sensibles à la casse.

Types de requêtes de modèle de suivi

Les modèles de suivi sont structurés comme des abonnements déclaratifs aux enregistrements de suivi qui vous permettent d'interroger le runtime de flux de travail pour rechercher des enregistrements de suivi particuliers. Plusieurs types de requêtes vous permettent de vous abonner à différentes classes d'objets TrackingRecord. Les profils de suivi peuvent être spécifiés dans la configuration ou via le code. Voici les types de requêtes les plus communs :

• Objet WorkflowInstanceQuery - Permet de suivre les changements dans le cycle de vie de l'instance de flux de travail comme les événements Started et Completed montrés précédemment. L'objet WorkflowInstanceQuery sert à s'abonner aux objets TrackingRecord suivants :

  • WorkflowInstanceRecord

  • WorkflowInstanceAbortedRecord

  • WorkflowInstanceUnhandledExceptionRecord

  • WorkflowInstanceTerminatedRecord

  • WorkflowInstanceSuspendedRecord

  Les états auxquels vous pouvez vous abonner sont spécifiés dans la classe WorkflowInstanceStates.

  L'exemple suivant indique la configuration ou le code servant à s'abonner aux enregistrements de suivi de flux de travail au niveau de l'instance, pour l'état de l'instance Started, à l'aide de l'objet WorkflowInstanceQuery.

  <workflowInstanceQueries>
      <workflowInstanceQuery>
        <states>
          <state name="Started"/>
        </states>
      </workflowInstanceQuery>
  </workflowInstanceQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new WorkflowInstanceQuery()
          {
              States = { WorkflowInstanceStates.Started}
          }
      }
  };
  

• Objet ActivityStateQuery - Permet de suivre les changements dans le cycle de vie des activités qui composent une instance de workflow. Par exemple, vous pouvez effectuer le suivi du nombre de fois où l’activité Envoyer un message se termine dans une instance de flux de travail. Cette requête est nécessaire pour qu'un objet TrackingParticipant s'abonne à des objets ActivityStateRecord. Les états disponibles auxquels s'abonner sont spécifiés dans l'objet ActivityStates.

  L'exemple suivant indique la configuration et le code servant à s'abonner à des enregistrements de suivi d'état d'activité qui utilisent l'objet ActivityStateQuery pour l'activité SendEmailActivity.

  <activityStateQueries>
    <activityStateQuery activityName="SendEmailActivity">
      <states>
        <state name="Closed"/>
      </states>
    </activityStateQuery>
  </activityStateQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new ActivityStateQuery()
          {
              ActivityName = "SendEmailActivity",
              States = { ActivityStates.Closed }
          }
      }
  };
  

  Notes

  Si plusieurs éléments activityStateQuery ont le même nom, seuls les états dans le dernier élément sont utilisés dans le modèle de suivi.

• Objet ActivityScheduledQuery - Cette requête vous permet de suivre une activité devant être exécutée par une activité parente. La requête est nécessaire pour qu'un objet TrackingParticipant s'abonne à des objets ActivityScheduledRecord.

  L'exemple suivant indique la configuration et le code servant à s'abonner à des enregistrements associés à l'activité enfant SendEmailActivity en cours de planification, à l'aide de l'objet ActivityScheduledQuery.

  <activityScheduledQueries>
    <activityScheduledQuery activityName="ProcessNotificationsActivity" childActivityName="SendEmailActivity" />
  </activityScheduledQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new ActivityScheduledQuery()
          {
              ActivityName = "ProcessNotificationsActivity",
              ChildActivityName = "SendEmailActivity"
          }
      }
  };
  

• Objet FaultPropagationQuery - Permet de suivre la gestion des erreurs qui se produisent dans une activité. La requête est nécessaire pour qu'un objet TrackingParticipant s'abonne à des objets FaultPropagationRecord.

  L'exemple suivant indique la configuration et le code servant à s'abonner à des enregistrements associés à la propagation d'erreur à l'aide de l'objet FaultPropagationQuery.

  <faultPropagationQueries>
    <faultPropagationQuery faultSourceActivityName="SendEmailActivity" faultHandlerActivityName="NotificationsFaultHandler" />
  </faultPropagationQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new FaultPropagationQuery()
          {
              FaultSourceActivityName = "SendEmailActivity",
              FaultHandlerActivityName = "NotificationsFaultHandler"
          }
      }
  };
  

• Objet CancelRequestedQuery - Permet de suivre les demandes d'annulation d'une activité enfant par l'activité parente. La requête est nécessaire pour qu'un objet TrackingParticipant s'abonne à des objets CancelRequestedRecord.

  L’exemple suivant indique la configuration et le code servant à s’abonner à des enregistrements associés à l’annulation d’activité à l’aide de l’objet CancelRequestedQuery.

  <cancelRequestedQueries>
    <cancelRequestedQuery activityName="ProcessNotificationsActivity" childActivityName="SendEmailActivity" />
  </cancelRequestedQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new CancelRequestedQuery()
          {
              ActivityName = "ProcessNotificationsActivity",
              ChildActivityName = "SendEmailActivity"
          }
      }
  };
  

• Objet CustomTrackingQuery - Permet de suivre les événements que vous définissez dans vos activités de code. La requête est nécessaire pour qu'un objet TrackingParticipant s'abonne à des objets CustomTrackingRecord.

  L'exemple suivant indique la configuration et le code servant à s'abonner à des enregistrements associés aux enregistrements de suivi personnalisé à l'aide de l'objet CustomTrackingQuery.

  <customTrackingQueries>
    <customTrackingQuery name="EmailAddress" activityName="SendEmailActivity" />
  </customTrackingQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new CustomTrackingQuery()
          {
              Name = "EmailAddress",
              ActivityName = "SendEmailActivity"
          }
      }
  };
  

• Objet BookmarkResumptionQuery - Permet de suivre la reprise d'un signet dans une instance de flux de travail. Cette requête est nécessaire pour qu'un objet TrackingParticipant s'abonne à des objets BookmarkResumptionRecord.

  L'exemple suivant indique la configuration et le code servant à s'abonner à des enregistrements associés à la reprise de signet à l'aide de l'objet BookmarkResumptionQuery.

  <bookmarkResumptionQueries>
    <bookmarkResumptionQuery name="SentEmailBookmark" />
  </bookmarkResumptionQueries>
  

  TrackingProfile sampleTrackingProfile = new TrackingProfile()
  {
      Name = "Sample Tracking Profile",
      Queries =
      {
          new BookmarkResumptionQuery()
          {
              Name = "sentEmailBookmark"
          }
      }
  };
  

Annotations

Grâce aux annotations, vous pouvez baliser arbitrairement des enregistrements de suivi avec une valeur configurable après la génération. Par exemple, vous pouvez baliser plusieurs enregistrements de suivi parmi plusieurs flux de travail en utilisant “Mail Server” == “Mail Server1”. Lors de l’interrogation ultérieure d’enregistrements de suivi, cela facilite la recherche de tous les enregistrements ayant cette étiquette.

Pour ce faire, une annotation est ajoutée à une requête de suivi comme illustré dans l'exemple suivant.

<activityStateQuery activityName="SendEmailActivity">
  <states>
    <state name="Closed"/>
  </states>
  <annotations>
    <annotation name="MailServer" value="Mail Server1"/>
  </annotations>
</activityStateQuery>

Création d'un modèle de suivi

Les éléments de requête de suivi servent à créer un modèle de suivi à l’aide soit d’un fichier de configuration XML, soit du code .NET Framework 4.6.1. Voici un exemple de modèle de suivi créé à l'aide d'un fichier de configuration :

<system.serviceModel>
  <tracking>
    <profiles>
      <trackingProfile name="Sample Tracking Profile ">
        <workflow activityDefinitionId="*">
          <!--Specify the tracking profile query elements to subscribe for tracking records-->
        </workflow>
      </trackingProfile>
    </profiles>
  </tracking>
</system.serviceModel>

Un profil configuré en tant que fichier de configuration XML est appliqué à un participant au suivi à l’aide d’une extension de comportement. Il est ajouté à un objet WorkflowServiceHost comme décrit dans la section Configuration du suivi d’un workflow ci-après.

Les paramètres de configuration du modèle de suivi déterminent les commentaires des enregistrements de suivi émis par l'hôte. Un participant au suivi s'abonne à des enregistrements de suivi en ajoutant des requêtes à un modèle de suivi. Pour un abonnement à tous les enregistrements de suivi, le modèle de suivi doit spécifier toutes les requêtes de suivi à l’aide de « * » dans les champs de nom de chacune des requêtes.

Voici quelques exemples communs de profils de suivi :

• Modèle de suivi permettant d'obtenir les enregistrements et les erreurs de l'instance de flux de travail.

  <trackingProfile name="Instance and Fault Records">
    <workflow activityDefinitionId="*">
      <workflowInstanceQueries>
        <workflowInstanceQuery>
          <states>
            <state name="*" />
          </states>
        </workflowInstanceQuery>
      </workflowInstanceQueries>
      <activityStateQueries>
        <activityStateQuery activityName="*">
          <states>
            <state name="Faulted"/>
          </states>
        </activityStateQuery>
      </activityStateQueries>
    </workflow>
  </trackingProfile>
  

• Modèle de suivi permettant d'obtenir tous les enregistrements de suivi personnalisé.

  <trackingProfile name="Instance_And_Custom_Records">
    <workflow activityDefinitionId="*">
      <customTrackingQueries>
        <customTrackingQuery name="*" activityName="*" />
      </customTrackingQueries>
    </workflow>
  </trackingProfile>
  

Voir aussi

• Suivi SQL
• Surveillance de Windows Server App Fabric
• Monitoring des applications avec App Fabric