Configuration du traçage

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 des recommandations sur les paramètres de suivi dans l’environnement de production ou de débogage, reportez-vous aux paramètres recommandés pour le suivi et la journalisation des messages.

Activation du traçage

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

• Suivis pour les jalons de processus sur l'ensemble des composants des applications, tels que les appels d'opération, exceptions de code, avertissements et autres événements de traitement significatifs.

• Événements d’erreur Windows en cas de dysfonctionnement de la fonctionnalité de suivi. Consultez la Journalisation des événements

Le suivi WCF est construit sur System.Diagnostics. Pour utiliser le traçage, vous devez définir des sources de trace dans le fichier de configuration ou dans le code. WCF définit une source de trace pour chaque assemblage WCF. La source de trace System.ServiceModel est la source de trace WCF la plus générale et enregistre les jalons de traitement dans la pile de communication WCF, de l’entrée/sortie du transport à l’entrée/ sortie du 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 trace et définir un niveau de trace autre que « Désactivé » pour la source de trace sélectionnée dans la configuration ; sinon, WCF ne génère aucune trace. 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.

Si vous utilisez des points d’extensibilité WCF tels que des appelants d’opérations personnalisées, vous devez émettre vos propres traces. En effet, si vous implémentez un point d’extensibilité, WCF n’est plus en mesure d’émettre les suivis standard dans le chemin d’accès par défaut. Si vous n'implémentez par la prise en charge du suivi manuel à l'aide de l'émission de suivis, les suivis peuvent ne pas s'afficher comme prévu.

Vous pouvez configurer le suivi en modifiant le 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. Vous trouverez ci-dessous un exemple de ce type de modification : Pour plus d'informations sur ces paramètres, consultez la section « Configuration d'écouteurs de suivi pour lire les suivis ».

<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>  

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

WCF définit une source de suivi pour chaque assemblage . 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 : journalise toutes les étapes du traitement WCF, chaque fois que la configuration est lue, un message est traité dans le transport, le traitement de sécurité, un message est distribué dans le code utilisateur, et ainsi de suite.

• 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 Extension du suivi.

Configuration d'écouteurs de suivi pour consommer des suivis

Au moment de 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 dans le 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éer un TraceListener personnalisé.

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.

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.

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 Propagation.

Les deux valeurs booléennes propagateActivity etActivityTracing s'appliquent à System.ServiceModel TraceSource. La valeur ActivityTracing s’applique également à toute source de trace, y compris WCF ou définie 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

• Suivi
• Administration et diagnostics
• Procédure : Créer et initialiser les écouteurs de trace
• Création d'un TraceListener personnalisé