Vorgehensweise: Verwenden von TraceSource und Filtern für Ablaufverfolgungslistener

  • Artikel

Eine der neuen Funktionen in .NET Framework, Version 2.0, ist ein verbessertes Ablaufverfolgungssystem. Die Grundlage bleibt unverändert: Ablaufverfolgungsmeldungen werden mithilfe von Schaltern an Listener gesendet, die die Daten an das jeweilige zugeordnete Ausgabemedium weiterleiten. Ein wichtiger Unterschied in Version 2.0 ist, dass die Ablaufverfolgung mithilfe von Instanzen der TraceSource-Klasse eingeleitet werden kann. TraceSource ist als verbessertes System zur Ablaufverfolgung vorgesehen; die Klasse kann statt den statischen Methoden der älteren Trace-Klasse und der Debug-Klasse verwendet werden. Die vertrauten Trace- und Debug-Klassen sind immer noch vorhanden, es wird jetzt jedoch empfohlen, die TraceSource-Klasse für die Ablaufverfolgung zu verwenden.

In diesem Thema wird die Verwendung von TraceSource zusammen mit einer Anwendungskonfigurationsdatei erläutert. Es ist möglich, die Ablaufverfolgung unter Verwendung von TraceSource ohne Konfigurationsdatei durchzuführen. Dies wird jedoch nicht empfohlen. Weitere Informationen über die Ablaufverfolgung ohne Konfigurationsdatei finden Sie unter How to: Create and Initialize Trace Sources (Vorgehensweise: Erstellen und Initialisieren von Ablaufverfolgungsquellen).

Erstellen und Initialisieren von Ablaufverfolgungsquellen

  1. Der erste Schritt beim Instrumentieren einer Anwendung mit der Ablaufverfolgung ist das Erstellen einer Ablaufverfolgungsquelle. In umfangreichen Projekten mit verschiedenen Komponenten können Sie für jede Komponente eine separate Ablaufverfolgungsquelle erstellen. Es empfiehlt sich, den Anwendungsnamen als Namen der Ablaufverfolgungsquelle zu verwenden. Dies erleichtert es, die unterschiedlichen Ablaufverfolgungen auseinander zu halten. Im folgenden Codebeispiel wird eine neue Ablaufverfolgungsquelle (mySource)) erstellt und eine Methode (Activity1) aufgerufen, die Ereignisse aufzeichnet. Die Ablaufverfolgungsmeldungen werden vom standardmäßigen Ablaufverfolgungslistener geschrieben.

    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.");  
        }  
    }  
}

Erstellen und Initialisieren von Ablaufverfolgungslistenern und Filtern

  1. Im Code in der ersten Prozedur werden weder Ablaufverfolgungslistener noch Filter angegeben. Die Ablaufverfolgungsmeldungen werden allein durch den Code in den standardmäßigen Ablaufverfolgungslistener geschrieben. Um bestimmte Ablaufverfolgungslistener und zugeordnete Filter anzugeben, bearbeiten Sie die Konfigurationsdatei, die dem Namen der Anwendung entspricht. In dieser Datei können Sie Listener hinzufügen und entfernen sowie die Eigenschaften und Filter für einen Listener festlegen. In der folgenden Beispielkonfigurationsdatei wird veranschaulicht, wie ein Konsolen- und ein Textwriter-Ablaufverfolgungslistener für die Ablaufverfolgungsquelle initialisiert werden, die in der vorausgegangenen Prozedur erstellt wurde. Neben der Konfiguration für die Ablaufverfolgungslistener werden in der Konfigurationsdatei Filter für beide Listener sowie ein Quellenschalter für die Ablaufverfolgungsquelle erstellt. Es werden zwei Verfahren zum Hinzufügen der Ablaufverfolgungslistener gezeigt: das direkte Hinzufügen des listeners zur Ablaufverfolgungsquelle sowie das Hinzufügen eines Listeners zur gemeinsam genutzten Auflistung der Listener und das anschließende Hinzufügen zur Ablaufverfolgungsquelle nach Namen. Die für die beiden Listener angegebenen Filter werden mit unterschiedlichen Stufen für die Quelle initialisiert. Dies führt dazu, dass einige Meldungen nur von einem der beiden Listener geschrieben werden.

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

Ändern der Ebene, bei der ein Listener eine Ablaufverfolgungsmeldung schreibt

  1. Die Konfigurationsdatei initialisiert die Einstellungen für die Ablaufverfolgungsquelle, wenn die Anwendung initialisiert wird. Um diese Einstellungen zu ändern, müssen Sie entweder die Konfigurationsdatei ändern und die Anwendung neu starten oder die Anwendung programmgesteuert aktualisieren, indem Sie die Trace.Refresh-Methode verwenden. Die Anwendung kann die durch die Konfigurationsdatei festgelegten Eigenschaften dynamisch ändern, um die vom Benutzer angegebenen Einstellungen zu überschreiben. So können Sie beispielsweise sicherstellen, dass Meldungen für kritische Fehler unabhängig von den aktuellen Konfigurationseinstellungen immer in eine Textdatei geschrieben werden.

    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.");  
        }  
    }  
}

Siehe auch