Comment : utiliser des TraceSource et des filtres avec des écouteurs de la trace

Article
08/21/2008

Mise à jour : novembre 2007

L'une des nouveautés du .NET Framework version 2.0 est un système de traçage amélioré. Le principe de base reste inchangé : les messages de traçage sont envoyés par l'intermédiaire de commutateurs aux écouteurs qui transmettent les données à un support de sortie associé. L'une des principales différences de la version 2.0 réside dans le fait qu'il est possible d'initialiser les traces par l'intermédiaire d'instances de la classe TraceSource. TraceSource a été conçue pour fonctionner comme un système de traçage amélioré et peut être utilisée à la place des méthodes statiques des anciennes classes de traçage Trace et Debug. Les classes Trace et Debug existent encore mais l'utilisation de la classe TraceSource est désormais la méthode recommandée pour le traçage.

Cette rubrique décrit l'utilisation de la classe TraceSource associée à un fichier de configuration de l'application. Il est déconseillé mais néanmoins possible d'effectuer le traçage à l'aide de TraceSource sans utiliser de fichier de configuration. Pour plus d'informations sur le traçage sans fichier de configuration, consultez Comment : créer et initialiser les sources de trace.

Pour créer et initialiser votre source de trace

Pour instrumenter une application avec le traçage, la première étape consiste à créer une source de trace. Dans les projets importants intégrant divers composants, vous pouvez créer une source de trace séparée pour chaque composant. La méthode conseillée consiste à utiliser le nom de l'application comme nom de la source de trace. Cela permet de distinguer plus facilement les différentes traces. Le code suivant crée une nouvelle source de trace (mySource) et appelle une méthode (Activity1) qui trace des événements. Les messages de trace sont écrits par l'écouteur de la trace par défaut.
```
using System;
using System.Diagnostics;
using System.Threading;

namespace TraceSourceApp
{
    class Program
    {
        private static TraceSource mySource = 
            new TraceSource("TraceSourceApp");
        static void Main(string[] args)
        {
            Activity1();
            mySource.Close();
            return;
        }
        static void Activity1()
        {
            mySource.TraceEvent(TraceEventType.Error, 1, 
                "Error message.");
            mySource.TraceEvent(TraceEventType.Warning, 2, 
                "Warning message.");
        }
    }
}
```

Pour créer et initialiser des filtres et des écouteurs de la trace

Le code de la première procédure n'identifie aucun filtre ou écouteur de la trace par programme. Le code permet uniquement d'écrire les messages de trace dans l'écouteur de la trace par défaut. Pour configurer des écouteurs de traces spécifiques et leurs filtres respectifs, modifiez le fichier de configuration correspondant au nom de votre application. Dans ce fichier, vous pouvez ajouter ou supprimer un écouteur, définir les propriétés et un filtre pour un écouteur ou supprimer des écouteurs. L'exemple de fichier de configuration suivant montre comment initialiser un écouteur de la trace de console et un écouteur de la trace du writer de texte pour la source de la trace créée dans la procédure précédente. En plus de configurer les écouteurs de la trace, le fichier de configuration crée des filtres pour les deux écouteurs ainsi qu'un commutateur source pour la source de trace. L'exemple illustre deux techniques pour ajouter des écouteurs de la trace : l'ajout direct de l'écouteur à la source de trace et l'ajout d'un écouteur à la collection d'écouteurs partagés suivi de l'ajout de son nom à la source de trace. Les filtres identifiés pour les deux écouteurs sont initialisés avec des niveaux de source différents. Par conséquent, certains messages ne sont écrits que par un seul des deux écouteurs.
```
<configuration>
  <system.diagnostics>
    <sources>
      <source name="TraceSourceApp" 
        switchName="sourceSwitch" 
        switchType="System.Diagnostics.SourceSwitch">
        <listeners>
          <add name="console" 
            type="System.Diagnostics.ConsoleTraceListener">
            <filter type="System.Diagnostics.EventTypeFilter" 
              initializeData="Warning"/>
          </add>
          <add name="myListener"/>
          <remove name="Default"/>
        </listeners>
      </source>
    </sources>
    <switches>
      <add name="sourceSwitch" value="Warning"/>
    </switches>
    <sharedListeners>
      <add name="myListener" 
        type="System.Diagnostics.TextWriterTraceListener" 
        initializeData="myListener.log">
        <filter type="System.Diagnostics.EventTypeFilter" 
          initializeData="Error"/>
      </add>
    </sharedListeners>
  </system.diagnostics>
</configuration>
```

Pour modifier le niveau auquel un écouteur écrit un message de trace

Le fichier de configuration initialise les paramètres de la source de trace lors de l'initialisation de l'application. Pour modifier ces paramètres, vous devez modifier le fichier de configuration et redémarrer l'application ou actualiser l'application par programme à l'aide de la méthode Trace.Refresh. L'application peut modifier dynamiquement les propriétés définies par le fichier de configuration pour substituer des paramètres spécifiés par l'utilisateur. Vous pouvez, par exemple, décider que les messages critiques seront toujours envoyés à un fichier texte, quels que soient les paramètres de configuration actuels.

using System;
using System.Diagnostics;
using System.Threading;

namespace TraceSourceApp
{
    class Program
    {
        private static TraceSource mySource = 
            new TraceSource("TraceSourceApp");
        static void Main(string[] args)
        {
            Activity1();

            // Change the event type for which tracing occurs.
            // The console trace listener must be specified 
            // in the configuration file. First, save the original
            // settings from the configuration file.
            EventTypeFilter configFilter = 
                (EventTypeFilter)mySource.Listeners["console"].Filter;

            // Then create a new event type filter that ensures 
            // critical messages will be written.
            mySource.Listeners["console"].Filter =
                new EventTypeFilter(SourceLevels.Critical);
            Activity2();

            // Allow the trace source to send messages to listeners 
            // for all event types. This statement will override 
            // any settings in the configuration file.
            mySource.Switch.Level = SourceLevels.All;

            // Restore the original filter settings.
            mySource.Listeners["console"].Filter = configFilter;
            Activity3();
            mySource.Close();
            return;
        }
        static void Activity1()
        {
            mySource.TraceEvent(TraceEventType.Error, 1, 
                "Error message.");
            mySource.TraceEvent(TraceEventType.Warning, 2, 
                "Warning message.");
        }
        static void Activity2()
        {
            mySource.TraceEvent(TraceEventType.Critical, 3, 
                "Critical message.");
            mySource.TraceInformation("Informational message.");
        }
        static void Activity3()
        {
            mySource.TraceEvent(TraceEventType.Error, 4, 
                "Error message.");
            mySource.TraceInformation("Informational message.");
        }
    }
}

Voir aussi

Partager via

Comment : utiliser des TraceSource et des filtres avec des écouteurs de la trace

Pour créer et initialiser votre source de trace

Pour créer et initialiser des filtres et des écouteurs de la trace

Pour modifier le niveau auquel un écouteur écrit un message de trace

Voir aussi

Tâches

Concepts

Référence

Ressources supplémentaires