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

tracer/src/Datadog.Trace.Tools.Runner/Utils.cs

@@ -422,6 +422,7 @@ public static async Task<AgentConfiguration> CheckAgentConnectionAsync(string ag
             var discoveryService = DiscoveryService.CreateUnmanaged(
                 settings.Manager.InitialExporterSettings,
                 ContainerMetadata.Instance,
+                new ServiceRemappingHash(null),
                 tcpTimeout: TimeSpan.FromSeconds(5),
                 initialRetryDelayMs: 200,
                 maxRetryDelayMs: 1000,

tracer/src/Datadog.Trace/Agent/DiscoveryService/DiscoveryService.cs

@@ -47,7 +47,7 @@ internal sealed class DiscoveryService : IDiscoveryService
         private readonly object _lock = new();
         private readonly Task _discoveryTask;
         private readonly IDisposable? _settingSubscription;
-        private readonly ContainerMetadata _containerMetadata;
+        private readonly ServiceRemappingHash _serviceRemappingHash;
         private IApiRequestFactory _apiRequestFactory;
         private AgentConfiguration? _configuration;
         private string? _configurationHash;
@@ -57,11 +57,12 @@ internal sealed class DiscoveryService : IDiscoveryService
         public DiscoveryService(
             TracerSettings.SettingsManager settings,
             ContainerMetadata containerMetadata,
+            ServiceRemappingHash serviceRemappingHash,
             TimeSpan tcpTimeout,
             int initialRetryDelayMs,
             int maxRetryDelayMs,
             int recheckIntervalMs)
-            : this(CreateApiRequestFactory(settings.InitialExporterSettings, containerMetadata.ContainerId, tcpTimeout), containerMetadata, initialRetryDelayMs, maxRetryDelayMs, recheckIntervalMs)
+            : this(CreateApiRequestFactory(settings.InitialExporterSettings, containerMetadata.ContainerId, tcpTimeout), serviceRemappingHash, initialRetryDelayMs, maxRetryDelayMs, recheckIntervalMs)
         {
             // Create as a "managed" service that can update the request factory
             _settingSubscription = settings.SubscribeToChanges(changes =>
@@ -80,13 +81,13 @@ public DiscoveryService(
         /// </summary>
         public DiscoveryService(
             IApiRequestFactory apiRequestFactory,
-            ContainerMetadata containerMetadata,
+            ServiceRemappingHash serviceRemappingHash,
             int initialRetryDelayMs,
             int maxRetryDelayMs,
             int recheckIntervalMs)
         {
             _apiRequestFactory = apiRequestFactory;
-            _containerMetadata = containerMetadata;
+            _serviceRemappingHash = serviceRemappingHash;
             _initialRetryDelayMs = initialRetryDelayMs;
             _maxRetryDelayMs = maxRetryDelayMs;
             _recheckIntervalMs = recheckIntervalMs;
@@ -119,10 +120,11 @@ public DiscoveryService(
         /// <summary>
         /// Create a <see cref="DiscoveryService"/> instance that responds to runtime changes in settings
         /// </summary>
-        public static DiscoveryService CreateManaged(TracerSettings settings, ContainerMetadata containerMetadata)
+        public static DiscoveryService CreateManaged(TracerSettings settings, ContainerMetadata containerMetadata, ServiceRemappingHash serviceRemappingHash)
             => new(
                 settings.Manager,
                 containerMetadata,
+                serviceRemappingHash,
                 tcpTimeout: TimeSpan.FromSeconds(15),
                 initialRetryDelayMs: 500,
                 maxRetryDelayMs: 5_000,
@@ -131,10 +133,11 @@ public static DiscoveryService CreateManaged(TracerSettings settings, ContainerM
         /// <summary>
         /// Create a <see cref="DiscoveryService"/> instance that does _not_ respond to runtime changes in settings
         /// </summary>
-        public static DiscoveryService CreateUnmanaged(ExporterSettings exporterSettings, ContainerMetadata containerMetadata)
+        public static DiscoveryService CreateUnmanaged(ExporterSettings exporterSettings, ContainerMetadata containerMetadata, ServiceRemappingHash serviceRemappingHash)
             => CreateUnmanaged(
                 exporterSettings,
                 containerMetadata,
+                serviceRemappingHash,
                 tcpTimeout: TimeSpan.FromSeconds(15),
                 initialRetryDelayMs: 500,
                 maxRetryDelayMs: 5_000,
@@ -146,13 +149,14 @@ public static DiscoveryService CreateUnmanaged(ExporterSettings exporterSettings
         public static DiscoveryService CreateUnmanaged(
             ExporterSettings exporterSettings,
             ContainerMetadata containerMetadata,
+            ServiceRemappingHash serviceRemappingHash,
             TimeSpan tcpTimeout,
             int initialRetryDelayMs,
             int maxRetryDelayMs,
             int recheckIntervalMs)
             => new(
                 CreateApiRequestFactory(exporterSettings, containerMetadata.ContainerId, tcpTimeout),
-                containerMetadata,
+                serviceRemappingHash,
                 initialRetryDelayMs,
                 maxRetryDelayMs,
                 recheckIntervalMs);
@@ -310,7 +314,7 @@ private async Task ProcessDiscoveryResponse(IApiResponse response)
             var containerTagsHash = response.GetHeader(AgentHttpHeaderNames.ContainerTagsHash);
             if (containerTagsHash != null)
             {
-                _containerMetadata.ContainerTagsHash = containerTagsHash;
+                _serviceRemappingHash.UpdateContainerTagsHash(containerTagsHash);
             }
 
             // Grab the original stream
@@ -429,7 +433,7 @@ private async Task ProcessDiscoveryResponse(IApiResponse response)
                 eventPlatformProxyEndpoint: eventPlatformProxyEndpoint,
                 telemetryProxyEndpoint: telemetryProxyEndpoint,
                 tracerFlareEndpoint: tracerFlareEndpoint,
-                containerTagsHash: _containerMetadata.ContainerTagsHash, // either the value just received, or the one we stored before (prevents overriding with null)
+                containerTagsHash: _serviceRemappingHash.ContainerTagsHash, // either the value just received, or the one we stored before (prevents overriding with null)
                 clientDropP0: clientDropP0,
                 spanMetaStructs: spanMetaStructs,
                 spanEvents: spanEvents);

tracer/src/Datadog.Trace/Ci/TestOptimization.cs

@@ -250,6 +250,7 @@ public void Initialize()
             getDiscoveryServiceFunc: static s => DiscoveryService.CreateUnmanaged(
                 s.TracerSettings.Manager.InitialExporterSettings,
                 ContainerMetadata.Instance,
+                new ServiceRemappingHash(null),
                 tcpTimeout: TimeSpan.FromSeconds(5),
                 initialRetryDelayMs: 100,
                 maxRetryDelayMs: 1000,

tracer/src/Datadog.Trace/Ci/TestOptimizationTracerManager.cs

@@ -47,7 +47,8 @@ public TestOptimizationTracerManager(
             IDynamicConfigurationManager dynamicConfigurationManager,
             ITracerFlareManager tracerFlareManager,
             ISpanEventsManager spanEventsManager,
-            FeatureFlagsModule featureFlags)
+            FeatureFlagsModule featureFlags,
+            ServiceRemappingHash serviceRemappingHash)
             : base(
                 settings,
                 agentWriter,
@@ -66,6 +67,7 @@ public TestOptimizationTracerManager(
                 tracerFlareManager,
                 spanEventsManager,
                 featureFlags,
+                serviceRemappingHash,
                 GetProcessors(settings.PartialFlushEnabled, agentWriter is CIVisibilityProtocolWriter))
         {
         }
@@ -165,7 +167,8 @@ public LockedManager(
                 IDynamicConfigurationManager dynamicConfigurationManager,
                 ITracerFlareManager tracerFlareManager,
                 ISpanEventsManager spanEventsManager,
-                FeatureFlagsModule featureFlags)
+                FeatureFlagsModule featureFlags,
+                ServiceRemappingHash serviceRemappingHash)
             : base(
                 settings,
                 agentWriter,
@@ -183,7 +186,8 @@ public LockedManager(
                 dynamicConfigurationManager,
                 tracerFlareManager,
                 spanEventsManager,
-                featureFlags)
+                featureFlags,
+                serviceRemappingHash)
             {
             }
         }

tracer/src/Datadog.Trace/Ci/TestOptimizationTracerManagerFactory.cs

@@ -56,15 +56,16 @@ protected override TracerManager CreateTracerManagerFrom(
             IDynamicConfigurationManager dynamicConfigurationManager,
             ITracerFlareManager tracerFlareManager,
             ISpanEventsManager spanEventsManager,
-            FeatureFlagsModule featureFlags)
+            FeatureFlagsModule featureFlags,
+            ServiceRemappingHash serviceRemappingHash)
         {
             telemetry.RecordTestOptimizationSettings(_settings);
             if (_testOptimizationTracerManagement.UseLockedTracerManager)
             {
-                return new TestOptimizationTracerManager.LockedManager(settings, agentWriter, scopeManager, statsd, runtimeMetrics, logSubmissionManager, telemetry, discoveryService, dataStreamsManager, gitMetadataTagsProvider, traceSampler, spanSampler, remoteConfigurationManager, dynamicConfigurationManager, tracerFlareManager, spanEventsManager, featureFlags);
+                return new TestOptimizationTracerManager.LockedManager(settings, agentWriter, scopeManager, statsd, runtimeMetrics, logSubmissionManager, telemetry, discoveryService, dataStreamsManager, gitMetadataTagsProvider, traceSampler, spanSampler, remoteConfigurationManager, dynamicConfigurationManager, tracerFlareManager, spanEventsManager, featureFlags, serviceRemappingHash);
             }
 
-            return new TestOptimizationTracerManager(settings, agentWriter, scopeManager, statsd, runtimeMetrics, logSubmissionManager, telemetry, discoveryService, dataStreamsManager, gitMetadataTagsProvider, traceSampler, spanSampler, remoteConfigurationManager, dynamicConfigurationManager, tracerFlareManager, spanEventsManager, featureFlags);
+            return new TestOptimizationTracerManager(settings, agentWriter, scopeManager, statsd, runtimeMetrics, logSubmissionManager, telemetry, discoveryService, dataStreamsManager, gitMetadataTagsProvider, traceSampler, spanSampler, remoteConfigurationManager, dynamicConfigurationManager, tracerFlareManager, spanEventsManager, featureFlags, serviceRemappingHash);
         }
 
         protected override TelemetrySettings CreateTelemetrySettings(TracerSettings settings)
@@ -116,7 +117,7 @@ protected override IAgentWriter GetAgentWriter(TracerSettings settings, IStatsdM
             return new ApmAgentWriter(settings, updateSampleRates, updateConfigHash, discoveryService, traceBufferSize);
         }
 
-        internal override IDiscoveryService GetDiscoveryService(TracerSettings settings)
+        internal override IDiscoveryService GetDiscoveryService(TracerSettings settings, ServiceRemappingHash serviceRemappingHash)
             => _testOptimizationTracerManagement.DiscoveryService;
     }
 }

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

@@ -25,7 +25,7 @@ internal static class DbScopeFactory
         private static readonly IDatadogLogger Log = DatadogLogging.GetLoggerFor(typeof(DbScopeFactory));
         private static bool _dbCommandCachingLogged;
 
-        private static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command, IntegrationId integrationId, string dbType, string operationName, string serviceName, string? serviceNameSource, ref DbCommandCache.TagsCacheItem tagsFromConnectionString)
+        private static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command, IntegrationId integrationId, string dbType, string operationName, string serviceName, string? serviceNameSource, string? baseHash, ref DbCommandCache.TagsCacheItem tagsFromConnectionString)
         {
             var perTraceSettings = tracer.CurrentTraceSettings;
             if (!perTraceSettings.Settings.IsIntegrationEnabled(integrationId) || !perTraceSettings.Settings.IsIntegrationEnabled(IntegrationId.AdoNet))
@@ -103,9 +103,15 @@ internal static class DbScopeFactory
                     }
                     else
                     {
-                        // PropagateDataViaComment (service) - this injects varius trace information as a comment in the query
+                        if (baseHash != null)
+                        {
+                            // note: it's ok that we don't write the basehash in the span if "alreadyInjected" because we only need one span to get the tag values
+                            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, baseHash);
                         // 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);
 
@@ -259,6 +265,9 @@ static Cache()
             public static Scope? CreateDbCommandScope(Tracer tracer, IDbCommand command)
             {
                 var commandType = command.GetType();
+                var baseHash = tracer.Settings.PropagateProcessTags && tracer.Settings.DbmInjectSqlBasehash
+                                   ? tracer.TracerManager.ServiceRemappingHash?.Base64Value
+                                   : null; // null if disabled
 
                 if (commandType == CommandType && DbTypeName is not null && OperationName is not null)
                 {
@@ -274,6 +283,7 @@ static Cache()
                         operationName: OperationName,
                         serviceName: cachedServiceName,
                         serviceNameSource: cachedServiceNameSource,
+                        baseHash: baseHash,
                         tagsFromConnectionString: ref tagsFromConnectionString);
                 }
 
@@ -292,6 +302,7 @@ static Cache()
                         operationName: operationName,
                         serviceName: resolvedServiceName,
                         serviceNameSource: resolvedServiceNameSource,
+                        baseHash: baseHash,
                         tagsFromConnectionString: ref tagsFromConnectionString);
                 }
 

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

@@ -629,6 +629,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
@@ -1243,6 +1247,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

tracer/src/Datadog.Trace/Generated/net461/Datadog.Trace.SourceGenerators/ConfigurationKeysGenerator/ConfigurationKeys.g.cs

@@ -71,6 +71,13 @@ internal static partial class ConfigurationKeys
     /// </summary>
     public const string ApplicationMonitoringConfigFileEnabled = "DD_APPLICATION_MONITORING_CONFIG_FILE_ENABLED";
 
+    /// <summary>
+    /// Configuration key for enabling or disabling the injection of Base Hash in SQL Comments.
+    /// Default value is false (disabled).
+    /// </summary>
+    /// <seealso cref="Datadog.Trace.Configuration.TracerSettings.DbmInjectSqlBasehash"/>
+    public const string DbmInjectSqlBasehash = "DD_DBM_INJECT_SQL_BASEHASH";
+
     /// <summary>
     /// Configuration key for setting DBM propagation mode
     /// Default value is disabled, expected values are either: disabled, service or full