Provide fallback for Observation KeyValues

Closes: #5020

Author: jonatan-ivanov

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/observability/DefaultMongoHandlerObservationConvention.java

@@ -15,20 +15,16 @@
  */
 package org.springframework.data.mongodb.observability;
 
-import io.micrometer.common.KeyValue;
-import io.micrometer.common.KeyValues;
-
-import java.net.InetSocketAddress;
-
-import org.springframework.data.mongodb.observability.MongoObservation.LowCardinalityCommandKeyNames;
-import org.springframework.data.mongodb.util.MongoCompatibilityAdapter;
-import org.springframework.util.ObjectUtils;
-
 import com.mongodb.ConnectionString;
 import com.mongodb.ServerAddress;
 import com.mongodb.connection.ConnectionDescription;
 import com.mongodb.connection.ConnectionId;
 import com.mongodb.event.CommandStartedEvent;
+import io.micrometer.common.KeyValues;
+import org.springframework.util.Assert;
+import org.springframework.util.ObjectUtils;
+
+import static org.springframework.data.mongodb.observability.MongoObservation.LowCardinalityCommandKeyNames.*;
 
 /**
  * Default {@link MongoHandlerObservationConvention} implementation.
@@ -43,60 +39,43 @@ class DefaultMongoHandlerObservationConvention implements MongoHandlerObservatio
 	@Override
 	public KeyValues getLowCardinalityKeyValues(MongoHandlerContext context) {
 
-		KeyValues keyValues = KeyValues.of(LowCardinalityCommandKeyNames.DB_SYSTEM.withValue("mongodb"),
-				LowCardinalityCommandKeyNames.MONGODB_COMMAND.withValue(context.getCommandName()));
-
-		ConnectionString connectionString = context.getConnectionString();
-		if (connectionString != null) {
-
-			keyValues = keyValues
-					.and(LowCardinalityCommandKeyNames.DB_CONNECTION_STRING.withValue(connectionString.getConnectionString()));
-
-			String user = connectionString.getUsername();
-
-			if (!ObjectUtils.isEmpty(user)) {
-				keyValues = keyValues.and(LowCardinalityCommandKeyNames.DB_USER.withValue(user));
-			}
-		}
-
-		if (!ObjectUtils.isEmpty(context.getDatabaseName())) {
-			keyValues = keyValues.and(LowCardinalityCommandKeyNames.DB_NAME.withValue(context.getDatabaseName()));
+		if (context.getCommandStartedEvent() == null) {
+			throw new IllegalStateException("not command started event present");
 		}
 
-		keyValues = keyValues.and(LowCardinalityCommandKeyNames.MONGODB_COLLECTION.withValue(
-				ObjectUtils.isEmpty(context.getCollectionName()) ? KeyValue.NONE_VALUE : context.getCollectionName()));
+		ConnectionString connectionString = context.getConnectionString();
+		String connectionStringValue = connectionString != null ? connectionString.getConnectionString() : null;
+		String username = connectionString != null ? connectionString.getUsername() : null;
 
+		String transport = null,  peerName = null, peerPort =null,  clusterId = null;
 		ConnectionDescription connectionDescription = context.getCommandStartedEvent().getConnectionDescription();
-
 		if (connectionDescription != null) {
-
 			ServerAddress serverAddress = connectionDescription.getServerAddress();
 
 			if (serverAddress != null) {
-
-				keyValues = keyValues.and(LowCardinalityCommandKeyNames.NET_TRANSPORT.withValue("IP.TCP"),
-						LowCardinalityCommandKeyNames.NET_PEER_NAME.withValue(serverAddress.getHost()),
-						LowCardinalityCommandKeyNames.NET_PEER_PORT.withValue("" + serverAddress.getPort()));
-
-				InetSocketAddress socketAddress = MongoCompatibilityAdapter.serverAddressAdapter(serverAddress)
-						.getSocketAddress();
-
-				if (socketAddress != null) {
-
-					keyValues = keyValues.and(
-							LowCardinalityCommandKeyNames.NET_SOCK_PEER_ADDR.withValue(socketAddress.getHostName()),
-							LowCardinalityCommandKeyNames.NET_SOCK_PEER_PORT.withValue("" + socketAddress.getPort()));
-				}
+				transport = "IP.TCP";
+				peerName = serverAddress.getHost();
+				peerPort = String.valueOf(serverAddress.getPort());
 			}
 
 			ConnectionId connectionId = connectionDescription.getConnectionId();
 			if (connectionId != null) {
-				keyValues = keyValues.and(LowCardinalityCommandKeyNames.MONGODB_CLUSTER_ID
-						.withValue(connectionId.getServerId().getClusterId().getValue()));
+				clusterId = connectionId.getServerId().getClusterId().getValue();
 			}
 		}
 
-		return keyValues;
+		return KeyValues.of(
+				DB_SYSTEM.withValue("mongodb"),
+				MONGODB_COMMAND.withValue(context.getCommandName()),
+				DB_CONNECTION_STRING.withOptionalValue(connectionStringValue),
+				DB_USER.withOptionalValue(username),
+				DB_NAME.withOptionalValue(context.getDatabaseName()),
+				MONGODB_COLLECTION.withOptionalValue(context.getCollectionName()),
+				NET_TRANSPORT.withOptionalValue(transport),
+				NET_PEER_NAME.withOptionalValue(peerName),
+				NET_PEER_PORT.withOptionalValue(peerPort),
+				MONGODB_CLUSTER_ID.withOptionalValue(clusterId)
+		);
 	}
 
 	@Override
@@ -110,6 +89,8 @@ public String getContextualName(MongoHandlerContext context) {
 		String collectionName = context.getCollectionName();
 		CommandStartedEvent commandStartedEvent = context.getCommandStartedEvent();
 
+		Assert.notNull(commandStartedEvent, "CommandStartedEvent must not be null");
+
 		if (ObjectUtils.isEmpty(collectionName)) {
 			return commandStartedEvent.getCommandName();
 		}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/observability/MongoObservation.java

@@ -15,8 +15,11 @@
  */
 package org.springframework.data.mongodb.observability;
 
+import io.micrometer.common.KeyValue;
 import io.micrometer.common.docs.KeyName;
 import io.micrometer.observation.docs.ObservationDocumentation;
+import org.springframework.lang.Nullable;
+import org.springframework.util.ObjectUtils;
 
 /**
  * A MongoDB-based {@link io.micrometer.observation.Observation}.
@@ -172,6 +175,15 @@ public String asString() {
 			public String asString() {
 				return "db.operation";
 			}
+		};
+
+		/**
+		 * Creates a key value for the given key name.
+		 * @param value value for key, if value is null or empty {@link KeyValue#NONE_VALUE} will be used
+		 * @return key value
+		 */
+		public KeyValue withOptionalValue(@Nullable String value) {
+			return withValue(ObjectUtils.isEmpty(value) ? KeyValue.NONE_VALUE : value);
 		}
 	}