Verfolgen von SQL-Abfragen mit dem X-Ray SDK for .NET - AWS X-Ray
Ablaufverfolgung von SQL-Abfragen mit synchronen und asynchronen MethodenErfassen von SQL-Abfragen an SQL Server

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

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

Anmerkung

End-of-support Hinweis — Am 25. Februar 2027 stellt AWS X-Ray die Unterstützung für AWS X-Ray SDKs und Daemon ein. Nach dem 25. Februar 2027 werden Sie keine Updates oder Releases mehr erhalten. Weitere Informationen zum Zeitplan für den Support finden Sie unterZeitplan für das Ende des Supports für X-Ray SDK und Daemon. Wir empfehlen die Migration zu OpenTelemetry. Weitere Informationen zur Migration zu OpenTelemetry finden Sie unter Migration von X-Ray-Instrumentierung zu OpenTelemetry Instrumentierung.

Das X-Ray-SDK SDK for .NET bietet eine Wrapper-Klasse für System.Data.SqlClient.SqlCommandTraceableSqlCommand, named, die Sie anstelle von SqlCommand verwenden können. 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 Sie die globale Eigenschaft CollectSqlQueries

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.configOder Web.config — Aktiviert die Erfassung von SQL-Abfragen global
<configuration>
<appSettings>
    <add key="CollectSqlQueries" value="true">
</appSettings>
</configuration>
.NET Core

Um die CollectSqlQueries Eigenschaft true in der globalen Konfiguration Ihrer Anwendung in .NET Core auf zu setzen, ändern Sie Ihre appsettings.json Datei unter dem X-Ray-Schlüssel, wie hier gezeigt.

Beispiel appsettings.json— Aktiviert die Erfassung von SQL-Abfragen global
{
  "XRay": {
    "CollectSqlQueries":"true"
  }
}

Aktivieren Sie den collectSqlQueries Parameter

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.

Beispiel Controller.cs — Aktivieren Sie die Erfassung von SQL-Abfragen für die Instanz
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();
  }
}