Postupy: Vytváření a inicializace zdrojů trasování

Článek
03/02/2024

Poznámka:

Tento článek je specifický pro rozhraní .NET Framework. Nevztahuje se na novější implementace .NET, včetně .NET 6 a novějších verzí.

Třída TraceSource je používána aplikacemi k vytváření trasování, které lze přidružit k aplikaci. TraceSource poskytuje metody trasování, které umožňují snadno trasovat události, data trasování a informační trasování problémů. Výstup trasování lze TraceSource vytvořit a inicializovat pomocí konfiguračních souborů nebo bez použití konfiguračních souborů. Toto téma obsahuje pokyny pro obě možnosti. Doporučujeme však použít konfigurační soubory k usnadnění rekonfigurace trasování vytvořených zdroji trasování za běhu.

Vytvoření a inicializace zdroje trasování pomocí konfiguračního souboru

Vytvořte projekt konzolové aplikace sady Visual Studio (.NET Framework) a nahraďte zadaný kód následujícím kódem. Tento kód zaznamená chyby a upozornění a vypíše některé z nich do konzoly a některé z nich do souboru myListener, který je vytvořen položkami v konfiguračním souboru.

using System;
using System.Diagnostics;

class TraceTest
{

    private static TraceSource mySource =
            new TraceSource("TraceSourceApp");
        static void Main(string[] args)
        {
           // Issue an error and a warning message. Only the error message
            // should be logged.
            Activity1();

            // Save the original settings from the configuration file.
            EventTypeFilter configFilter =
                (EventTypeFilter)mySource.Listeners["console"].Filter;

            // Create a new event type filter that ensures
            // warning messages will be written.
            mySource.Listeners["console"].Filter =
                new EventTypeFilter(SourceLevels.Warning);

            // Allow the trace source to send messages to listeners
            // for all event types. This statement will override
            // any settings in the configuration file.
            // If you do not change the switch level, the event filter
            // changes have no effect.
            mySource.Switch.Level = SourceLevels.All;

            // Issue a warning and a critical message. Both should be logged.
            Activity2();

            // 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.TraceEvent(TraceEventType.Warning, 2,
                "Warning message.");
        }
        static void Activity3()
        {
            mySource.TraceEvent(TraceEventType.Error, 4,
                "Error message.");
            mySource.TraceInformation("Informational message.");
        }
    }

Imports System.Diagnostics

Class TraceTest

    Private Shared mySource As New TraceSource("TraceSourceApp")

    Shared Sub Main(ByVal args() As String)
        ' Issue an error and a warning message. Only the error message
        ' should be logged.
        Activity1()

        ' Save the original settings from the configuration file.
        Dim configFilter As EventTypeFilter = CType(mySource.Listeners("console").Filter, EventTypeFilter)

        ' Create a new event type filter that ensures 
        ' warning messages will be written.
        mySource.Listeners("console").Filter = New EventTypeFilter(SourceLevels.Warning)

        ' Allow the trace source to send messages to listeners 
        ' for all event types. This statement will override 
        ' any settings in the configuration file.
        ' If you do not change the switch level, the event filter
        ' changes have no effect.
        mySource.Switch.Level = SourceLevels.All

        ' Issue a warning and a critical message. Both should be logged.
        Activity2()

        ' Restore the original filter settings.
        mySource.Listeners("console").Filter = configFilter
        Activity3()
        mySource.Close()
        Return

    End Sub

    Shared Sub Activity1()
        mySource.TraceEvent(TraceEventType.Error, 1, "Error message.")
        mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message.")

    End Sub

    Shared Sub Activity2()
        mySource.TraceEvent(TraceEventType.Critical, 3, "Critical message.")
        mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message.")

    End Sub

    Shared Sub Activity3()
        mySource.TraceEvent(TraceEventType.Error, 4, "Error message.")
        mySource.TraceInformation("Informational message.")

    End Sub
End Class

Přidejte do projektu konfigurační soubor aplikace, pokud není k dispozici, aby inicializoval zdroj trasování pojmenovaný TraceSourceApp v příkladu kódu v kroku 1.
Nahraďte výchozí obsah konfiguračního souboru následujícím nastavením pro inicializaci naslouchacího procesu trasování konzoly a naslouchacího procesu trasování zapisovače textu pro zdroj trasování vytvořený v kroku 1.
```
<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="Error"/>
          </add>
          <add name="myListener"/>
          <remove name="Default"/>
        </listeners>
      </source>
    </sources>
    <switches>
      <add name="sourceSwitch" value="Error"/>
    </switches>
    <sharedListeners>
      <add name="myListener"
        type="System.Diagnostics.TextWriterTraceListener"
        initializeData="myListener.log">
        <filter type="System.Diagnostics.EventTypeFilter"
          initializeData="Error"/>
      </add>
    </sharedListeners>
  </system.diagnostics>
</configuration>
```
Kromě konfigurace naslouchacích procesů trasování konfigurační soubor vytvoří filtry pro oba naslouchací procesy a vytvoří zdrojový přepínač pro zdroj trasování. Zobrazí se dvě techniky pro přidání naslouchacích procesů trasování: přidání naslouchacího procesu přímo do zdroje trasování a přidání naslouchacího procesu do kolekce sdílených naslouchacích procesů a následné přidání do zdroje trasování. Filtry určené pro oba naslouchací procesy se inicializují s různými úrovněmi zdroje. Výsledkem je, že některé zprávy zapisují jenom jeden ze dvou naslouchacích procesů.

Konfigurační soubor inicializuje nastavení pro zdroj trasování v době inicializace aplikace. Aplikace může dynamicky měnit vlastnosti nastavené konfiguračním souborem tak, aby přepsaly všechna nastavení určená uživatelem. Můžete například chtít zajistit, aby se důležité zprávy vždy odesílaly do textového souboru bez ohledu na aktuální nastavení konfigurace. Ukázkový kód ukazuje, jak přepsat nastavení konfiguračního souboru, aby se zajistilo, že kritické zprávy budou výstupem do naslouchacích procesů trasování.

Změna nastavení konfiguračního souboru při provádění aplikace nezmění počáteční nastavení. Chcete-li změnit nastavení, musíte buď restartovat aplikaci, nebo programově aktualizovat aplikaci pomocí Trace.Refresh metody.

Inicializace zdrojů trasování, naslouchacích procesů a filtrů bez konfiguračního souboru

Pomocí následujícího ukázkového kódu povolte trasování přes zdroj trasování bez použití konfiguračního souboru. Nejedná se o doporučený postup, ale může docházet k okolnostem, kdy nechcete záviset na konfiguračních souborech, aby se zajistilo trasování.

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

namespace TraceSourceApp
{
    class Program
    {
        private static TraceSource mySource =
            new TraceSource("TraceSourceApp");
        static void Main(string[] args)
        {
            mySource.Switch = new SourceSwitch("sourceSwitch", "Error");
            mySource.Listeners.Remove("Default");
            TextWriterTraceListener textListener =
                new TextWriterTraceListener("myListener.log");
            ConsoleTraceListener console =
                new ConsoleTraceListener(false);
            console.Filter =
                new EventTypeFilter(SourceLevels.Information);
            console.Name = "console";
            textListener.Filter =
                new EventTypeFilter(SourceLevels.Error);
            mySource.Listeners.Add(console);
            mySource.Listeners.Add(textListener);
            Activity1();

            // Allow the trace source to send messages to
            // listeners for all event types. Currently only
            // error messages or higher go to the listeners.
            // Messages must get past the source switch to
            // get to the listeners, regardless of the settings
            // for the listeners.
            mySource.Switch.Level = SourceLevels.All;

            // Set the filter settings for the
            // console trace listener.
            mySource.Listeners["console"].Filter =
                new EventTypeFilter(SourceLevels.Critical);
            Activity2();

            // Change the filter settings for the console trace listener.
            mySource.Listeners["console"].Filter =
                new EventTypeFilter(SourceLevels.Information);
            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.");
        }
    }
}

Imports System.Diagnostics
Imports System.Threading



Class Program
    Private Shared mySource As New TraceSource("TraceSourceApp")

    Shared Sub Main(ByVal args() As String)
        mySource.Switch = New SourceSwitch("sourceSwitch", "Error")
        mySource.Listeners.Remove("Default")
        Dim textListener As New TextWriterTraceListener("myListener.log")
        Dim console As New ConsoleTraceListener(False)
        console.Filter = New EventTypeFilter(SourceLevels.Information)
        console.Name = "console"
        textListener.Filter = New EventTypeFilter(SourceLevels.Error)
        mySource.Listeners.Add(console)
        mySource.Listeners.Add(textListener)
        Activity1()

        ' Allow the trace source to send messages to 
        ' listeners for all event types. Currently only 
        ' error messages or higher go to the listeners.
        ' Messages must get past the source switch to 
        ' get to the listeners, regardless of the settings 
        ' for the listeners.
        mySource.Switch.Level = SourceLevels.All

        ' Set the filter settings for the 
        ' console trace listener.
        mySource.Listeners("console").Filter = New EventTypeFilter(SourceLevels.Critical)
        Activity2()

        ' Change the filter settings for the console trace listener.
        mySource.Listeners("console").Filter = New EventTypeFilter(SourceLevels.Information)
        Activity3()
        mySource.Close()
        Return

    End Sub

    Shared Sub Activity1()
        mySource.TraceEvent(TraceEventType.Error, 1, "Error message.")
        mySource.TraceEvent(TraceEventType.Warning, 2, "Warning message.")

    End Sub

    Shared Sub Activity2()
        mySource.TraceEvent(TraceEventType.Critical, 3, "Critical message.")
        mySource.TraceInformation("Informational message.")

    End Sub

    Shared Sub Activity3()
        mySource.TraceEvent(TraceEventType.Error, 4, "Error message.")
        mySource.TraceInformation("Informational message.")

    End Sub
End Class

Sdílet prostřednictvím

Postupy: Vytváření a inicializace zdrojů trasování

Vytvoření a inicializace zdroje trasování pomocí konfiguračního souboru

Inicializace zdrojů trasování, naslouchacích procesů a filtrů bez konfiguračního souboru

Viz také

Další materiály