Compteurs d’événements dans SqlClient

S’applique à : .NET Framework .NET Core .NET Standard

Télécharger ADO.NET

Vous pouvez utiliser des compteurs d’événements Microsoft.Data.SqlClient afin de superviser l’état de votre application et les ressources de connexion utilisées. Les compteurs d’événements peuvent être supervisés par .NET CLI global tools et perfView ou être accessibles programmatiquement à l’aide de la classe EventListener de l’espace de noms System.Diagnostics.Tracing.

Compteurs d’événements disponibles

Actuellement, 16 compteurs d’événements différents sont disponibles pour Microsoft.Data.SqlClient, comme décrit dans le tableau suivant :

Récupérer les valeurs des compteurs d’événements

Il existe deux principales façons d’utiliser des compteurs d’événements, dans le processus ou hors processus. Pour plus d’informations, consultez Utiliser des compteurs d’événements.

Consommer hors processus

Dans Windows, vous pouvez utiliser PerfView et Xperf pour collecter les données des compteurs d’événements. Pour plus d’informations, consultez Activer le suivi d’événements dans SqlClient. Vous pouvez utiliser dotnet-counters et dotnet-trace, qui sont des outils .NET multiplateformes pour superviser et collecter les données des compteurs d’événements.

Exemple hors processus

La commande suivante s’exécute et collecte les valeurs des compteurs d’événements SqlClient une fois par seconde. Si vous remplacez EventCounterIntervalSec=1 par une valeur supérieure, vous autorisez la collecte d’une trace plus petite avec moins de précision dans les données des compteurs.

PerfView /onlyProviders=*Microsoft.Data.SqlClient.EventSource:EventCounterIntervalSec=1 run "<application-Path>"

La commande suivante collecte les valeurs des compteurs d’événements SqlClient une fois par seconde.

dotnet-trace collect --process-id <pid> --providers Microsoft.Data.SqlClient.EventSource:0:1:EventCounterIntervalSec=1

La commande suivante supervise les valeurs des compteurs d’événements SqlClient une fois toutes les trois secondes.

dotnet-counters monitor Microsoft.Data.SqlClient.EventSource -p <process-id> --refresh-interval 3

La commande suivante supervise les valeurs des compteurs d’événements SqlClient sélectionnés une fois par seconde.

dotnet-counters monitor Microsoft.Data.SqlClient.EventSource[hard-connects,hard-disconnects] -p <process-id>

Consommer dans le processus

Vous pouvez utiliser les valeurs des compteurs via l’API EventListener. EventListener constitue une méthode dans le processus d’utiliser tout événement écrit par des instances d’une EventSource dans votre application. Pour plus d’informations, consultez EventListener.

Exemple dans le processus

L’exemple de code suivant capture des événements Microsoft.Data.SqlClient.EventSource avec EventCounterIntervalSec=1. Il écrit le nom du compteur et sa valeur Mean lors de chaque mise à jour du compteur d’événements.

using System;
using System.Collections.Generic;
using System.Diagnostics.Tracing;
using System.Linq;

// This listener class will listen for events from the SqlClientEventSource class.
// SqlClientEventSource is an implementation of the EventSource class which gives 
// it the ability to create events.
public class EventCounterListener : EventListener
{
    protected override void OnEventSourceCreated(EventSource eventSource)
    {
        // Only enable events from SqlClientEventSource.
        if (eventSource.Name.Equals("Microsoft.Data.SqlClient.EventSource"))
        {
            var options = new Dictionary<string, string>();
            // define time interval 1 second
            // without defining this parameter event counters will not enabled
            options.Add("EventCounterIntervalSec", "1");
            // enable for the None keyword
            EnableEvents(eventSource, EventLevel.Informational, EventKeywords.None, options);
        }
    }

    // This callback runs whenever an event is written by SqlClientEventSource.
    // Event data is accessed through the EventWrittenEventArgs parameter.
    protected override void OnEventWritten(EventWrittenEventArgs eventData)
    {
        if (eventData.Payload.FirstOrDefault(p => p is IDictionary<string, object> x && x.ContainsKey("Name")) is IDictionary<string, object> counters)
        {
            if (counters.TryGetValue("DisplayName", out object name) && name is string cntName
                && counters.TryGetValue("Mean", out object value) && value is double cntValue)
            {
                // print event counter's name and mean value
                Console.WriteLine($"{cntName}\t\t{cntValue}");
            }
        }
    }
}

class Program
{
    static void Main(string[] args)
    {
        // Create a new event listener
        using (var listener = new EventCounterListener())
        {
            string connectionString = "Data Source=localhost; Integrated Security=true";

            for (int i = 0; i < 50; i++)
            {
                // Open a connection
                SqlConnection cnn = new SqlConnection(connectionString);
                cnn.Open();
                // wait for sampling interval happens
                System.Threading.Thread.Sleep(500);
            }
        }
    }
}

Actual active connections currently made to servers           0
Active connections retrieved from the connection pool         26
Number of connections not using connection pooling            0
Number of connections managed by the connection pool          26
Number of active unique connection strings              1
Number of unique connection strings waiting for pruning       0
Number of active connection pools               1
Number of inactive connection pools             0
Number of active connections            26
Number of ready connections in the connection pool            0
Number of connections currently waiting to be ready           0
...

Voir aussi

• Compteurs de performances dans SqlClient
• dotnet-counters
• dotnet-trace
• Activer le suivi d’événements dans SqlClient
• Microsoft ADO.NET pour SQL Server