Fix/sql client db name (#2418)

CHANGELOG.md

@@ -18,6 +18,7 @@
 - DB Connection spans presented poorly ([#2409](https://github.com/getsentry/sentry-dotnet/pull/2409))
 - Populate scope's Cookies property ([#2411](https://github.com/getsentry/sentry-dotnet/pull/2411))
 - Fix UWP GateKeeper errors ([#2415](https://github.com/getsentry/sentry-dotnet/pull/2415))
+- Fix sql client db name ([#2418](https://github.com/getsentry/sentry-dotnet/pull/2418))
 
 ### Dependencies
 

src/Sentry.DiagnosticSource/Internal/DiagnosticSource/SentrySqlListener.cs

@@ -71,15 +71,13 @@ private void AddSpan(string operation, object? value)
             return;
         }
 
-        var operationId = value?.GetGuidProperty("OperationId");
-        var connectionId = value?.GetGuidProperty("ConnectionId");
         var parent = transaction.GetDbParentSpan();
         var span = parent.StartChild(operation);
-        SetOperationId(span, operationId);
-        SetConnectionId(span, connectionId);
+        SetOperationId(span, value?.GetGuidProperty("OperationId"));
+        SetConnectionId(span, value?.GetGuidProperty("ConnectionId"));
     }
 
-    private ISpan? GetSpan(SentrySqlSpanType type, KeyValuePair<string, object?> kvp)
+    private ISpan? GetSpan(SentrySqlSpanType type, object? value)
     {
         var transaction = _hub.GetTransactionIfSampled();
         if (transaction == null)
@@ -90,7 +88,7 @@ private void AddSpan(string operation, object? value)
         switch (type)
         {
             case SentrySqlSpanType.Execution:
-                var operationId = kvp.Value?.GetGuidProperty("OperationId");
+                var operationId = value?.GetGuidProperty("OperationId");
                 if (TryGetQuerySpan(transaction, operationId) is { } querySpan)
                 {
                     return querySpan;
@@ -102,7 +100,7 @@ private void AddSpan(string operation, object? value)
                 return null;
 
             case SentrySqlSpanType.Connection:
-                var connectionId = kvp.Value?.GetGuidProperty("ConnectionId");
+                var connectionId = value?.GetGuidProperty("ConnectionId");
                 if (TryGetConnectionSpan(transaction, connectionId) is { } connectionSpan)
                 {
                     return connectionSpan;
@@ -166,6 +164,36 @@ private void UpdateConnectionSpan(object? value)
         }
     }
 
+    private void FinishCommandSpan(object? value, SpanStatus spanStatus)
+    {
+        if (value == null)
+        {
+            return;
+        }
+
+
+        if (GetSpan(SentrySqlSpanType.Execution, value) is not { } commandSpan)
+        {
+            return;
+        }
+
+        // Try to lookup the associated connection span so that we can store the db.name in
+        // the command span as well. This will be easier for users to read/identify than the
+        // ConnectionId (which is a Guid)
+        var connectionId = value.GetGuidProperty("ConnectionId");
+        var transaction = _hub.GetTransactionIfSampled();
+        if (TryGetConnectionSpan(transaction!, connectionId) is { } connectionSpan)
+        {
+            if (connectionSpan.Extra.TryGetValue<string, string>(OTelKeys.DbName) is { } dbName)
+            {
+                SetDatabaseName(commandSpan, dbName);
+            }
+        }
+
+        commandSpan.Description = value.GetStringProperty("Command.CommandText");
+        commandSpan.Finish(spanStatus);
+    }
+
     public void OnCompleted() { }
 
     public void OnError(Exception error) { }
@@ -180,15 +208,11 @@ public void OnNext(KeyValuePair<string, object?> kvp)
                 case SqlMicrosoftBeforeExecuteCommand or SqlDataBeforeExecuteCommand:
                     AddSpan("db.query", kvp.Value);
                     return;
-                case SqlMicrosoftAfterExecuteCommand or SqlDataAfterExecuteCommand
-                    when GetSpan(SentrySqlSpanType.Execution, kvp) is { } commandSpan:
-                    commandSpan.Description = kvp.Value?.GetStringProperty("Command.CommandText");
-                    commandSpan.Finish(SpanStatus.Ok);
+                case SqlMicrosoftAfterExecuteCommand or SqlDataAfterExecuteCommand:
+                    FinishCommandSpan(kvp.Value, SpanStatus.Ok);
                     return;
-                case SqlMicrosoftWriteCommandError or SqlDataWriteCommandError
-                    when GetSpan(SentrySqlSpanType.Execution, kvp) is { } errorSpan:
-                    errorSpan.Description = kvp.Value?.GetStringProperty("Command.CommandText");
-                    errorSpan.Finish(SpanStatus.InternalError);
+                case SqlMicrosoftWriteCommandError or SqlDataWriteCommandError:
+                    FinishCommandSpan(kvp.Value, SpanStatus.InternalError);
                     return;
 
                 // Connection
@@ -199,7 +223,7 @@ when GetSpan(SentrySqlSpanType.Execution, kvp) is { } errorSpan:
                     UpdateConnectionSpan(kvp.Value);
                     return;
                 case SqlMicrosoftWriteConnectionCloseAfterCommand or SqlDataWriteConnectionCloseAfterCommand
-                    when GetSpan(SentrySqlSpanType.Connection, kvp) is { } closeSpan:
+                    when GetSpan(SentrySqlSpanType.Connection, kvp.Value) is { } closeSpan:
                     TrySetConnectionStatistics(closeSpan, kvp.Value);
                     closeSpan.Finish(SpanStatus.Ok);
                     return;

test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet6_0.verified.txt

@@ -94,6 +94,7 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_LoggingAsync,
             db.operation_id: Guid_3
           }
         }

test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.LoggingAsync.DotNet7_0.verified.txt

@@ -94,6 +94,7 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_LoggingAsync,
             db.operation_id: Guid_3
           }
         }

test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Core3_1.verified.txt

@@ -75,6 +75,7 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsEfAsync,
             db.operation_id: Guid_3
           }
         },
@@ -95,6 +96,7 @@ FROM [TestEntities] AS [t],
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsEfAsync,
             db.operation_id: Guid_4
           }
         }

test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet6_0.verified.txt

@@ -75,6 +75,7 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsEfAsync,
             db.operation_id: Guid_3
           }
         },
@@ -95,6 +96,7 @@ FROM [TestEntities] AS [t],
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsEfAsync,
             db.operation_id: Guid_4
           }
         }

test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet7_0.verified.txt

@@ -75,6 +75,7 @@ WHERE @@ROWCOUNT = 1 AND [Id] = scope_identity();
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsEfAsync,
             db.operation_id: Guid_3
           }
         },
@@ -95,6 +96,7 @@ FROM [TestEntities] AS [t],
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsEfAsync,
             db.operation_id: Guid_4
           }
         }

test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt

@@ -67,6 +67,7 @@
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsSqlAsync,
             db.operation_id: Guid_3
           }
         },
@@ -78,6 +79,7 @@
           IsSampled: true,
           Extra: {
             db.connection_id: Guid_1,
+            db.name: SqlListenerTests.verify_RecordsSqlAsync,
             db.operation_id: Guid_4
           }
         }

test/Sentry.DiagnosticSource.Tests/SentrySqlListenerTests.cs

@@ -217,11 +217,7 @@ public void OnNext_HappyPaths_IsValid(string connectionOpenKey, string connectio
                 new
                 {
                     OperationId = connectionOperationIdClosed,
-                    ConnectionId = connectionId,
-                    Connection = new
-                    {
-                        Database = dbName
-                    }
+                    ConnectionId = connectionId
                 }));
 
         // Assert
@@ -245,6 +241,7 @@ public void OnNext_HappyPaths_IsValid(string connectionOpenKey, string connectio
         Assert.Equal(query, commandSpan.Description);
         Assert.Equal(queryOperationId, commandSpan.Extra.TryGetValue<string, Guid>(SqlKeys.DbOperationId));
         Assert.Equal(connectionId, commandSpan.Extra.TryGetValue<string, Guid>(SqlKeys.DbConnectionId));
+        Assert.Equal(dbName, commandSpan.Extra.TryGetValue<string, string>(OTelKeys.DbName));
 
         Assert.Equal(dbName, connectionSpan.Description);
         Assert.Equal(connectionOperationId, connectionSpan.Extra.TryGetValue<string, Guid>(SqlKeys.DbOperationId));