Procedura: creare e inizializzare origini di traccia

Articolo
06/05/2024

Nota

Questo articolo è specifico per .NET Framework. Non si applica alle implementazioni più recenti di .NET, incluse .NET 6 e versioni successive.

La classe TraceSource viene utilizzata dalle applicazioni per produrre tracce associabili all'applicazione. TraceSource fornisce metodi di traccia che consentono di tracciare con facilità eventi e dati e di generare tracce informative. L'output di traccia da TraceSource può essere creato e inizializzato con o senza l'utilizzo di file di configurazione. In questo argomento vengono fornite istruzioni per entrambe le opzioni. È tuttavia consigliabile utilizzare file di configurazione per semplificare la riconfigurazione delle tracce prodotte dalle origini di traccia in fase di esecuzione.

Per creare e inizializzare un'origine di traccia utilizzando un file di configurazione

Creare un progetto di applicazione console di Visual Studio (.NET Framework) e sostituire il codice fornito con il codice seguente. Il codice registra errori e avvisi e ne restituisce alcuni sulla console e alcuni nel file myListener creato dalle voci del file di configurazione.

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

Aggiungere un file di configurazione dell'applicazione al progetto per inizializzare l'origine della traccia denominata TraceSourceApp nell'esempio di codice riportato nel passaggio 1.
Sostituire il contenuto del file di configurazione predefinito con le impostazioni seguenti per inizializzare un listener di traccia della console e un listener di traccia del writer di testo per l'origine di traccia creata nel passaggio 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>
```
Oltre alla configurazione dei listener di traccia, il file di configurazione crea filtri per entrambi i listener nonché un'opzione di origine per l'origine di traccia. Per l'aggiunta dei listener di analisi sono illustrate due tecniche: aggiunta del listener direttamente nell'origine di analisi e aggiunta di un listener alla raccolta dei listener condivisi e quindi aggiunta di quest'ultimo in base al nome all'origine di analisi. I filtri identificati per i due listener vengono inizializzati con livelli di origine differenti. Di conseguenza, alcuni messaggi vengono scritti da uno solo dei due listener.

Il file di configurazione inizializza le impostazioni dell'origine di traccia nel momento in cui l'applicazione viene inizializzata. L'applicazione può modificare dinamicamente le proprietà impostate dal file di configurazione per eseguire l'override delle eventuali impostazioni specificate dall'utente. È possibile, ad esempio, assicurare che i messaggi critici vengano sempre inviati a un file di testo, indipendentemente dalle impostazioni di configurazione correnti. Nell'esempio di codice viene illustrato come eseguire l'override delle impostazioni del file di configurazione per garantire l'invio dei messaggi critici ai listener di traccia.

Le eventuali modifiche apportate alle impostazioni del file di configurazione durante l'esecuzione dell'applicazione non vengono applicate immediatamente. Per modificare le impostazioni, è necessario riavviare l'applicazione o aggiornare l'applicazione a livello di codice utilizzando il metodo Trace.Refresh.

Per inizializzare le origini di analisi, i listener e i filtri senza un file di configurazione

Utilizzare l'esempio di codice seguente per abilitare la traccia in un'origine di traccia senza utilizzare un file di configurazione. Si consiglia, tuttavia, di utilizzare questa tecnica soltanto quando si desidera eseguire la traccia senza dipendere dai file di configurazione.

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

Condividi tramite

Procedura: creare e inizializzare origini di traccia

Per creare e inizializzare un'origine di traccia utilizzando un file di configurazione

Per inizializzare le origini di analisi, i listener e i filtri senza un file di configurazione

Vedi anche

Risorse aggiuntive