JVMCBC-1560: Add cluster UUID and name to metrics and spans (3/n)

Adding cluster uuid and name config parsing.  This
will only be sent from fully upgraded 7.7+ clusters.

Change-Id: Ied58e6f4cd99d596d07017d0cf1d8b2d81fd554b
Reviewed-on: https://review.couchbase.org/c/couchbase-jvm-clients/+/217015
Tested-by: Build Bot <[email protected]>
Reviewed-by: Graham Pople <[email protected]>

Author: programmatix

core-io/src/main/java/com/couchbase/client/core/config/GlobalConfig.java

@@ -22,6 +22,7 @@
 import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonIgnoreProperties;
 import com.couchbase.client.core.deps.com.fasterxml.jackson.annotation.JsonProperty;
 import com.couchbase.client.core.service.ServiceType;
+import com.couchbase.client.core.topology.ClusterIdentifier;
 import com.couchbase.client.core.topology.ClusterTopology;
 import reactor.util.annotation.Nullable;
 
@@ -47,6 +48,7 @@ public class GlobalConfig {
   private final ConfigVersion version;
   private final List<PortInfo> portInfos;
   private final Map<ServiceType, Set<ClusterCapabilities>> clusterCapabilities;
+  private final @Nullable ClusterIdentifier clusterIdent;
 
   // Null only if the GlobalConfig was created by a legacy config parser
   @Nullable private final ClusterTopology clusterTopology;
@@ -56,6 +58,7 @@ public GlobalConfig(ClusterTopology topology) {
     this.portInfos = LegacyConfigHelper.getPortInfos(topology);
     this.clusterCapabilities = LegacyConfigHelper.getClusterCapabilities(topology);
     this.clusterTopology = topology;
+    this.clusterIdent = topology.id();
   }
 
   @JsonCreator
@@ -70,6 +73,7 @@ public GlobalConfig(
     this.portInfos = enrichPortInfos(portInfos, origin);
     this.clusterCapabilities = AbstractBucketConfig.convertClusterCapabilities(clusterCapabilities);
     this.clusterTopology = null;
+    this.clusterIdent = null;
   }
 
   /**
@@ -126,6 +130,10 @@ public Map<ServiceType, Set<ClusterCapabilities>> clusterCapabilities() {
     return clusterCapabilities;
   }
 
+  @Nullable public ClusterIdentifier clusterIdent() {
+    return clusterIdent;
+  }
+
   /**
    * The node/port infos for each node in the list.
    */

core-io/src/main/java/com/couchbase/client/core/topology/ClusterIdentifier.java

@@ -0,0 +1,59 @@
+/*
+ * Copyright 2024 Couchbase, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.couchbase.client.core.topology;
+
+import com.couchbase.client.core.annotation.Stability;
+import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.JsonNode;
+import com.couchbase.client.core.deps.com.fasterxml.jackson.databind.node.ObjectNode;
+import reactor.util.annotation.Nullable;
+
+import static com.couchbase.client.core.logging.RedactableArgument.redactMeta;
+
+@Stability.Internal
+public class ClusterIdentifier {
+  private final String clusterUuid;
+  private final String clusterName;
+
+  ClusterIdentifier(String clusterUuid, String clusterName) {
+    this.clusterUuid = clusterUuid;
+    this.clusterName = clusterName;
+  }
+
+  public static @Nullable ClusterIdentifier parse(ObjectNode config) {
+    JsonNode clusterUuid = config.path("clusterUUID");
+    JsonNode clusterName = config.path("clusterName");
+    if (clusterUuid.isMissingNode() || clusterName.isMissingNode()) {
+      return null;
+    }
+    return new ClusterIdentifier(clusterUuid.asText(), clusterName.asText());
+  }
+
+  public String clusterUuid() {
+    return clusterUuid;
+  }
+
+  public String clusterName() {
+    return clusterName;
+  }
+
+  @Override
+  public String toString() {
+    return "ClusterIdent{" +
+      "clusterUuid='" + clusterUuid + '\'' +
+      ", clusterName='" + redactMeta(clusterName) + '\'' +
+      '}';
+  }
+}

core-io/src/main/java/com/couchbase/client/core/topology/ClusterTopology.java

@@ -36,9 +36,11 @@ public class ClusterTopology {
   private final NetworkResolution network;
   private final Set<ClusterCapability> capabilities;
   private final List<HostAndServicePorts> nodes;
+  @Nullable private final ClusterIdentifier clusterIdent;
 
   public static ClusterTopology of(
     TopologyRevision revision,
+    @Nullable ClusterIdentifier clusterIdent,
     List<HostAndServicePorts> nodes,
     Set<ClusterCapability> capabilities,
     NetworkResolution network,
@@ -52,7 +54,8 @@ public static ClusterTopology of(
         capabilities,
         network,
         portSelector,
-        bucket
+        bucket,
+        clusterIdent
       );
     }
 
@@ -61,7 +64,8 @@ public static ClusterTopology of(
       nodes,
       capabilities,
       network,
-      portSelector
+      portSelector,
+      clusterIdent
     );
   }
 
@@ -70,7 +74,8 @@ protected ClusterTopology(
     List<HostAndServicePorts> nodes,
     Set<ClusterCapability> capabilities,
     NetworkResolution network,
-    PortSelector portSelector
+    PortSelector portSelector,
+    @Nullable ClusterIdentifier clusterIdent
   ) {
     if (network.equals(NetworkResolution.AUTO)) {
       throw new IllegalArgumentException("Must resolve 'auto' network before creating config.");
@@ -81,6 +86,7 @@ protected ClusterTopology(
     this.capabilities = unmodifiableSet(newEnumSet(ClusterCapability.class, capabilities));
     this.network = requireNonNull(network);
     this.tls = requireNonNull(portSelector) == PortSelector.TLS;
+    this.clusterIdent = clusterIdent;
   }
 
   public TopologyRevision revision() {
@@ -114,12 +120,17 @@ public ClusterTopologyWithBucket requireBucket() {
     throw new NoSuchElementException("Bucket topology is absent.");
   }
 
+  @Nullable public ClusterIdentifier id() {
+    return clusterIdent;
+  }
+
   @Override
   public String toString() {
     String bucket = this instanceof ClusterTopologyWithBucket ? this.requireBucket().bucket().toString() : "<N/A>";
 
     return "ClusterTopology{" +
       "revision=" + revision +
+      ", clusterIdent=" + clusterIdent +
       ", tls=" + tls +
       ", network=" + network +
       ", capabilities=" + capabilities +

core-io/src/main/java/com/couchbase/client/core/topology/ClusterTopologyParser.java

@@ -123,8 +123,11 @@ resolvedNetwork, redactSystem(it)
 
     BucketTopology bucket = BucketTopology.parse(clusterConfig, nodesReadyToServiceThisBucket, memcachedHashingStrategy);
 
+    ClusterIdentifier clusterIdent = ClusterIdentifier.parse(clusterConfig);
+
     return ClusterTopology.of(
       TopologyRevision.parse(clusterConfig),
+      clusterIdent,
       resolvedNodes,
       parseCapabilities(clusterConfig),
       resolvedNetwork,

core-io/src/main/java/com/couchbase/client/core/topology/ClusterTopologyWithBucket.java

@@ -18,6 +18,7 @@
 
 import com.couchbase.client.core.annotation.Stability;
 import com.couchbase.client.core.env.NetworkResolution;
+import reactor.util.annotation.Nullable;
 
 import java.util.List;
 import java.util.Set;
@@ -40,9 +41,10 @@ public class ClusterTopologyWithBucket extends ClusterTopology {
     Set<ClusterCapability> capabilities,
     NetworkResolution network,
     PortSelector portSelector,
-    BucketTopology bucket
+    BucketTopology bucket,
+    @Nullable ClusterIdentifier clusterIdent
   ) {
-    super(revision, nodes, capabilities, network, portSelector);
+    super(revision, nodes, capabilities, network, portSelector, clusterIdent);
     this.bucket = requireNonNull(bucket);
   }
 

core-io/src/test/java/com/couchbase/client/core/topology/TopologyTestUtils.java

@@ -56,6 +56,7 @@ public static NodeInfo nodeInfo(String host, Map<ServiceType, Integer> ports) {
   public static ClusterTopology clusterTopology(List<HostAndServicePorts> nodes) {
     return ClusterTopology.of(
       new TopologyRevision(1, 1),
+      null,
       nodes,
       emptySet(),
       NetworkResolution.DEFAULT,