Integrate tracing configuration into MongoClientSettings

adelinowona · adelinowona · commit fc9f61ff4f1d · 2025-12-09T16:59:07.000-05:00
diff --git a/src/MongoDB.Driver/ClusterKey.cs b/src/MongoDB.Driver/ClusterKey.cs
@@ -42,6 +42,7 @@ internal sealed class ClusterKey
         private readonly bool _loadBalanced;
         private readonly TimeSpan _localThreshold;
         private readonly LoggingSettings _loggingSettings;
+        private readonly TracingOptions _tracingOptions;
         private readonly int _maxConnecting;
         private readonly TimeSpan _maxConnectionIdleTime;
         private readonly TimeSpan _maxConnectionLifeTime;
@@ -81,6 +82,7 @@ public ClusterKey(
             bool loadBalanced,
             TimeSpan localThreshold,
             LoggingSettings loggingSettings,
+            TracingOptions tracingOptions,
             int maxConnecting,
             TimeSpan maxConnectionIdleTime,
             TimeSpan maxConnectionLifeTime,
@@ -118,6 +120,7 @@ public ClusterKey(
             _loadBalanced = loadBalanced;
             _localThreshold = localThreshold;
             _loggingSettings = loggingSettings;
+            _tracingOptions = tracingOptions;
             _maxConnecting = maxConnecting;
             _maxConnectionIdleTime = maxConnectionIdleTime;
             _maxConnectionLifeTime = maxConnectionLifeTime;
@@ -159,6 +162,7 @@ public ClusterKey(
         public bool LoadBalanced => _loadBalanced;
         public TimeSpan LocalThreshold { get { return _localThreshold; } }
         public LoggingSettings LoggingSettings { get { return _loggingSettings; } }
+        public TracingOptions TracingOptions { get { return _tracingOptions; } }
         public int MaxConnecting{ get { return _maxConnecting; } }
         public TimeSpan MaxConnectionIdleTime { get { return _maxConnectionIdleTime; } }
         public TimeSpan MaxConnectionLifeTime { get { return _maxConnectionLifeTime; } }
diff --git a/src/MongoDB.Driver/ClusterRegistry.cs b/src/MongoDB.Driver/ClusterRegistry.cs
@@ -62,7 +62,8 @@ private IClusterInternal CreateCluster(ClusterKey clusterKey)
                 .ConfigureConnectionPool(settings => ConfigureConnectionPool(settings, clusterKey))
                 .ConfigureConnection(settings => ConfigureConnection(settings, clusterKey))
                 .ConfigureTcp(settings => ConfigureTcp(settings, clusterKey))
-                .ConfigureLoggingSettings(_ => clusterKey.LoggingSettings);
+                .ConfigureLoggingSettings(_ => clusterKey.LoggingSettings)
+                .ConfigureTracingOptions(_ => clusterKey.TracingOptions);
 #pragma warning restore CS0618 // Type or member is obsolete
 
             if (clusterKey.UseTls)
diff --git a/src/MongoDB.Driver/Core/Configuration/ClusterBuilder.cs b/src/MongoDB.Driver/Core/Configuration/ClusterBuilder.cs
@@ -36,6 +36,7 @@ public class ClusterBuilder
         private ConnectionPoolSettings _connectionPoolSettings;
         private ConnectionSettings _connectionSettings;
         private LoggingSettings _loggingSettings;
+        private TracingOptions _tracingOptions;
         private ServerSettings _serverSettings;
         private SslStreamSettings _sslStreamSettings;
         private Func<IStreamFactory, IStreamFactory> _streamFactoryWrapper;
@@ -123,6 +124,19 @@ public ClusterBuilder ConfigureLoggingSettings(Func<LoggingSettings, LoggingSett
             return this;
         }
 
+        /// <summary>
+        /// Configures the tracing options.
+        /// </summary>
+        /// <param name="configurator">The tracing options configurator delegate.</param>
+        /// <returns>A reconfigured cluster builder.</returns>
+        public ClusterBuilder ConfigureTracingOptions(Func<TracingOptions, TracingOptions> configurator)
+        {
+            Ensure.IsNotNull(configurator, nameof(configurator));
+
+            _tracingOptions = configurator(_tracingOptions);
+            return this;
+        }
+
         /// <summary>
         /// Configures the server settings.
         /// </summary>
@@ -228,6 +242,7 @@ private IConnectionPoolFactory CreateConnectionPoolFactory()
                 _eventAggregator,
                 _clusterSettings.ServerApi,
                 _loggingSettings.ToInternalLoggerFactory(),
+                _tracingOptions,
                 _tcpStreamSettings.ReadTimeout,
                 _tcpStreamSettings.WriteTimeout);
 
@@ -290,6 +305,7 @@ private IServerMonitorFactory CreateServerMonitorFactory()
                 new EventAggregator(),
                 _clusterSettings.ServerApi,
                 loggerFactory: null,
+                tracingOptions: new TracingOptions { Disabled = true },
                 _tcpStreamSettings.ReadTimeout,
                 _tcpStreamSettings.WriteTimeout);
 
diff --git a/src/MongoDB.Driver/MongoClient.cs b/src/MongoDB.Driver/MongoClient.cs
@@ -144,7 +144,7 @@ public ClientBulkWriteResult BulkWrite(IClientSessionHandle session, IReadOnlyLi
             Ensure.IsNotNull(session, nameof(session));
             ThrowIfDisposed();
             var operation = CreateClientBulkWriteOperation(models, options);
-            return ExecuteWriteOperation<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken);
+            return ExecuteWriteOperation<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken, "bulkWrite");
         }
 
         /// <inheritdoc/>
@@ -161,7 +161,7 @@ public Task<ClientBulkWriteResult> BulkWriteAsync(IClientSessionHandle session,
             Ensure.IsNotNull(session, nameof(session));
             ThrowIfDisposed();
             var operation = CreateClientBulkWriteOperation(models, options);
-            return ExecuteWriteOperationAsync<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken);
+            return ExecuteWriteOperationAsync<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken, "bulkWrite");
         }
 
         /// <inheritdoc/>
@@ -341,7 +341,7 @@ public IAsyncCursor<BsonDocument> ListDatabases(
             ThrowIfDisposed();
             Ensure.IsNotNull(session, nameof(session));
             var operation = CreateListDatabasesOperation(options);
-            return ExecuteReadOperation(session, operation, options?.Timeout, cancellationToken);
+            return ExecuteReadOperation(session, operation, options?.Timeout, cancellationToken, "listDatabases");
         }
 
         /// <inheritdoc/>
@@ -377,7 +377,7 @@ public Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(
             Ensure.IsNotNull(session, nameof(session));
             ThrowIfDisposed();
             var operation = CreateListDatabasesOperation(options);
-            return ExecuteReadOperationAsync(session, operation, options?.Timeout, cancellationToken);
+            return ExecuteReadOperationAsync(session, operation, options?.Timeout, cancellationToken, "listDatabases");
         }
 
         /// <inheritdoc/>
@@ -563,40 +563,51 @@ private ChangeStreamOperation<TResult> CreateChangeStreamOperation<TResult>(
                 _settings.RetryReads,
                 _settings.TranslationOptions);
 
-        private OperationContext CreateOperationContext(IClientSessionHandle session, TimeSpan? timeout, CancellationToken cancellationToken)
+        private OperationContext CreateOperationContext(IClientSessionHandle session, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)
         {
             var operationContext = session.WrappedCoreSession.CurrentTransaction?.OperationContext;
             if (operationContext != null && timeout != null)
             {
                 throw new InvalidOperationException("Cannot specify per operation timeout inside transaction.");
             }
 
-            return operationContext?.Fork() ?? new OperationContext(timeout ?? _settings.Timeout, cancellationToken);
+            var context = operationContext?.Fork() ?? new OperationContext(timeout ?? _settings.Timeout, cancellationToken);
+
+            // Set operation metadata for OpenTelemetry tracing
+            // Client-level operations (like bulkWrite) use "admin" as database name
+            if (operationName != null)
+            {
+                var tracingOptions = _settings.TracingOptions;
+                var isTracingEnabled = tracingOptions == null || !tracingOptions.Disabled;
+                context = context.WithOperationMetadata(operationName, "admin", null, isTracingEnabled);
+            }
+
+            return context;
         }
 
-        private TResult ExecuteReadOperation<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)
+        private TResult ExecuteReadOperation<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)
         {
             var readPreference = session.GetEffectiveReadPreference(_settings.ReadPreference);
-            using var operationContext = CreateOperationContext(session, timeout, cancellationToken);
+            using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);
             return _operationExecutor.ExecuteReadOperation(operationContext, session, operation, readPreference, false);
         }
 
-        private async Task<TResult> ExecuteReadOperationAsync<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)
+        private async Task<TResult> ExecuteReadOperationAsync<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)
         {
             var readPreference = session.GetEffectiveReadPreference(_settings.ReadPreference);
-            using var operationContext = CreateOperationContext(session, timeout, cancellationToken);
+            using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);
             return await _operationExecutor.ExecuteReadOperationAsync(operationContext, session, operation, readPreference, false).ConfigureAwait(false);
         }
 
-        private TResult ExecuteWriteOperation<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)
+        private TResult ExecuteWriteOperation<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)
         {
-            using var operationContext = CreateOperationContext(session, timeout, cancellationToken);
+            using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);
             return _operationExecutor.ExecuteWriteOperation(operationContext, session, operation, false);
         }
 
-        private async Task<TResult> ExecuteWriteOperationAsync<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)
+        private async Task<TResult> ExecuteWriteOperationAsync<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)
         {
-            using var operationContext = CreateOperationContext(session, timeout, cancellationToken);
+            using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);
             return await _operationExecutor.ExecuteWriteOperationAsync(operationContext, session, operation, false).ConfigureAwait(false);
         }
 
diff --git a/src/MongoDB.Driver/MongoClientSettings.cs b/src/MongoDB.Driver/MongoClientSettings.cs
@@ -76,6 +76,7 @@ public class MongoClientSettings : IEquatable<MongoClientSettings>, IInheritable
         private string _srvServiceName;
         private SslSettings _sslSettings;
         private TimeSpan? _timeout;
+        private TracingOptions _tracingOptions;
         private ExpressionTranslationOptions _translationOptions;
         private bool _useTls;
         private int _waitQueueSize;
@@ -367,6 +368,19 @@ public LoggingSettings LoggingSettings
             }
         }
 
+        /// <summary>
+        /// Gets or sets the tracing options for OpenTelemetry instrumentation.
+        /// </summary>
+        public TracingOptions TracingOptions
+        {
+            get { return _tracingOptions; }
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+                _tracingOptions = value;
+            }
+        }
+
         /// <summary>
         /// Gets or sets the maximum concurrently connecting connections.
         /// </summary>
@@ -952,6 +966,7 @@ public MongoClientSettings Clone()
             clone._loadBalanced = _loadBalanced;
             clone._localThreshold = _localThreshold;
             clone._loggingSettings = _loggingSettings;
+            clone._tracingOptions = _tracingOptions?.Clone();
             clone._maxConnecting = _maxConnecting;
             clone._maxConnectionIdleTime = _maxConnectionIdleTime;
             clone._maxConnectionLifeTime = _maxConnectionLifeTime;
@@ -1023,6 +1038,7 @@ public override bool Equals(object obj)
                 _loadBalanced == rhs._loadBalanced &&
                 _localThreshold == rhs._localThreshold &&
                 _loggingSettings == rhs._loggingSettings &&
+                object.Equals(_tracingOptions, rhs._tracingOptions) &&
                 _maxConnecting == rhs._maxConnecting &&
                 _maxConnectionIdleTime == rhs._maxConnectionIdleTime &&
                 _maxConnectionLifeTime == rhs._maxConnectionLifeTime &&
@@ -1258,6 +1274,7 @@ internal ClusterKey ToClusterKey()
                 _loadBalanced,
                 _localThreshold,
                 _loggingSettings,
+                _tracingOptions,
                 _maxConnecting,
                 _maxConnectionIdleTime,
                 _maxConnectionLifeTime,
diff --git a/tests/MongoDB.Driver.Tests/ClusterKeyTests.cs b/tests/MongoDB.Driver.Tests/ClusterKeyTests.cs
@@ -258,6 +258,7 @@ private ClusterKey CreateSubject(string notEqualFieldName = null)
                 loadBalanced,
                 localThreshold,
                 loggingSettings,
+                tracingOptions: null,
                 maxConnecting,
                 maxConnectionIdleTime,
                 maxConnectionLifeTime,
@@ -345,6 +346,7 @@ internal ClusterKey CreateSubjectWith(
                 loadBalanced,
                 localThreshold,
                 loggingSettings,
+                tracingOptions: null,
                 maxConnecting,
                 maxConnectionIdleTime,
                 maxConnectionLifeTime,
diff --git a/tests/MongoDB.Driver.Tests/ClusterRegistryTests.cs b/tests/MongoDB.Driver.Tests/ClusterRegistryTests.cs
@@ -128,6 +128,7 @@ public void GetOrCreateCluster_should_return_a_cluster_with_the_correct_settings
                 loadBalanced: false,
                 localThreshold: TimeSpan.FromSeconds(4),
                 loggingSettings: null,
+                tracingOptions: null,
                 maxConnecting: 3,
                 maxConnectionIdleTime: TimeSpan.FromSeconds(5),
                 maxConnectionLifeTime: TimeSpan.FromSeconds(6),

Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ public ClientBulkWriteResult BulkWrite(IClientSessionHandle session, IReadOnlyLi`
`144`	`144`	`Ensure.IsNotNull(session, nameof(session));`
`145`	`145`	`ThrowIfDisposed();`
`146`	`146`	`var operation = CreateClientBulkWriteOperation(models, options);`
`147`		`- return ExecuteWriteOperation<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken);`
	`147`	`+ return ExecuteWriteOperation<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken, "bulkWrite");`
`148`	`148`	`}`
`149`	`149`
`150`	`150`	`/// <inheritdoc/>`
`@@ -161,7 +161,7 @@ public Task<ClientBulkWriteResult> BulkWriteAsync(IClientSessionHandle session,`
`161`	`161`	`Ensure.IsNotNull(session, nameof(session));`
`162`	`162`	`ThrowIfDisposed();`
`163`	`163`	`var operation = CreateClientBulkWriteOperation(models, options);`
`164`		`- return ExecuteWriteOperationAsync<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken);`
	`164`	`+ return ExecuteWriteOperationAsync<ClientBulkWriteResult>(session, operation, options?.Timeout, cancellationToken, "bulkWrite");`
`165`	`165`	`}`
`166`	`166`
`167`	`167`	`/// <inheritdoc/>`
`@@ -341,7 +341,7 @@ public IAsyncCursor<BsonDocument> ListDatabases(`
`341`	`341`	`ThrowIfDisposed();`
`342`	`342`	`Ensure.IsNotNull(session, nameof(session));`
`343`	`343`	`var operation = CreateListDatabasesOperation(options);`
`344`		`- return ExecuteReadOperation(session, operation, options?.Timeout, cancellationToken);`
	`344`	`+ return ExecuteReadOperation(session, operation, options?.Timeout, cancellationToken, "listDatabases");`
`345`	`345`	`}`
`346`	`346`
`347`	`347`	`/// <inheritdoc/>`
`@@ -377,7 +377,7 @@ public Task<IAsyncCursor<BsonDocument>> ListDatabasesAsync(`
`377`	`377`	`Ensure.IsNotNull(session, nameof(session));`
`378`	`378`	`ThrowIfDisposed();`
`379`	`379`	`var operation = CreateListDatabasesOperation(options);`
`380`		`- return ExecuteReadOperationAsync(session, operation, options?.Timeout, cancellationToken);`
	`380`	`+ return ExecuteReadOperationAsync(session, operation, options?.Timeout, cancellationToken, "listDatabases");`
`381`	`381`	`}`
`382`	`382`
`383`	`383`	`/// <inheritdoc/>`
`@@ -563,40 +563,51 @@ private ChangeStreamOperation<TResult> CreateChangeStreamOperation<TResult>(`
`563`	`563`	`_settings.RetryReads,`
`564`	`564`	`_settings.TranslationOptions);`
`565`	`565`
`566`		`- private OperationContext CreateOperationContext(IClientSessionHandle session, TimeSpan? timeout, CancellationToken cancellationToken)`
	`566`	`+ private OperationContext CreateOperationContext(IClientSessionHandle session, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)`
`567`	`567`	`{`
`568`	`568`	`var operationContext = session.WrappedCoreSession.CurrentTransaction?.OperationContext;`
`569`	`569`	`if (operationContext != null && timeout != null)`
`570`	`570`	`{`
`571`	`571`	`throw new InvalidOperationException("Cannot specify per operation timeout inside transaction.");`
`572`	`572`	`}`
`573`	`573`
`574`		`- return operationContext?.Fork() ?? new OperationContext(timeout ?? _settings.Timeout, cancellationToken);`
	`574`	`+ var context = operationContext?.Fork() ?? new OperationContext(timeout ?? _settings.Timeout, cancellationToken);`
	`575`	`+`
	`576`	`+ // Set operation metadata for OpenTelemetry tracing`
	`577`	`+ // Client-level operations (like bulkWrite) use "admin" as database name`
	`578`	`+ if (operationName != null)`
	`579`	`+ {`
	`580`	`+ var tracingOptions = _settings.TracingOptions;`
	`581`	`+ var isTracingEnabled = tracingOptions == null \|\| !tracingOptions.Disabled;`
	`582`	`+ context = context.WithOperationMetadata(operationName, "admin", null, isTracingEnabled);`
	`583`	`+ }`
	`584`	`+`
	`585`	`+ return context;`
`575`	`586`	`}`
`576`	`587`
`577`		`- private TResult ExecuteReadOperation<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)`
	`588`	`+ private TResult ExecuteReadOperation<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)`
`578`	`589`	`{`
`579`	`590`	`var readPreference = session.GetEffectiveReadPreference(_settings.ReadPreference);`
`580`		`- using var operationContext = CreateOperationContext(session, timeout, cancellationToken);`
	`591`	`+ using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);`
`581`	`592`	`return _operationExecutor.ExecuteReadOperation(operationContext, session, operation, readPreference, false);`
`582`	`593`	`}`
`583`	`594`
`584`		`- private async Task<TResult> ExecuteReadOperationAsync<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)`
	`595`	`+ private async Task<TResult> ExecuteReadOperationAsync<TResult>(IClientSessionHandle session, IReadOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)`
`585`	`596`	`{`
`586`	`597`	`var readPreference = session.GetEffectiveReadPreference(_settings.ReadPreference);`
`587`		`- using var operationContext = CreateOperationContext(session, timeout, cancellationToken);`
	`598`	`+ using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);`
`588`	`599`	`return await _operationExecutor.ExecuteReadOperationAsync(operationContext, session, operation, readPreference, false).ConfigureAwait(false);`
`589`	`600`	`}`
`590`	`601`
`591`		`- private TResult ExecuteWriteOperation<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)`
	`602`	`+ private TResult ExecuteWriteOperation<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)`
`592`	`603`	`{`
`593`		`- using var operationContext = CreateOperationContext(session, timeout, cancellationToken);`
	`604`	`+ using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);`
`594`	`605`	`return _operationExecutor.ExecuteWriteOperation(operationContext, session, operation, false);`
`595`	`606`	`}`
`596`	`607`
`597`		`- private async Task<TResult> ExecuteWriteOperationAsync<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken)`
	`608`	`+ private async Task<TResult> ExecuteWriteOperationAsync<TResult>(IClientSessionHandle session, IWriteOperation<TResult> operation, TimeSpan? timeout, CancellationToken cancellationToken, string operationName = null)`
`598`	`609`	`{`
`599`		`- using var operationContext = CreateOperationContext(session, timeout, cancellationToken);`
	`610`	`+ using var operationContext = CreateOperationContext(session, timeout, cancellationToken, operationName);`
`600`	`611`	`return await _operationExecutor.ExecuteWriteOperationAsync(operationContext, session, operation, false).ConfigureAwait(false);`
`601`	`612`	`}`
`602`	`613`