Add db.name to custom properties (Azure#36389)

* add db.name to custom properties

* refactor

* fix build

* address pr comments

* test

* fix test

* use tuple as return type

Author: vishweshbankwar

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Customizations/Models/RemoteDependencyData.cs

@@ -17,6 +17,9 @@ internal partial class RemoteDependencyData
 
         public RemoteDependencyData(int version, Activity activity, ref ActivityTagsProcessor activityTagsProcessor) : base(version)
         {
+            Properties = new ChangeTrackingDictionary<string, string>();
+            Measurements = new ChangeTrackingDictionary<string, double>();
+
             string? httpUrl = null;
             string dependencyName;
 
@@ -50,7 +53,15 @@ public RemoteDependencyData(int version, Activity activity, ref ActivityTagsProc
                 case OperationType.Db:
                     var depDataAndType = AzMonList.GetTagValues(ref activityTagsProcessor.MappedTags, SemanticConventions.AttributeDbStatement, SemanticConventions.AttributeDbSystem);
                     Data = depDataAndType[0]?.ToString().Truncate(SchemaConstants.RemoteDependencyData_Data_MaxLength);
-                    Target = activityTagsProcessor.MappedTags.GetDbDependencyTarget().Truncate(SchemaConstants.RemoteDependencyData_Target_MaxLength);
+                    var dbNameAndTarget = activityTagsProcessor.MappedTags.GetDbDependencyTargetAndName();
+                    Target = dbNameAndTarget.DbTarget.Truncate(SchemaConstants.RemoteDependencyData_Target_MaxLength);
+
+                    // special case for db.name
+                    var sanitizedDbName = dbNameAndTarget.DbName.Truncate(SchemaConstants.KVP_MaxValueLength);
+                    if (sanitizedDbName != null)
+                    {
+                        Properties.Add(SemanticConventions.AttributeDbName, sanitizedDbName);
+                    }
                     Type = s_sqlDbs.Contains(depDataAndType[1]?.ToString()) ? "SQL" : depDataAndType[1]?.ToString().Truncate(SchemaConstants.RemoteDependencyData_Type_MaxLength);
                     break;
                 case OperationType.Rpc:
@@ -84,9 +95,6 @@ public RemoteDependencyData(int version, Activity activity, ref ActivityTagsProc
                 Type = "InProc";
             }
 
-            Properties = new ChangeTrackingDictionary<string, string>();
-            Measurements = new ChangeTrackingDictionary<string, double>();
-
             TraceHelper.AddActivityLinksToProperties(activity, ref activityTagsProcessor.UnMappedTags);
             TraceHelper.AddPropertiesToTelemetry(Properties, ref activityTagsProcessor.UnMappedTags);
         }

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/src/Internals/AzMonListExtensions.cs

@@ -287,9 +287,9 @@ internal static string GetDefaultDbPort(string? dbSystem)
         }
 
         ///<summary>
-        /// Gets Database dependency target from activity tag objects.
+        /// Gets Database dependency target and name from activity tag objects.
         ///</summary>
-        internal static string? GetDbDependencyTarget(this AzMonList tagObjects)
+        internal static (string? DbName, string? DbTarget) GetDbDependencyTargetAndName(this AzMonList tagObjects)
         {
             string? target = null;
             string defaultPort = GetDefaultDbPort(AzMonList.GetTagValue(ref tagObjects, SemanticConventions.AttributeDbSystem)?.ToString());
@@ -303,7 +303,7 @@ internal static string GetDefaultDbPort(string? dbSystem)
                 target = tagObjects.GetTargetUsingNetPeerAttributes(defaultPort);
             }
 
-            string? dbName = AzMonList.GetTagValue(ref tagObjects, SemanticConventions.AttributeDbName)?.ToString();
+            var dbName = AzMonList.GetTagValue(ref tagObjects, SemanticConventions.AttributeDbName)?.ToString();
             bool isTargetEmpty = string.IsNullOrWhiteSpace(target);
             bool isDbNameEmpty = string.IsNullOrWhiteSpace(dbName);
             if (!isTargetEmpty && !isDbNameEmpty)
@@ -319,7 +319,7 @@ internal static string GetDefaultDbPort(string? dbSystem)
                 target = AzMonList.GetTagValue(ref tagObjects, SemanticConventions.AttributeDbSystem)?.ToString();
             }
 
-            return target;
+            return (DbName: dbName, DbTarget: target);
         }
 
         ///<summary>
@@ -332,7 +332,7 @@ internal static string GetDefaultDbPort(string? dbSystem)
                 case OperationType.Http:
                     return tagObjects.GetHttpDependencyTarget();
                 case OperationType.Db:
-                    return tagObjects.GetDbDependencyTarget();
+                    return tagObjects.GetDbDependencyTargetAndName().DbTarget;
                 default:
                     return null;
             }

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/AzMonListExtensionsTests.cs

@@ -574,34 +574,30 @@ public void DbNameIsAppendedToTargetDerivedFromNetAttributesforDBDependencyTarge
                 hostName = $"{netPeerIp}:{netPeerPort}";
             }
             string expectedTarget = $"{hostName} | DbName";
-            string? target = mappedTags.GetDbDependencyTarget();
-            Assert.Equal(expectedTarget, target);
+            Assert.Equal(expectedTarget, mappedTags.GetDbDependencyTargetAndName().DbTarget);
         }
 
         [Fact]
         public void DbDependencyTargetIsSetToDbNameWhenNetAttributesAreNotPresent()
         {
             var mappedTags = AzMonList.Initialize();
             AzMonList.Add(ref mappedTags, new KeyValuePair<string, object?>(SemanticConventions.AttributeDbName, "DbName"));
-            string? target = mappedTags.GetDbDependencyTarget();
-            Assert.Equal("DbName", target);
+            Assert.Equal("DbName", mappedTags.GetDbDependencyTargetAndName().DbTarget);
         }
 
         [Fact]
         public void DbDependencyTargetIsSetToDbSystemWhenNetAndDbNameAttributesAreNotPresent()
         {
             var mappedTags = AzMonList.Initialize();
             AzMonList.Add(ref mappedTags, new KeyValuePair<string, object?>(SemanticConventions.AttributeDbSystem, "DbSystem"));
-            string? target = mappedTags.GetDbDependencyTarget();
-            Assert.Equal("DbSystem", target);
+            Assert.Equal("DbSystem", mappedTags.GetDbDependencyTargetAndName().DbTarget);
         }
 
         [Fact]
         public void DbDependencyTargetIsSetToNullByDefault()
         {
             var mappedTags = AzMonList.Initialize();
-            string? target = mappedTags.GetDbDependencyTarget();
-            Assert.Null(target);
+            Assert.Null(mappedTags.GetDbDependencyTargetAndName().DbTarget);
         }
     }
 }

sdk/monitor/Azure.Monitor.OpenTelemetry.Exporter/tests/Azure.Monitor.OpenTelemetry.Exporter.Tests/RemoteDependencyDataTests.cs

@@ -2,6 +2,7 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.Globalization;
 
@@ -134,6 +135,7 @@ public void ValidateDbRemoteDependencyData()
             activity.Stop();
 
             activity.SetStatus(Status.Ok);
+            activity.SetTag(SemanticConventions.AttributeDbName, "mysqlserver");
             activity.SetTag(SemanticConventions.AttributeDbSystem, "mssql");
             activity.SetTag(SemanticConventions.AttributePeerService, "localhost"); // only adding test via peer.service. all possible combinations are covered in AzMonListExtensionsTests.
             activity.SetTag(SemanticConventions.AttributeDbStatement, "Select * from table");
@@ -145,10 +147,12 @@ public void ValidateDbRemoteDependencyData()
             Assert.Equal(ActivityName, remoteDependencyData.Name);
             Assert.Equal(activity.Context.SpanId.ToHexString(), remoteDependencyData.Id);
             Assert.Equal("Select * from table", remoteDependencyData.Data);
+            Assert.Equal("localhost | mysqlserver", remoteDependencyData.Target);
             Assert.Null(remoteDependencyData.ResultCode);
             Assert.Equal(activity.Duration.ToString("c", CultureInfo.InvariantCulture), remoteDependencyData.Duration);
             Assert.Equal(activity.GetStatus() != Status.Error, remoteDependencyData.Success);
-            Assert.True(remoteDependencyData.Properties.Count == 0);
+            Assert.True(remoteDependencyData.Properties.Count == 1);
+            Assert.True(remoteDependencyData.Properties.Contains(new KeyValuePair<string, string>(SemanticConventions.AttributeDbName, "mysqlserver" )));
             Assert.True(remoteDependencyData.Measurements.Count == 0);
         }