Configuration du suivi

Cette rubrique décrit comment activer le suivi, configurer des sources de suivi pour émettre des suivis et définir des niveaux de suivi, définir le suivi et la propagation d'activité afin de prendre en charge la corrélation de suivi de bout en bout, et définir des écouteurs de suivi pour accéder aux suivis.

Pour obtenir les recommandations relatives aux paramètres de suivi dans un environnement de production ou de débogage, consultez Paramètres recommandés pour le suivi et l'enregistrement des messages.

Activation du suivi

Windows Communication Foundation (WCF) génère les données suivantes pour le suivi de diagnostic :

• Suivis des jalons de processus dans l'ensemble des composants des applications, tels que les appels d'opération, les exceptions de code, les avertissements et d'autres événements de traitement significatifs.
• Événements d'erreur Windows en cas de dysfonctionnement de la fonctionnalité de suivi. Consultez Journalisation des événements.

Le suivi WCF est construit sur System.Diagnostics. Pour utiliser le suivi, vous devez définir des sources de suivi dans le fichier de configuration ou dans le code. WCF définit une source de suivi par chaque assembly WCF. La source de suivi System.ServiceModel est la source de suivi WCF la plus générale ; elle enregistre des jalons de traitement dans la pile de communication WCF, de l'entrée/sortie de transport à l'entrée/sortie de code utilisateur. La source de suivi System.ServiceModel.MessageLogging enregistre tous les messages qui circulent dans le système.

Le suivi est désactivé par défaut. Pour activer le suivi, vous devez créer un écouteur de suivi et définir un niveau de suivi autre que « Désactivé » pour la source de suivi sélectionnée dans la configuration ; autrement, WCF ne génère pas de suivi. Si vous ne spécifiez pas d'écouteur, le suivi est automatiquement désactivé. Si un écouteur est défini mais qu'aucun niveau n'est spécifié, le niveau a la valeur « Désactivé » par défaut, ce qui signifie qu'aucun suivi n'est émis.

Vous pouvez configurer le suivi à l'aide du fichier de configuration de l'application : Web.config pour les applications hébergées sur le Web, ou Appname.exe.config pour les applications auto-hébergées. Voici un exemple.

<configuration>
   <system.diagnostics>
      <sources>
            <source name="System.ServiceModel" 
                    switchValue="Information, ActivityTracing"
                    propagateActivity="true">
            <listeners>
               <add name="traceListener" 
                   type="System.Diagnostics.XmlWriterTraceListener" 
                   initializeData= "c:\log\Traces.svclog" />
            </listeners>
         </source>
      </sources>
   </system.diagnostics>
</configuration>

Remarque :

Pour modifier le fichier de configuration d'un projet de service WCF dans Visual Studio, cliquez dessus avec le bouton droit dans l'Explorateur de solutions et choisissez l'élément de menu contextuel Modifier la configuration WCF. Cela lance Configuration Editor Tool (SvcConfigEditor.exe), qui vous permet de modifier les paramètres de configuration des services WCF à l'aide d'une interface utilisateur graphique.

Configuration de sources de suivi de façon à émettre des suivis

WCF définit une source de suivi pour chaque assembly. Les écouteurs définis pour cette source accèdent aux suivis générés dans un assembly. Les sources de suivi suivantes sont définies :

• System.ServiceModel : enregistre toutes les phases de traitement WCF, chaque lecture de la configuration, chaque message traité dans le transport, le traitement de sécurité, chaque envoi d'un message dans le code utilisateur, etc.
• System.ServiceModel.MessageLogging : enregistre tous les messages qui circulent dans le système.
• System.IdentityModel.
• System.ServiceModel.Activation.
• System.IO.Log : enregistrement pour l'interface .NET Framework dans le système CLFS (Common Log File System).
• System.Runtime.Serialization : enregistre la lecture ou l'écriture des objets.
• CardSpace.

Vous pouvez configurer chaque source de suivi de façon à utiliser le même écouteur (partagé), comme indiqué dans l'exemple de configuration suivant :

<configuration>
    <system.diagnostics>
        <sources>
            <source name="System.ServiceModel" 
                    switchValue="Information, ActivityTracing"
                    propagateActivity="true">
                <listeners>
                    <add name="xml" />
                </listeners>
            </source>
            <source name="CardSpace">
                <listeners>
                    <add name="xml" />
                </listeners>
            </source>
            <source name="System.IO.Log">
                <listeners>
                    <add name="xml" />
                </listeners>
            </source>
            <source name="System.Runtime.Serialization">
                <listeners>
                    <add name="xml" />
                </listeners>
            </source>
            <source name="System.IdentityModel">
                <listeners>
                    <add name="xml" />
                </listeners>
            </source>
        </sources>

        <sharedListeners>
            <add name="xml"
                 type="System.Diagnostics.XmlWriterTraceListener"
                 initializeData="c:\log\Traces.svclog" />
        </sharedListeners>
    </system.diagnostics>
</configuration>

De plus, vous pouvez ajouter des sources de suivi définies par l'utilisateur, comme illustré par l'exemple suivant, de façon à émettre des suivis de code utilisateur :

<system.diagnostics>
   <sources>
       <source name="UserTraceSource" switchValue="Warning, ActivityTracing" >
          <listeners>
              <add name="xml"
                 type="System.Diagnostics.XmlWriterTraceListener"
                 initializeData="C:\logs\UserTraces.svclog" />
          </listeners>
       </source>
   </sources>
   <trace autoflush="true" /> 
</system.diagnostics>

Pour plus d'informations sur la création de sources de suivi définies par l'utilisateur, consultez Extending Tracing.

Configuration d'écouteurs de suivi pour consommer des suivis

Pendant l'exécution, WCF fournit des données de suivi aux écouteurs qui traitent les données. WCF fournit plusieurs écouteurs prédéfinis pour System.Diagnostics, qui diffèrent quant au format utilisé pour la sortie. Vous pouvez également ajouter des types d'écouteurs personnalisés.

Vous pouvez utiliser add pour indiquer les nom et type de l'écouteur de suivi à utiliser. Dans notre exemple de configuration, nous avons nommé l'écouteur traceListener et ajouté l'écouteur de suivi standard .NET Framework (System.Diagnostics.XmlWriterTraceListener) comme type à utiliser. Vous pouvez ajouter un nombre quelconque d'écouteurs de suivi pour chaque source. Si l'écouteur de suivi émet le suivi dans un fichier, vous devez spécifier le nom et l'emplacement du fichier de sortie dans le fichier de configuration. Pour cela, vous devez affecter à initializeData le nom du fichier pour cet écouteur. Si vous ne spécifiez pas de nom de fichier, un nom de fichier aléatoire est généré en fonction du type d'écouteur utilisé. Si XmlWriterTraceListener est utilisé, un nom de fichier sans extension est généré. Si vous implémentez un écouteur personnalisé, vous pouvez également utiliser cet attribut pour recevoir des données d'initialisation autres qu'un nom de fichier. Par exemple, vous pouvez spécifier un identificateur de base de données pour cet attribut.

Vous pouvez configurer un écouteur de suivi personnalisé pour envoyer des suivis sur le câble, par exemple à une base de données distante. En tant que responsable du déploiement d'applications, vous devez appliquer un contrôle d'accès approprié sur les journaux de suivi sur l'ordinateur distant.

Vous pouvez également configurer un écouteur de suivi par programmation. Pour plus d'informations, consultez Comment : créer et initialiser des écouteurs de suivi et Création d'un TraceListener personnalisé (pages pouvant être en anglais)

Attention :

System.Diagnostics.XmlWriterTraceListener n'étant pas thread-safe, la source de suivi peut verrouiller des ressources exclusivement lors de la sortie de suivis. Lorsque de nombreux threads sortent des suivis vers une source de suivi configurée pour utiliser cet écouteur, un conflit de ressource peut se produire, provoquant une dégradation significative des performances. Pour résoudre ce problème, vous devez implémenter un écouteur personnalisé thread-safe.

Niveau de suivi

Le niveau de suivi est contrôlé par le paramètre switchValue de la source de suivi. Les niveaux de suivi disponibles sont décrits dans le tableau suivant.

Les niveaux compris entre Verbose et Critique sont empilés les uns sur les autres, autrement dit chaque niveau de suivi inclut tous les niveaux supérieurs hormis le niveau Désactivé. Par exemple, un écouteur qui écoute au niveau Avertissement reçoit les suivis des niveaux Critique, Erreur et Avertissement. Le niveau Tout inclut les événements du niveau Verbose au niveau Critique et les événements ActivityTracing.

Attention :
Les niveaux Informations, Commentaires et ActivityTracing génèrent de nombreux suivis, ce qui peut avoir un impact négatif sur le débit des messages si vous avez utilisé toutes les ressources disponibles sur l'ordinateur.

Configuration du suivi d'activité et de la propagation pour la corrélation

La valeur activityTracing spécifiée pour l'attribut switchValue est utilisée pour activer le suivi d'activité, qui émet des suivis pour les transferts et limites d'activité dans les points de terminaison.

Remarque :
Lorsque vous utilisez certaines fonctionnalités d'extensibilité dans WCF, vous pouvez obtenir un NullReferenceException lorsque le suivi d'activité est activé. Pour résoudre ce problème, vérifiez le fichier de configuration de votre application et assurez-vous que l'attribut switchValue de votre source de suivi n'a pas la valeur activityTracing.

L'attribut propagateActivity indique si l'activité doit être propagée vers d'autres points de terminaison qui participent à l'échange de messages. En affectant à cet attribut la valeur true, vous pouvez prendre des fichiers de suivi générés par deux points de terminaison quelconque et observer comment un ensemble de suivis sur un point de terminaison a été transféré vers un ensemble de suivis sur un autre point de terminaison.

Pour plus d'informations sur le suivi et la propagation des activités, consultez Suivi et propagation d'activité pour la corrélation de suivi de bout en bout.

Les valeurs Boolean propagateActivity et ActivityTracing s'appliquent au System.ServiceModel TraceSource. La ActivityTracing valeur s'applique également à toute source de suivi, y compris les sources WCF ou définies par l'utilisateur.

Vous ne pouvez pas utiliser l'attribut propagateActivity avec des sources de suivi définies par l'utilisateur. Pour la propagation d'ID d'activité de code utilisateur, assurez-vous de ne pas définir ServiceModel ActivityTracing, tout en ayant encore l'attribut propagateActivity ServiceModel défini à true.

Voir aussi

Concepts

Administration et diagnostics

Autres ressources

Suivi
Comment : créer et initialiser des écouteurs de suivi
Création d'un TraceListener personnalisé