[DBM] Add container tags hash to queries (if enabled)

tracer/src/Datadog.Trace/BaseHash.cs

@@ -0,0 +1,43 @@
+// <copyright file="BaseHash.cs" company="Datadog">
+// Unless explicitly stated otherwise all files in this repository are licensed under the Apache 2 License.
+// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2017 Datadog, Inc.
+// </copyright>
+
+#nullable enable
+
+using System;
+using System.Threading;
+using Datadog.Trace.PlatformHelpers;
+using Datadog.Trace.Util;
+
+namespace Datadog.Trace;
+
+/// <summary>
+/// This class is a container for the "base hash", a hash of process tags and container tags.
+/// Used by DBM to retrieve all the tag values from the spans, from just a single parameter (this hash),
+/// Used by DSM in the pathway to identify different sources that could have been service-remapped
+/// </summary>
+internal static class BaseHash
+{
+    /// <summary>
+    /// Gets the base64 representation of the hash
+    /// </summary>
+    public static string B64Value
+    {
+        get => Volatile.Read(ref field);
+        private set => Volatile.Write(ref field, value);
+    }
+
+        = Recompute(ProcessTags.SerializedTags, ContainerMetadata.Instance.ContainerTagsHash);
+
+    public static string Recompute(string processTags, string? containerTagsHash)
+    {
+        var hash = FnvHash64.GenerateHash(processTags, FnvHash64.Version.V1);
+        if (containerTagsHash != null)
+        {
+            hash = FnvHash64.GenerateHash(containerTagsHash, FnvHash64.Version.V1, hash);
+        }
+
+        return B64Value = Convert.ToBase64String(BitConverter.GetBytes(hash));
+    }
+}

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteNonQueryAsyncIntegration.cs

@@ -8,6 +8,7 @@
 using System.Data;
 using System.Threading;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -28,7 +29,7 @@ public sealed class CommandExecuteNonQueryAsyncIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance, CancellationToken cancellationToken)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteNonQueryIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -26,7 +27,7 @@ public sealed class CommandExecuteNonQueryIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteNonQueryWithBehaviorIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -28,7 +29,7 @@ public sealed class CommandExecuteNonQueryWithBehaviorIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget, TBehavior>(TTarget instance, TBehavior commandBehavior)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteReaderAsyncIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -26,7 +27,7 @@ public sealed class CommandExecuteReaderAsyncIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteReaderIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -26,7 +27,7 @@ public sealed class CommandExecuteReaderIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteReaderWithBehaviorAndCancellationAsyncIntegration.cs

@@ -8,6 +8,7 @@
 using System.Data;
 using System.Threading;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -31,7 +32,7 @@ public sealed class CommandExecuteReaderWithBehaviorAndCancellationAsyncIntegrat
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget, TBehavior>(TTarget instance, TBehavior commandBehavior, CancellationToken cancellationToken)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteReaderWithBehaviorAsyncIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -28,7 +29,7 @@ public sealed class CommandExecuteReaderWithBehaviorAsyncIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget, TBehavior>(TTarget instance, TBehavior commandBehavior)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteReaderWithBehaviorIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -29,7 +30,7 @@ public sealed class CommandExecuteReaderWithBehaviorIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget, TBehavior>(TTarget instance, TBehavior commandBehavior)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteReaderWithCancellationAsyncIntegration.cs

@@ -8,6 +8,7 @@
 using System.Data;
 using System.Threading;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -28,7 +29,7 @@ public sealed class CommandExecuteReaderWithCancellationAsyncIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance, CancellationToken cancellationToken)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteScalarAsyncIntegration.cs

@@ -8,6 +8,7 @@
 using System.Data;
 using System.Threading;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -28,7 +29,7 @@ public sealed class CommandExecuteScalarAsyncIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance, CancellationToken cancellationToken)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteScalarIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -26,7 +27,7 @@ public sealed class CommandExecuteScalarIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget>(TTarget instance)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/CommandExecuteScalarWithBehaviorIntegration.cs

@@ -7,6 +7,7 @@
 using System.ComponentModel;
 using System.Data;
 using Datadog.Trace.ClrProfiler.CallTarget;
+using Datadog.Trace.PlatformHelpers;
 
 namespace Datadog.Trace.ClrProfiler.AutoInstrumentation.AdoNet
 {
@@ -28,7 +29,7 @@ public sealed class CommandExecuteScalarWithBehaviorIntegration
         /// <returns>Calltarget state value</returns>
         internal static CallTargetState OnMethodBegin<TTarget, TBehavior>(TTarget instance, TBehavior commandBehavior)
         {
-            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance));
+            return new CallTargetState(DbScopeFactory.Cache<TTarget>.CreateDbCommandScope(Tracer.Instance, (IDbCommand)instance, BaseHash.B64Value));
         }
 
         /// <summary>

tracer/src/Datadog.Trace/ClrProfiler/AutoInstrumentation/AdoNet/DbScopeFactory.cs

@@ -14,6 +14,7 @@
 using Datadog.Trace.Configuration;
 using Datadog.Trace.DatabaseMonitoring;
 using Datadog.Trace.Logging;
+using Datadog.Trace.PlatformHelpers;
 using Datadog.Trace.Tagging;
 using Datadog.Trace.Util;
 
@@ -24,7 +25,7 @@ internal static class DbScopeFactory
         private static readonly IDatadogLogger Log = DatadogLogging.GetLoggerFor(typeof(DbScopeFactory));
         private static bool _dbCommandCachingLogged = false;
 
-        private static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command, IntegrationId integrationId, string dbType, string operationName, string serviceName, ref DbCommandCache.TagsCacheItem tagsFromConnectionString)
+        private static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command, IntegrationId integrationId, string dbType, string operationName, string serviceName, ref DbCommandCache.TagsCacheItem tagsFromConnectionString, string? baseHash)
         {
             var perTraceSettings = tracer.CurrentTraceSettings;
             if (!perTraceSettings.Settings.IsIntegrationEnabled(integrationId) || !perTraceSettings.Settings.IsIntegrationEnabled(IntegrationId.AdoNet))
@@ -102,9 +103,14 @@ internal static class DbScopeFactory
                     }
                     else
                     {
-                        // PropagateDataViaComment (service) - this injects varius trace information as a comment in the query
+                        if (tracer.Settings.DbmInjectSqlBasehash && !string.IsNullOrEmpty(baseHash))
+                        {
+                            tags.BaseHash = baseHash;
+                        }
+
+                        // PropagateDataViaComment (service) - this injects various trace information as a comment in the query
                         // PropagateDataViaContext (full)    - this makes a special set context_info for Microsoft SQL Server (nothing else supported)
-                        var traceParentInjectedInComment = DatabaseMonitoringPropagator.PropagateDataViaComment(tracer.Settings.DbmPropagationMode, integrationId, command, tracer.DefaultServiceName, tagsFromConnectionString.DbName, tagsFromConnectionString.OutHost, scope.Span, tracer.Settings.InjectContextIntoStoredProceduresEnabled);
+                        var traceParentInjectedInComment = DatabaseMonitoringPropagator.PropagateDataViaComment(tracer.Settings.DbmPropagationMode, integrationId, command, tracer.DefaultServiceName, tagsFromConnectionString.DbName, tagsFromConnectionString.OutHost, scope.Span, tracer.Settings.InjectContextIntoStoredProceduresEnabled, tracer.Settings.DbmInjectSqlBasehash ? baseHash : null);
                         // try context injection only after comment injection, so that if it fails, we still have service level propagation
                         var traceParentInjectedInContext = DatabaseMonitoringPropagator.PropagateDataViaContext(tracer.Settings.DbmPropagationMode, integrationId, command, scope.Span);
 
@@ -255,7 +261,7 @@ static Cache()
                 }
             }
 
-            public static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command)
+            public static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command, string? baseHash)
             {
                 var commandType = command.GetType();
 
@@ -271,7 +277,8 @@ static Cache()
                         dbType: DbTypeName,
                         operationName: OperationName,
                         serviceName: GetServiceName(tracer, DbTypeName),
-                        tagsFromConnectionString: ref tagsFromConnectionString);
+                        ref tagsFromConnectionString,
+                        baseHash);
                 }
 
                 // if command.GetType() != typeof(TCommand), we are probably instrumenting a method
@@ -287,7 +294,8 @@ static Cache()
                         dbType: dbTypeName,
                         operationName: operationName,
                         serviceName: GetServiceName(tracer, dbTypeName),
-                        tagsFromConnectionString: ref tagsFromConnectionString);
+                        ref tagsFromConnectionString,
+                        baseHash);
                 }
 
                 return null;

tracer/src/Datadog.Trace/Configuration/TracerSettings.cs

@@ -594,6 +594,10 @@ not null when string.Equals(value, "otlp", StringComparison.OrdinalIgnoreCase) =
                                      converter: x => ToDbmPropagationInput(x) ?? ParsingResult<DbmPropagationLevel>.Failure(),
                                      validator: null);
 
+            DbmInjectSqlBasehash = config
+                .WithKeys(ConfigurationKeys.DbmInjectSqlBasehash)
+                .AsBool(false);
+
             RemoteConfigurationEnabled = config.WithKeys(ConfigurationKeys.Rcm.RemoteConfigurationEnabled).AsBool(true);
 
             TraceId128BitGenerationEnabled = config
@@ -1200,6 +1204,12 @@ not null when string.Equals(value, "otlp", StringComparison.OrdinalIgnoreCase) =
         /// </summary>
         internal DbmPropagationLevel DbmPropagationMode { get; }
 
+        /// <summary>
+        /// Gets a value indicating whether the tracer should inject Base Hash in SQL Comments.
+        /// Default value is false (disabled).
+        /// </summary>
+        internal bool DbmInjectSqlBasehash { get; }
+
         /// <summary>
         /// Gets a value indicating whether the tracer will generate 128-bit trace ids
         /// instead of 64-bits trace ids.

tracer/src/Datadog.Trace/Configuration/supported-configurations.yaml

@@ -533,6 +533,15 @@ supportedConfigurations:
       Configuration key for setting DBM propagation mode
       Default value is disabled, expected values are either: disabled, service or full
       <seealso cref="Datadog.Trace.Configuration.TracerSettings.DbmPropagationMode"/>
+  DD_DBM_INJECT_SQL_BASEHASH:
+  - implementation: A
+    type: boolean
+    default: 'false'
+    const_name: DbmInjectSqlBasehash
+    documentation: |-
+      Configuration key for enabling or disabling the injection of Base Hash in SQL Comments.
+      Default value is false (disabled).
+      <seealso cref="Datadog.Trace.Configuration.TracerSettings.DbmInjectSqlBasehash"/>
   DD_DIAGNOSTIC_SOURCE_ENABLED:
   - implementation: A
     type: boolean

tracer/src/Datadog.Trace/DatabaseMonitoring/DatabaseMonitoringPropagator.cs

@@ -10,6 +10,7 @@
 using System.Threading;
 using Datadog.Trace.Configuration;
 using Datadog.Trace.Logging;
+using Datadog.Trace.PlatformHelpers;
 using Datadog.Trace.Propagators;
 using Datadog.Trace.Tagging;
 using Datadog.Trace.Util;
@@ -28,6 +29,7 @@ internal static class DatabaseMonitoringPropagator
         private const string SqlCommentOuthost = "ddh";
         private const string SqlCommentVersion = "ddpv";
         private const string SqlCommentEnv = "dde";
+        private const string SqlCommentBaseHash = "ddsh";
         internal const string DbmPrefix = $"/*{SqlCommentSpanService}='";
         private const string ContextInfoParameterName = "@dd_trace_context";
         internal const string SetContextCommand = $"set context_info {ContextInfoParameterName}";
@@ -41,7 +43,8 @@ internal static class DatabaseMonitoringPropagator
         private static int _remainingDirectionErrorLogs = 100;
         private static int _remainingQuoteErrorLogs = 100;
 
-        internal static bool PropagateDataViaComment(DbmPropagationLevel propagationLevel, IntegrationId integrationId, IDbCommand command, string configuredServiceName, string? dbName, string? outhost, Span span, bool injectStoredProcedure)
+        // baseHash should be null if hash injection is disabled, config is not checked in this method
+        internal static bool PropagateDataViaComment(DbmPropagationLevel propagationLevel, IntegrationId integrationId, IDbCommand command, string configuredServiceName, string? dbName, string? outhost, Span span, bool injectStoredProcedure, string? baseHash)
         {
             if (integrationId is not (IntegrationId.MySql or IntegrationId.Npgsql or IntegrationId.SqlClient or IntegrationId.Oracle) ||
                 propagationLevel is not (DbmPropagationLevel.Service or DbmPropagationLevel.Full))
@@ -103,6 +106,11 @@ propagationLevel is not (DbmPropagationLevel.Service or DbmPropagationLevel.Full
                 propagatorStringBuilder.Append(',').Append(SqlCommentVersion).Append("='").Append(Uri.EscapeDataString(versionTag)).Append('\'');
             }
 
+            if (!string.IsNullOrEmpty(baseHash))
+            {
+                propagatorStringBuilder.Append(',').Append(SqlCommentBaseHash).Append("='").Append(Uri.EscapeDataString(baseHash)).Append('\'');
+            }
+
             var traceParentInjected = false;
             // For SqlServer & Oracle we don't inject the traceparent to avoid affecting performance, since those DBs generate a new plan for any query changes
             if (propagationLevel == DbmPropagationLevel.Full