EventSchemaTraceListener Klasse

Definition

public ref class EventSchemaTraceListener : System::Diagnostics::TextWriterTraceListener

public class EventSchemaTraceListener : System.Diagnostics.TextWriterTraceListener

type EventSchemaTraceListener = class
    inherit TextWriterTraceListener

Public Class EventSchemaTraceListener
Inherits TextWriterTraceListener

Vererbung

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

EventSchemaTraceListener

Beispiele

Im folgenden Codebeispiel wird die Verwendung der EventSchemaTraceListener Klasse veranschaulicht.

#define NOCONFIGFILE
using System;
using System.IO;
using System.Xml;
using System.Xml.XPath;
using System.Diagnostics;

class testClass
{
    [STAThreadAttribute]
    static void Main()
    {
        File.Delete("TraceOutput.xml");
        TraceSource ts = new TraceSource("TestSource");
#if NOCONFIGFILE
        //ts.Listeners.Add(new EventSchemaTraceListener("TraceOutput.xml", "eventListener", 65536, TraceLogRetentionOption.LimitedCircularFiles, 20480000, 2));
        ts.Listeners.Add(new EventSchemaTraceListener("TraceOutput.xml", "eventListener"));
        ts.Listeners["eventListener"].TraceOutputOptions = TraceOptions.DateTime | TraceOptions.ProcessId | TraceOptions.Timestamp;
#endif
        ts.Switch.Level = SourceLevels.All;
        string testString = "<Test><InnerElement Val=\"1\" /><InnerElement Val=\"Data\"/><AnotherElement>11</AnotherElement></Test>";
        UnescapedXmlDiagnosticData unXData = new UnescapedXmlDiagnosticData(testString);
        ts.TraceData(TraceEventType.Error, 38, unXData);
        ts.TraceEvent(TraceEventType.Error, 38, testString);
        Trace.Listeners.Add(new EventSchemaTraceListener("TraceOutput.xml"));
        Trace.Write("test", "test");
        Trace.Flush();
        ts.Flush();
        ts.Close();
        DisplayProperties(ts);
        Process.Start("notepad.exe", "TraceOutput.xml");
        Console.WriteLine("Press the enter key to exit");
        Console.ReadLine();
    }
    private static void DisplayProperties(TraceSource ts)
    {
        Console.WriteLine("IsThreadSafe? " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).IsThreadSafe);
        Console.WriteLine("BufferSize =  " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).BufferSize);
        Console.WriteLine("MaximumFileSize =  " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).MaximumFileSize);
        Console.WriteLine("MaximumNumberOfFiles =  " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).MaximumNumberOfFiles);
        Console.WriteLine("Name =  " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).Name);
        Console.WriteLine("TraceLogRetentionOption =  " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).TraceLogRetentionOption);
        Console.WriteLine("TraceOutputOptions =  " + ((EventSchemaTraceListener)ts.Listeners["eventListener"]).TraceOutputOptions);
    }
}

#Const NOCONFIGFILE = True
Imports System.IO
Imports System.Xml
Imports System.Xml.XPath
Imports System.Diagnostics

Class testClass

    <STAThreadAttribute()> _
    Shared Sub Main()
        File.Delete("TraceOutput.xml")
        Dim ts As New TraceSource("TestSource")
#If NOCONFIGFILE Then
        ts.Listeners.Add(New EventSchemaTraceListener("TraceOutput.xml", "eventListener", 65536, TraceLogRetentionOption.LimitedCircularFiles, 20480000, 2))
        ts.Listeners("eventListener").TraceOutputOptions = TraceOptions.DateTime Or TraceOptions.ProcessId Or TraceOptions.Timestamp
#End If
        ts.Switch.Level = SourceLevels.All
        Dim testString As String = "<Test><InnerElement Val=""1"" /><InnerElement Val=""Data""/><AnotherElement>11</AnotherElement></Test>"
        Dim unXData As New UnescapedXmlDiagnosticData(testString)
        ts.TraceData(TraceEventType.Error, 38, unXData)
        ts.TraceEvent(TraceEventType.Error, 38, testString)
        ts.Flush()
        ts.Close()
        DisplayProperties(ts)
        Process.Start("notepad.exe", "TraceOutput.xml")
        Console.WriteLine("Press the enter key to exit")
        Console.ReadLine()

    End Sub

    Private Shared Sub DisplayProperties(ByVal ts As TraceSource)
        Console.WriteLine("IsThreadSafe? " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).IsThreadSafe.ToString())
        Console.WriteLine("BufferSize =  " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).BufferSize.ToString())
        Console.WriteLine("MaximumFileSize =  " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).MaximumFileSize.ToString())
        Console.WriteLine("MaximumNumberOfFiles =  " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).MaximumNumberOfFiles.ToString())
        Console.WriteLine("Name =  " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).Name)
        Console.WriteLine("TraceLogRetentionOption =  " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).TraceLogRetentionOption.ToString())
        Console.WriteLine("TraceOutputOptions =  " + CType(ts.Listeners("eventListener"), EventSchemaTraceListener).TraceOutputOptions.ToString())
    End Sub
End Class

Hinweise

Die EventSchemaTraceListener Klasse stellt die Ablaufverfolgung von End-to-End-schemakonformen Ereignissen bereit. Sie können die End-to-End-Ablaufverfolgung für ein System mit heterogenen Komponenten verwenden, die Thread-, AppDomainProzess- und Computergrenzen überschreiten. Ein standardisiertes Ereignisschema ermöglicht die Ablaufverfolgung über diese Grenzen hinweg. Das Schema ermöglicht das Hinzufügen von benutzerdefinierten, schemakonformen Elementen. Sie können das Dienstablaufverfolgungs-Viewer-Tool (SvcTraceViewer.exe) verwenden, um die Ereignisdaten anzuzeigen.

EventSchemaTraceListener ist für die Protokollierung der Leistung mit impliziter Unterstützung für die sperrfreie Ablaufverfolgung optimiert.

Die EventSchemaTraceListener Klasse konvertiert Ablaufverfolgungs- und Debugginginformationen in einen XML-codierten Textstream. Die Beschreibung der XML-Ausgabe wird in den Tabellen weiter unten in diesem Abschnitt angezeigt.

Sie können ein EventSchemaTraceListener Objekt in Ihrem Code erstellen. Alternativ können Sie für .NET Framework-Apps ein EventSchemaTraceListener Objekt über die Anwendungskonfigurationsdatei aktivieren oder deaktivieren und dann das konfigurierte EventSchemaTraceListener Objekt in Ihrer Anwendung verwenden. Informationen zur Verwendung von Konfigurationsdateien für die Ablaufverfolgung und das Debuggen in .NET Framework-Apps finden Sie unter Ablaufverfolgungs- und Debugeinstellungenschema.

Um ein EventSchemaTraceListener Objekt in einer .NET Framework-App zu konfigurieren, ändern Sie die Konfigurationsdatei, die dem Namen Ihrer Anwendung entspricht. In dieser Datei können Sie die Eigenschaften für einen Listener hinzufügen, entfernen oder festlegen. Die Konfigurationsdatei sollte wie folgt formatiert werden:

<configuration>
    <system.diagnostics>
        <sources>
            <source name="TestSource" >
                <listeners>
                    <!--Remove the default trace listener for better performance.-->
                    <remove name="Default"/>
                    <!--Note: Removing the default trace listener prevents the dialog box
                    from being displayed for Debug.Fail or Debug.Assert commands that are
                    executed in user mode.-->
                    <add name="eventListener"
                      type="System.Diagnostics.EventSchemaTraceListener,  system.core"
                      initializeData="TraceOutput.xml"
                      traceOutputOptions="ProcessId, DateTime, Timestamp"
                      bufferSize="65536"
                      maximumFileSize="20480000"
                      logRetentionOption="LimitedCircularFiles"
                      maximumNumberOfFiles="2"/>
                </listeners>
            </source>
        </sources>
    </system.diagnostics>

Die EventSchemaTraceListener Klasse erbt die Filter Eigenschaft von der Basisklasse TraceListener. Die Filter Eigenschaft ermöglicht eine zusätzliche Ebene der Ablaufverfolgungsausgabefilterung im Listener. Wenn ein Filter vorhanden ist, rufen die Methoden des Ablaufverfolgungslisteners die TraceShouldTrace Methode des Filters auf, um zu bestimmen, ob die Ablaufverfolgung ausgegeben werden soll.

Wenn versucht wird, in eine datei zu schreiben, die verwendet wird oder nicht verfügbar ist, wird dem Dateinamen automatisch ein GUID-Suffix hinzugefügt.

In der folgenden Tabelle werden die Elemente und Attribute der XML-Ausgabe beschrieben.

In der folgenden Tabelle sind die Zeichen dargestellt, die in der XML-Ausgabe escapen. Escaping erfolgt in allen Elementen und Attributen außer dem UserData Element, das vom Benutzer bereitgestellte, nicht gescapete Daten enthält. Das UserData Element ist ein Ergebnis von Aufrufen der TraceData Methode.