EventSchemaTraceListener Klas

Definitie

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

public class EventSchemaTraceListener : System.Diagnostics.TextWriterTraceListener

type EventSchemaTraceListener = class
    inherit TextWriterTraceListener

Public Class EventSchemaTraceListener
Inherits TextWriterTraceListener

Overname

Object

MarshalByRefObject

TraceListener

TextWriterTraceListener

EventSchemaTraceListener

Voorbeelden

In het volgende codevoorbeeld ziet u hoe u de EventSchemaTraceListener klasse gebruikt.

#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

Opmerkingen

De EventSchemaTraceListener klasse biedt tracering van end-to-end schema-compatibele gebeurtenissen. U kunt end-to-end-tracering gebruiken voor een systeem met heterogene onderdelen die thread-, AppDomainproces- en computergrenzen overschrijden. Een gestandaardiseerd gebeurtenisschema maakt tracering mogelijk over deze grenzen. Het schema maakt het toevoegen van aangepaste, schema-compatibele elementen mogelijk. U kunt het hulpprogramma Service Trace Viewer (SvcTraceViewer.exe) gebruiken om de gebeurtenisgegevens weer te geven.

EventSchemaTraceListener is afgestemd op logboekprestaties met impliciete ondersteuning voor tracering zonder vergrendeling.

De EventSchemaTraceListener klasse converteert tracerings- en foutopsporingsgegevens naar een xml-gecodeerde tekststroom. De beschrijving van de XML-uitvoer wordt weergegeven in de tabellen verderop in deze sectie.

U kunt een EventSchemaTraceListener object maken in uw code. Voor .NET Framework-apps kunt u ook een EventSchemaTraceListener-object in- of uitschakelen via het toepassingsconfiguratiebestand en vervolgens het geconfigureerde EventSchemaTraceListener-object in uw toepassing gebruiken. Zie Trace and Debug Settings Schema voor informatie over het gebruik van configuratiebestanden voor tracering en foutopsporing in .NET Framework-apps.

Als u een EventSchemaTraceListener-object in een .NET Framework-app wilt configureren, wijzigt u het configuratiebestand dat overeenkomt met de naam van uw toepassing. In dit bestand kunt u de eigenschappen voor een listener toevoegen, verwijderen of instellen. Het configuratiebestand moet als volgt worden opgemaakt:

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

De EventSchemaTraceListener klasse neemt de Filter eigenschap over van de basisklasse TraceListener. Met Filter de eigenschap is een extra niveau van traceringsuitvoerfilters mogelijk bij de listener. Als er een filter aanwezig is, roepen de Trace methoden van de traceerlistener de ShouldTrace methode van het filter aan om te bepalen of de tracering moet worden verzonden.

Als er een poging wordt gedaan om naar een bestand te schrijven dat wordt gebruikt of niet beschikbaar is, wordt automatisch een GUID-achtervoegsel toegevoegd aan de bestandsnaam.

In de volgende tabel worden de elementen en kenmerken van de XML-uitvoer beschreven.

In de volgende tabel ziet u de tekens die zijn ontsnapt in de XML-uitvoer. Ontsnappen vindt plaats in alle elementen en kenmerken, met uitzondering van het UserData element, dat door de gebruiker verstrekte, niet-gescapede gegevens bevat. Het UserData element is het resultaat van aanroepen naar de TraceData methode.