Partager via

Écouteurs de trace

Remarque

Cet article est spécifique à .NET Framework. Elle ne s’applique pas aux implémentations plus récentes de .NET, notamment .NET 6 et versions ultérieures.

Lorsque vous utilisez Trace, Debug et TraceSource, vous devez disposer d’un mécanisme permettant de collecter et d’enregistrer les messages envoyés. Les messages de trace sont reçus par les écouteurs. L’objectif d’un écouteur est de collecter, stocker et router les messages de suivi. Les écouteurs dirigent la sortie de suivi vers une cible appropriée, telle qu'un journal, une fenêtre ou un fichier de texte.

Les écouteurs sont disponibles pour les classes Debug, Trace et TraceSource, et chacune d’elles peut envoyer sa sortie à de nombreux objets écouteur. Voici les écouteurs prédéfinis couramment utilisés :

  • TextWriterTraceListener redirige la sortie vers une instance de la classe TextWriter ou vers toute classe Stream. Il peut également écrire dans la console ou dans un fichier, car ce sont des classes Stream.

  • Un EventLogTraceListener redirige la sortie vers un journal des événements.

  • Un DefaultTraceListener émet des messages Write et WriteLine dans OutputDebugString et dans la méthode Debugger.Log. Cela entraîne l'affichage des messages de débogage dans la fenêtre de sortie de Visual Studio. Les messages d'échec et de l'assertion échouée sont également émis à l'API Windows OutputDebugString et à la méthode Debugger.Log, et provoquent aussi l'affichage d'une boîte de message. Ce comportement est le comportement par défaut pour les messages Debug et Trace , car DefaultTraceListener est automatiquement inclus dans chaque Listeners collection et est le seul écouteur automatiquement inclus.

  • Un ConsoleTraceListener dirige la sortie de traçage ou de débogage vers la sortie standard ou le flux d’erreur standard.

  • Un DelimitedListTraceListener dirige la sortie de suivi ou de débogage vers un rédacteur de texte, tel qu'un rédacteur de flux, ou vers un flux, tel qu'un flux de fichiers. La sortie de trace se trouve dans un format de texte délimité qui utilise le délimiteur spécifié par la Delimiter propriété.

  • Un XmlWriterTraceListener dirige la sortie du suivi ou du débogage en tant que données encodées en XML vers un TextWriter ou vers un Stream, tel qu'un FileStream.

Si vous souhaitez que d'autres écouteurs en plus de DefaultTraceListener reçoivent la sortie Debug, Trace et TraceSource, vous devez l'ajouter à la collection Listeners. Pour plus d’informations, consultez Comment créer et initialiser des écouteurs de trace et Comment utiliser TraceSource et des filtres avec des écouteurs de trace. Tout écouteur dans la collection Écouteurs reçoit les mêmes messages des méthodes de sortie de trace. Par exemple, supposons que vous configurez deux écouteurs : un TextWriterTraceListener et un EventLogTraceListener. Chaque écouteur reçoit le même message. TextWriterTraceListener dirigerait sa sortie vers un flux, et EventLogTraceListener dirigerait sa sortie vers un journal des événements.

L’exemple suivant montre comment envoyer la sortie à la collection Listeners .

' Use this example when debugging.
Debug.WriteLine("Error in Widget 42")
' Use this example when tracing.
Trace.WriteLine("Error in Widget 42")

// Use this example when debugging.
System.Diagnostics.Debug.WriteLine("Error in Widget 42");
// Use this example when tracing.
System.Diagnostics.Trace.WriteLine("Error in Widget 42");

Debug et Trace partagent la même collection de Listeners, ainsi si vous ajoutez un objet d’écouteur à une collection Debug.Listeners dans votre application, il est également ajouté à la collection Trace.Listeners.

L’exemple suivant montre comment utiliser un écouteur pour envoyer des informations de suivi à une console :

Trace.Listeners.Clear()
Trace.Listeners.Add(New TextWriterTraceListener(Console.Out))

System.Diagnostics.Trace.Listeners.Clear();
System.Diagnostics.Trace.Listeners.Add(
   new System.Diagnostics.TextWriterTraceListener(Console.Out));

Écouteurs définis par le développeur

Vous pouvez définir vos propres écouteurs en héritent de la classe de base TraceListener et en substituant ses méthodes à vos méthodes personnalisées. Pour plus d'informations sur la création d'écouteurs définis par le développeur, voir TraceListener dans la documentation .NET Framework.

Voir aussi

  • Last updated on