Porady: tworzenie i inicjowanie źródeł śledzenia

Artykuł
06/04/2024

Uwaga

Ten artykuł jest specyficzny dla programu .NET Framework. Nie ma zastosowania do nowszych implementacji platformy .NET, w tym .NET 6 i nowszych wersji.

Klasa TraceSource jest używana przez aplikacje do tworzenia śladów, które mogą być skojarzone z aplikacją. TraceSource Udostępnia metody śledzenia, które umożliwiają łatwe śledzenie zdarzeń, danych śledzenia i wydawania śladów informacyjnych. Dane wyjściowe śledzenia z TraceSource programu można utworzyć i zainicjować przy użyciu plików konfiguracji lub bez niego. Ten temat zawiera instrukcje dotyczące obu opcji. Zalecamy jednak użycie plików konfiguracji w celu ułatwienia ponownej konfiguracji śladów generowanych przez źródła śledzenia w czasie wykonywania.

Aby utworzyć i zainicjować źródło śledzenia przy użyciu pliku konfiguracji

Utwórz projekt aplikacji konsolowej programu Visual Studio (.NET Framework) i zastąp podany kod poniższym kodem. Ten kod rejestruje błędy i ostrzeżenia oraz wyprowadza niektóre z nich do konsoli, a niektóre z nich do pliku myListener utworzonego przez wpisy w pliku konfiguracji.

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

Dodaj plik konfiguracji aplikacji, jeśli go nie ma, do projektu w celu zainicjowania źródła śledzenia o nazwie TraceSourceApp w przykładzie kodu w kroku 1.
Zastąp domyślną zawartość pliku konfiguracji następującymi ustawieniami, aby zainicjować odbiornik śledzenia konsoli i odbiornik śledzenia modułu zapisywania tekstu dla źródła śledzenia utworzonego w 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>
```
Oprócz konfigurowania odbiorników śledzenia plik konfiguracji tworzy filtry dla odbiorników i tworzy przełącznik źródłowy dla źródła śledzenia. Pokazano dwie techniki dodawania odbiorników śledzenia: dodawanie odbiornika bezpośrednio do źródła śledzenia i dodawanie odbiornika do kolekcji udostępnionych odbiorników, a następnie dodawanie go według nazwy do źródła śledzenia. Filtry zidentyfikowane dla dwóch odbiorników są inicjowane z różnymi poziomami źródła. Spowoduje to zapisanie niektórych komunikatów tylko przez jednego z dwóch odbiorników.

Plik konfiguracji inicjuje ustawienia źródła śledzenia w momencie inicjowania aplikacji. Aplikacja może dynamicznie zmieniać właściwości ustawione przez plik konfiguracji, aby zastąpić wszystkie ustawienia określone przez użytkownika. Możesz na przykład upewnić się, że komunikaty krytyczne są zawsze wysyłane do pliku tekstowego, niezależnie od bieżących ustawień konfiguracji. Przykładowy kod pokazuje, jak zastąpić ustawienia pliku konfiguracji, aby upewnić się, że komunikaty krytyczne są przekazywane do odbiorników śledzenia.

Zmiana ustawień pliku konfiguracji podczas wykonywania aplikacji nie powoduje zmiany ustawień początkowych. Aby zmienić ustawienia, należy ponownie uruchomić aplikację lub programowo odświeżyć aplikację przy użyciu Trace.Refresh metody .

Aby zainicjować źródła śledzenia, odbiorniki i filtry bez pliku konfiguracji

Użyj poniższego przykładowego kodu, aby włączyć śledzenie za pośrednictwem źródła śledzenia bez użycia pliku konfiguracji. Nie jest to zalecane rozwiązanie, ale mogą wystąpić okoliczności, w których nie chcesz zależeć od plików konfiguracji w celu zapewnienia śledzenia.

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

Udostępnij za pośrednictwem

Porady: tworzenie i inicjowanie źródeł śledzenia

Aby utworzyć i zainicjować źródło śledzenia przy użyciu pliku konfiguracji

Aby zainicjować źródła śledzenia, odbiorniki i filtry bez pliku konfiguracji

Zobacz też

Dodatkowe zasoby