Participants de suivi
Les participants de traçage sont des points d'extensibilité qui permettent à un développeur de workflow d'accéder aux objets TrackingRecord et de les traiter. .NET Framework 4.6.1 inclut un participant de suivi standard qui écrit des enregistrements de suivi comme événements de suivi des événements ETW (Event Tracing for Windows). Si cela ne répond pas à vos besoins, vous pouvez également écrire un participant de suivi personnalisé.
Participants de suivi
L'infrastructure de suivi permet l'application d'un filtre sur les enregistrements de suivi sortants pour permettre à un participant de s'abonner à un sous-ensemble des enregistrements. L'application d'un filtre s'effectue par l'intermédiaire d'un modèle de suivi.
Windows Workflow Foundation (WF) fournit dans .NET Framework 4.6.1 un participant de suivi qui écrit les enregistrements de suivi dans une session ETW. Le participant est configuré sur un service de flux de travail en ajoutant un comportement spécifique au suivi dans un fichier de configuration. L'activation d'un participant au suivi ETW permet d'afficher les enregistrements de suivi dans l'Observateur d'événements. L'exemple du Kit de développement logiciel pour le suivi ETW constitue un bon moyen de se familiariser avec le suivi WF à l'aide du participant de suivi ETW.
Participant de suivi ETW
.NET Framework 4.6.1 inclut un participant de suivi ETW qui écrit les enregistrements de suivi dans une session ETW. Cette opération est effectuée de façon très efficace avec un impact minimal sur les performances de l'application ou sur le débit du serveur. L'un des avantages de l'utilisation du participant de suivi ETW standard est que les enregistrements de suivi qu'il reçoit peuvent être affichés avec l'autre application et les journaux système dans l'observateur d'événements Windows.
Le participant de suivi ETW standard est configuré dans le fichier Web.config comme indiqué dans l'exemple suivant.
<configuration>
<system.web>
<compilation debug="true" targetFramework="4.0" />
</system.web>
<system.serviceModel>
<behaviors>
<serviceBehaviors>
<behavior>
<etwTracking profileName="Sample Tracking Profile"/>
</behavior>
</serviceBehaviors>
</behaviors>
<tracking>
<profiles>
<trackingProfile name="Sample Tracking Profile">
….
</trackingProfile>
</profiles>
</tracking>
</system.serviceModel>
</configuration>
Notes
Si aucun nom trackingProfile n’est spécifié (par exemple seulement <etwTracking/> ou <etwTracking profileName=""/>), le profil utilisé est le profil de suivi par défaut installé avec .NET Framework 4.6.1 dans le fichier Machine.config.
Dans le fichier Machine.config, le modèle de suivi par défaut s'abonne aux enregistrements et aux erreurs de l'instance de workflow.
Dans ETW, les événements sont écrits dans la session ETW via un ID de fournisseur. L'ID de fournisseur que le participant de suivi ETW utilise pour écrire les enregistrements de suivi dans ETW est défini dans la section de diagnostic du fichier Web.config (sous <system.serviceModel><diagnostics>). Par défaut, le participant de suivi ETW utilise un ID de fournisseur par défaut si aucun ID n'a pas été spécifié, comme le montre l'exemple suivant.
<system.serviceModel>
<diagnostics etwProviderId="52A3165D-4AD9-405C-B1E8-7D9A257EAC9F" />
L'illustration suivante montre le flux des données de suivi via le participant de suivi ETW. Une fois que les données de suivi ont atteint la session ETW, il est possible d'y accéder de plusieurs façons. L'observateur d'événements, un outil Windows courant utilisé pour l'affichage des journaux et des suivis provenant d'applications et de services constitue l'un des moyens les plus pratiques pour accéder à ces événements.
Données d'événement des participants de suivi
Un participant de suivi sérialise les données d'événement ayant fait l'objet d'un suivi dans une session ETW sous la forme d'un événement par enregistrement de suivi. Un événement est identifié à l'aide d'un ID compris entre 100 et 199. Pour connaître la définition des enregistrements d’événement de suivi émis par un participant de suivi, consultez la rubrique Référence des événements de suivi.
La taille d'un événement ETW est limitée par la taille de la mémoire tampon ETW, ou par la charge utile maximale pour un événement ETW, selon la valeur la plus petite. Si la taille de l'événement dépasse l'une ou l'autre de ces limites ETW, l'événement est tronqué et son contenu supprimé de façon arbitraire. Les variables, arguments, annotations et données personnalisées ne sont pas supprimés de manière sélective. Dans le cas de troncation, tous ces éléments sont tronqués indépendamment de la valeur à l'origine du dépassement de la limite ETW. Les données supprimées sont remplacées par <item>..<item>.
Les types complexes dans les variables, les arguments et les éléments de données personnalisés sont sérialisés dans l’enregistrement d’événement ETW à l’aide de la classe NetDataContractSerializer. Cette classe inclut les informations de type CLR dans le flux XML sérialisé.
La troncation des données de charge utile en raison de limites ETW peut provoquer l'envoi d'enregistrements de suivi en double à une session ETW. Cela peut se produire si plusieurs sessions écoutent les événements et si ces sessions ont des limites de charge utile différentes pour les événements.
Pour la session dont la limite est la plus basse, l’événement peut être tronqué. Le participant de suivi ETW ne connaît pas le nombre de sessions qui écoutent les événements ; si un événement est tronqué pour une session, le participant ETW essaie à nouveau d'envoyer l'événement. Dans ce cas, la session configurée pour accepter une charge utile plus importante recevra l'événement deux fois (l'événement non tronqué et l'événement tronqué). La duplication peut être évitée en configurant toutes les sessions ETW avec les mêmes limites de taille de mémoire tampon.
Accès aux données de suivi d'un participant ETW dans l'observateur d'événements
Les événements écrits dans une session ETW par le participant de suivi ETW sont accessibles par le biais de l'observateur d'événements (lors de l'utilisation de l'ID de fournisseur par défaut). Cela permet d'afficher rapidement les enregistrements de suivi émis par le workflow.
Notes
Les événements d'enregistrement de suivi émis vers une session ETW utilisent des ID d'événement compris entre 100 et 199.
Pour activer l'affichage des enregistrements de suivi dans l'observateur d'événements
Démarrez l'observateur d'événements (EVENTVWR.EXE).
Sélectionnez Observateur d’événements, Journaux des applications et des services, Microsoft, Windows, Serveur d’applications-Applications.
Cliquez avec le bouton droit et vérifiez que le bouton Affichage, Afficher les journaux d’analyse et de débogage est sélectionné. Si tel n'est pas le cas, activez cette case à cocher de façon à ce que la coche apparaisse en regard de celle-ci. Les journaux Analyse, Performance et Débogage sont ainsi affichés.
Cliquez avec le bouton droit sur Analyse, puis sélectionnez Activer le journal. Le journal existera dans le fichier %SystemRoot%\System32\Winevt\Logs\Microsoft-Windows-Application Server-Applications%4Analytic.etl.
Participant de suivi personnalisé
L’API de participant de suivi permet l’extension de l’exécution du suivi avec un participant de suivi fourni par l’utilisateur, qui peut inclure une logique personnalisée permettant de gérer les enregistrements de suivi émis par l’exécution du workflow. Pour écrire un participant de suivi personnalisé, le développeur doit implémenter la méthode Track sur la classe TrackingParticipant. Cette méthode est appelée lorsqu'un enregistrement de suivi est émis par l'exécution du workflow.
Les participants de suivi dérivent de la classe TrackingParticipant. Le EtwTrackingParticipant fourni par le système émet un événement de suivi des événements pour Windows pour chaque enregistrement de suivi reçu. Pour créer un participant de suivi personnalisé, une classe qui dérive de TrackingParticipant est créée. Pour fournir les fonctionnalités de suivi de base, remplacez Track. Track est appelé lorsqu’un enregistrement de suivi envoyé par l’exécution peut être traité de la manière souhaitée. Dans l'exemple suivant, une classe de participant de suivi personnalisé émettant tous les enregistrements de suivi vers la fenêtre de console est définie. Vous pouvez également implémenter un objet TrackingParticipant qui traite les enregistrements de suivi de façon asynchrone à l'aide de ses méthodes BeginTrack et EndTrack.
class ConsoleTrackingParticipant : TrackingParticipant
{
protected override void Track(TrackingRecord record, TimeSpan timeout)
{
if (record != null)
{
Console.WriteLine("=================================");
Console.WriteLine(record);
}
}
}
Pour utiliser un participant de suivi particulier, enregistrez-le avec l'instance de workflow que vous souhaitez suivre, comme indiqué dans l'exemple suivant.
myInstance.Extensions.Add(new ConsoleTrackingParticipant());
Dans l'exemple suivant, un workflow consistant en une activité Sequence qui contient une activité WriteLine est créé. ConsoleTrackingParticipant est ajouté aux extensions et le workflow est appelé.
Activity activity= new Sequence()
{
Activities =
{
new WriteLine()
{
Text = "Hello World."
}
}
};
WorkflowApplication instance = new WorkflowApplication(activity);
instance.Extensions.Add(new ConsoleTrackingParticipant());
instance.Completed = delegate(WorkflowApplicationCompletedEventArgs e)
{
Console.WriteLine("workflow instance completed, Id = " + instance.Id);
resetEvent.Set();
};
instance.Run();
Console.ReadLine();
