Added TracingSettings

Updated MicrometerTracer NOOP to remove dependency on ObservationRegistry

Author: rozza

driver-core/src/main/com/mongodb/MongoClientSettings.java

@@ -30,11 +30,10 @@
 import com.mongodb.connection.SslSettings;
 import com.mongodb.connection.TransportSettings;
 import com.mongodb.event.CommandListener;
-import com.mongodb.internal.VisibleForTesting;
 import com.mongodb.lang.Nullable;
 import com.mongodb.spi.dns.DnsClient;
 import com.mongodb.spi.dns.InetAddressResolver;
-import io.micrometer.observation.ObservationRegistry;
+import com.mongodb.tracing.TracingSettings;
 import org.bson.UuidRepresentation;
 import org.bson.codecs.BsonCodecProvider;
 import org.bson.codecs.BsonValueCodecProvider;
@@ -59,7 +58,6 @@
 import static com.mongodb.assertions.Assertions.isTrueArgument;
 import static com.mongodb.assertions.Assertions.notNull;
 import static com.mongodb.internal.TimeoutSettings.convertAndValidateTimeout;
-import static com.mongodb.internal.VisibleForTesting.AccessModifier.PRIVATE;
 import static java.util.Arrays.asList;
 import static java.util.concurrent.TimeUnit.MILLISECONDS;
 import static org.bson.codecs.configuration.CodecRegistries.fromProviders;
@@ -119,18 +117,10 @@ public final class MongoClientSettings {
     private final ContextProvider contextProvider;
     private final DnsClient dnsClient;
     private final InetAddressResolver inetAddressResolver;
+    private final TracingSettings tracingSettings;
     @Nullable
     private final Long timeoutMS;
 
-    @VisibleForTesting(otherwise = PRIVATE)
-    // If set, this will enable/disable tracing even when an observationRegistry has been passed.
-    public static final String ENV_OTEL_ENABLED = "OTEL_JAVA_INSTRUMENTATION_MONGODB_ENABLED";
-    @VisibleForTesting(otherwise = PRIVATE)
-    // If set, this will truncate the command payload captured in the tracing span to the specified length.
-    public static final String ENV_OTEL_QUERY_TEXT_MAX_LENGTH = "OTEL_JAVA_INSTRUMENTATION_MONGODB_QUERY_TEXT_MAX_LENGTH";
-    private final ObservationRegistry observationRegistry;
-    private final boolean enableCommandPayloadTracing;
-
     /**
      * Gets the default codec registry.  It includes the following providers:
      *
@@ -235,6 +225,7 @@ public static final class Builder {
         private final ConnectionPoolSettings.Builder connectionPoolSettingsBuilder = ConnectionPoolSettings.builder();
         private final ServerSettings.Builder serverSettingsBuilder = ServerSettings.builder();
         private final SslSettings.Builder sslSettingsBuilder = SslSettings.builder();
+        private final TracingSettings.Builder tracingSettingsBuilder = TracingSettings.builder();
         private MongoCredential credential;
         private String applicationName;
         private List<MongoCompressor> compressorList = Collections.emptyList();
@@ -250,8 +241,6 @@ public static final class Builder {
         private ContextProvider contextProvider;
         private DnsClient dnsClient;
         private InetAddressResolver inetAddressResolver;
-        private ObservationRegistry observationRegistry;
-        private boolean enableCommandPayloadTracing;
 
         private Builder() {
         }
@@ -282,15 +271,14 @@ private Builder(final MongoClientSettings settings) {
             socketSettingsBuilder.applySettings(settings.getSocketSettings());
             connectionPoolSettingsBuilder.applySettings(settings.getConnectionPoolSettings());
             sslSettingsBuilder.applySettings(settings.getSslSettings());
+            tracingSettingsBuilder.applySettings(settings.getTracingSettings());
 
             if (settings.heartbeatConnectTimeoutSetExplicitly) {
                 heartbeatConnectTimeoutMS = settings.heartbeatSocketSettings.getConnectTimeout(MILLISECONDS);
             }
             if (settings.heartbeatSocketTimeoutSetExplicitly) {
                 heartbeatSocketTimeoutMS = settings.heartbeatSocketSettings.getReadTimeout(MILLISECONDS);
             }
-            observationRegistry = settings.observationRegistry;
-            enableCommandPayloadTracing = settings.enableCommandPayloadTracing;
         }
 
         /**
@@ -415,6 +403,18 @@ public Builder applyToSslSettings(final Block<SslSettings.Builder> block) {
             return this;
         }
 
+        /**
+         * Applies the {@link TracingSettings.Builder} block and then sets the tracingSettings.
+         *
+         * @param block the block to apply to the TracingSettings.
+         * @return this
+         * @see MongoClientSettings#getTracingSettings()
+         */
+        public Builder applyToTracingSettings(final Block<TracingSettings.Builder> block) {
+            notNull("block", block).apply(tracingSettingsBuilder);
+            return this;
+        }
+
         /**
          * Sets the read preference.
          *
@@ -739,47 +739,6 @@ Builder heartbeatSocketTimeoutMS(final int heartbeatSocketTimeoutMS) {
             return this;
         }
 
-        /**
-         * Sets the observation registry to use for creating tracing Spans for operations, commands and transactions.
-         *
-         * <p> If set the environment variable {@value ENV_OTEL_ENABLED} is used to enable or disable the creation of tracing spans.
-         *
-         * <p> If set the environment variable {@value ENV_OTEL_QUERY_TEXT_MAX_LENGTH} is used to determine the maximum length
-         * of command payloads captured in tracing spans. If the environment variable is not set, the entire command payloads is
-         * captured.
-         *
-         * @param observationRegistry the observation registry
-         * @return this
-         * @since 5.7
-         */
-        @Alpha(Reason.CLIENT)
-        public Builder observationRegistry(final ObservationRegistry observationRegistry) {
-            this.observationRegistry = observationRegistry;
-            return this;
-        }
-
-        /**
-         * Sets the observation registry to use for creating tracing Spans for operations, commands and transactions.
-         *
-         * <p> If set the environment variable {@value ENV_OTEL_ENABLED} is used to enable or disable the creation of tracing spans.
-         *
-         * <p> If set the environment variable {@value ENV_OTEL_QUERY_TEXT_MAX_LENGTH} is used to determine the maximum length
-         * of command payloads captured in tracing spans. If the environment variable is not set, the entire command payloads is
-         * captured.
-         *
-         * @param observationRegistry the observation registry
-         * @param enableCommandPayload whether command payloads should be captured in tracing spans. This may have performance
-         *                             implications so should be used with care.
-         * @return this
-         * @since 5.7
-         */
-        @Alpha(Reason.CLIENT)
-        public Builder observationRegistry(final ObservationRegistry observationRegistry, final boolean enableCommandPayload) {
-            this.observationRegistry = observationRegistry;
-            this.enableCommandPayloadTracing = enableCommandPayload;
-            return this;
-        }
-
         /**
          * Build an instance of {@code MongoClientSettings}.
          *
@@ -1097,25 +1056,14 @@ public ContextProvider getContextProvider() {
         return contextProvider;
     }
 
-    /** Get the ObservationRegistry to create tracing Spans for operations, commands and transactions.
+    /** Get the tracing settings.
      *
-     * @return the configured ObservationRegistry
+     * @return the configured TracingSettings
      * @since 5.7
      */
-    @Nullable
     @Alpha(Reason.CLIENT)
-    public ObservationRegistry getObservationRegistry() {
-        return observationRegistry;
-    }
-
-    /** Returns true if command payload tracing is enabled.
-     *
-     * @return the enableCommandPayloadTracing value
-     * @since 5.7
-     */
-    @Alpha(Reason.CLIENT)
-    public boolean isCommandPayloadTracingEnabled() {
-        return enableCommandPayloadTracing;
+    public TracingSettings getTracingSettings() {
+        return tracingSettings;
     }
 
     @Override
@@ -1215,6 +1163,7 @@ private MongoClientSettings(final Builder builder) {
         socketSettings = builder.socketSettingsBuilder.build();
         connectionPoolSettings = builder.connectionPoolSettingsBuilder.build();
         sslSettings = builder.sslSettingsBuilder.build();
+        tracingSettings = builder.tracingSettingsBuilder.build();
         compressorList = builder.compressorList;
         uuidRepresentation = builder.uuidRepresentation;
         serverApi = builder.serverApi;
@@ -1234,8 +1183,5 @@ private MongoClientSettings(final Builder builder) {
         heartbeatConnectTimeoutSetExplicitly = builder.heartbeatConnectTimeoutMS != 0;
         contextProvider = builder.contextProvider;
         timeoutMS = builder.timeoutMS;
-
-        observationRegistry = builder.observationRegistry;
-        enableCommandPayloadTracing = builder.enableCommandPayloadTracing;
     }
 }

driver-core/src/main/com/mongodb/internal/tracing/MicrometerTracer.java

@@ -31,11 +31,11 @@
 import java.io.PrintWriter;
 import java.io.StringWriter;
 
-import static com.mongodb.MongoClientSettings.ENV_OTEL_QUERY_TEXT_MAX_LENGTH;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.EXCEPTION_MESSAGE;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.EXCEPTION_STACKTRACE;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.EXCEPTION_TYPE;
 import static com.mongodb.internal.tracing.MongodbObservation.MONGODB_OBSERVATION;
+import static com.mongodb.tracing.TracingSettings.ENV_OTEL_QUERY_TEXT_MAX_LENGTH;
 import static java.lang.System.getenv;
 import static java.util.Optional.ofNullable;
 

driver-core/src/main/com/mongodb/internal/tracing/TracingManager.java

@@ -24,14 +24,14 @@
 import com.mongodb.internal.connection.OperationContext;
 import com.mongodb.internal.session.SessionContext;
 import com.mongodb.lang.Nullable;
+import com.mongodb.tracing.TracingSettings;
 import io.micrometer.common.KeyValues;
 import io.micrometer.observation.ObservationRegistry;
 import org.bson.BsonDocument;
 
 import java.util.function.Predicate;
 import java.util.function.Supplier;
 
-import static com.mongodb.MongoClientSettings.ENV_OTEL_ENABLED;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.CLIENT_CONNECTION_ID;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.COLLECTION;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.COMMAND_NAME;
@@ -45,6 +45,7 @@
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.SESSION_ID;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.SYSTEM;
 import static com.mongodb.internal.tracing.MongodbObservation.LowCardinalityKeyNames.TRANSACTION_NUMBER;
+import static com.mongodb.tracing.TracingSettings.ENV_OTEL_ENABLED;
 import static java.lang.System.getenv;
 
 /**
@@ -58,24 +59,24 @@ public class TracingManager {
     /**
      * A no-op instance of the TracingManager used when tracing is disabled.
      */
-    public static final TracingManager NO_OP = new TracingManager(ObservationRegistry.NOOP, false);
+    public static final TracingManager NO_OP = new TracingManager(TracingSettings.builder().build());
     private final Tracer tracer;
     private final boolean enableCommandPayload;
 
     /**
      * Constructs a new TracingManager with the specified observation registry.
      *
-     * @param observationRegistry The observation registry to use for tracing operations, may be null.
-     * @param enableCommandPayload Whether to enable command payload tracing.
+     * @param settings The tracing settings
      */
-    public TracingManager(@Nullable final ObservationRegistry observationRegistry, final boolean enableCommandPayload) {
+    public TracingManager(final TracingSettings settings) {
         String envOtelInstrumentationEnabled = getenv(ENV_OTEL_ENABLED);
         boolean enableTracing = true;
         if (envOtelInstrumentationEnabled != null) {
             enableTracing = Boolean.parseBoolean(envOtelInstrumentationEnabled);
         }
+        ObservationRegistry observationRegistry = settings.getObservationRegistry();
         tracer = (observationRegistry == null) ? Tracer.NO_OP
-                : (enableTracing) ? new MicrometerTracer(observationRegistry, enableCommandPayload)
+                : (enableTracing) ? new MicrometerTracer(observationRegistry, settings.isEnableCommandPayloadTracing())
                 : Tracer.NO_OP;
 
         this.enableCommandPayload = tracer.includeCommandPayload();