This is a cache of https://www.elastic.co/guide/en/apm/agent/dotnet/current/setup-sqlclient.html. It is a snapshot of the page at 2024-10-05T01:01:40.496+0000.
SqlClient | APM .NET Agent Reference [<strong>1</strong>.x] | Elastic

SqlClient

edit

Quick start

edit

You can enable auto instrumentation for System.Data.SqlClient or Microsoft.Data.SqlClient by referencing Elastic.Apm.SqlClient package and passing SqlClientDiagnosticSubscriber to the UseElasticApm method in case of ASP.NET Core as it shown in example:

// Enable tracing of outgoing db requests
app.UseElasticApm(Configuration, new SqlClientDiagnosticSubscriber()); 

Configuration is the IConfiguration instance passed to your Startup type

or passing SqlClientDiagnosticSubscriber to the Subscribe method and make sure that the code is called only once, otherwise the same database call could be captured multiple times:

// Enable tracing of outgoing db requests
Agent.Subscribe(new SqlClientDiagnosticSubscriber());

Auto instrumentation for System.Data.SqlClient is available for both .NET Core and .NET Framework applications, however, support of .NET Framework has one limitation: command text cannot be captured.

Auto instrumentation for Microsoft.Data.SqlClient is available only for .NET Core at the moment.

As an alternative to using the Elastic.Apm.SqlClient package to instrument database calls, see Profiler Auto instrumentation.