Verfolgung von SQL-Abfragen mit dem X-Ray SDK for .NET

Das X-Ray SDK for .NET bietet eine Wrapper-Klasse fürSystem.Data.SqlClient.SqlCommand, benanntTraceableSqlCommand, die Sie anstelle von verwenden könnenSqlCommandaus. Sie können einen SQL-Befehl mit der Klasse TraceableSqlCommand initialisieren.

Ablaufverfolgung von SQL-Abfragen mit synchronen und asynchronen Methoden

Die folgenden Beispiele zeigen, wie Sie SQL Server-Abfragen mit TraceableSqlCommand automatisch synchron und asynchron verfolgen.

Beispiel Controller.cs – SQL-Client-Instrumentierung (synchron)

using Amazon;
using Amazon.Util;
using Amazon.XRay.Recorder.Core;
using Amazon.XRay.Recorder.Handlers.SqlServer;

private void QuerySql(int id)
{
  var connectionString = ConfigurationManager.AppSettings["RDS_CONNECTION_STRING"];
  using (var sqlConnection = new SqlConnection(connectionString))
  using (var sqlCommand = new TraceableSqlCommand("SELECT " + id, sqlConnection))
  {
    sqlCommand.Connection.Open();
    sqlCommand.ExecuteNonQuery();
  }
}

Sie können die Abfrage mithilfe der ExecuteReaderAsync-Methode asynchron ausführen.

Beispiel Controller.cs – SQL-Client-Instrumentierung (asynchron)

using Amazon;
using Amazon.Util;
using Amazon.XRay.Recorder.Core;
using Amazon.XRay.Recorder.Handlers.SqlServer;
private void QuerySql(int id)
{
  var connectionString = ConfigurationManager.AppSettings["RDS_CONNECTION_STRING"];
  using (var sqlConnection = new SqlConnection(connectionString))
  using (var sqlCommand = new TraceableSqlCommand("SELECT " + id, sqlConnection))
  {
    await sqlCommand.ExecuteReaderAsync();
  }
}

Erfassen von SQL-Abfragen an SQL Server

Sie können die Erfassung von SqlCommand.CommandText als Teil des Untersegments aktivieren, das von Ihrer SQL-Abfrage erstellt wurde. SqlCommand.CommandText wird als Feld sanitized_query im JSON-Untersegment angezeigt. Standardmäßig ist diese Funktion aus Sicherheitsgründen deaktiviert.

Anmerkung

Aktivieren Sie die Sammlungsfunktion nicht, wenn Sie sensible Informationen als Klartext in Ihre SQL-Abfragen einfügen.

Sie können die Sammlung von SQL-Abfragen auf zwei Arten aktivieren:

• Legen Sie die Eigenschaft CollectSqlQueries in der globalen Konfiguration für Ihre Anwendung auf true fest.

• Legen Sie den Parameter collectSqlQueries in der Instance TraceableSqlCommand auf true fest, um Aufrufe innerhalb der Instance zu erfassen.

Aktivieren der globalen CollectSqlQueries-Eigenschaft

Die folgenden Beispiele zeigen, wie Sie die Eigenschaft CollectSqlQueries für .NET und .NET Core aktivieren.

.NET

Um die Eigenschaft CollectSqlQueries in der globalen Konfiguration Ihrer Anwendung in .NET auf true festzulegen, ändern Sie die appsettings Ihrer App.config- oder Web.config-Datei wie dargestellt.

Beispiel App.configOrWeb.config— Globales Aktivieren der SQL-Abfragesammlung

<configuration>
<appSettings>
    <add key="CollectSqlQueries" value="true">
</appSettings>
</configuration>

.NET Core

So stellen Sie dasCollectSqlQueriesimmobilien zutrueändern Sie in der globalen Konfiguration Ihrer Anwendung in .NET Coreappsettings.json-Datei unter der X-Ray-Taste, wie gezeigt.

Beispiel appsettings.json— Globales Aktivieren der SQL-Abfragesammlung

{
  "XRay": {
    "CollectSqlQueries":"true"
  }
}

Aktivieren des collectSqlQueries-Parameters

Sie können den Parameter collectSqlQueries in der Instance TraceableSqlCommand auf true setzen, um den SQL-Abfragetext für SQL Server-Abfragen zu erfassen, die mit dieser Instance durchgeführt wurden. Wenn Sie den Parameter auf false setzen, wird die Funktion CollectSqlQuery für die Instance TraceableSqlCommand deaktiviert.

Anmerkung

Der Wert von collectSqlQueries in der Instance TraceableSqlCommand überschreibt den in der globalen Konfiguration der Eigenschaft CollectSqlQueries festgelegten Wert.

BeispielController.cs— Aktivieren der SQL-Abfragesplung für die Instance

using Amazon;
using Amazon.Util;
using Amazon.XRay.Recorder.Core;
using Amazon.XRay.Recorder.Handlers.SqlServer;

private void QuerySql(int id)
{
  var connectionString = ConfigurationManager.AppSettings["RDS_CONNECTION_STRING"];
  using (var sqlConnection = new SqlConnection(connectionString))
  using (var command = new TraceableSqlCommand("SELECT " + id, sqlConnection, collectSqlQueries: true))
  {
    command.ExecuteNonQuery();
  }
}