JAVA-1117: Reverting to 2.11.x behavior for registration of JMX MBeans: logging at INFO if a duplicate is found, and adding the MongoClient description to the MBean name to provide a way for the application to remove the duplication.

Author: jyemin

src/main/com/mongodb/DefaultClusterableServerFactory.java

@@ -49,7 +49,7 @@ public ClusterableServer create(final ServerAddress serverAddress) {
                               .build();
         return new DefaultServer(serverAddress, settings,
                                  new PooledConnectionProvider(clusterId, serverAddress, new DBPortFactory(options), connectionPoolSettings,
-                                                              new JMXConnectionPoolListener()),
+                                                              new JMXConnectionPoolListener(mongo.getMongoOptions().getDescription())),
                                  scheduledExecutorService, mongo);
     }
 

src/main/com/mongodb/JMXConnectionPoolListener.java

@@ -18,7 +18,6 @@
 
 import com.mongodb.util.management.MBeanServerFactory;
 
-import java.net.URI;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ConcurrentMap;
 
@@ -30,15 +29,26 @@
 class JMXConnectionPoolListener implements ConnectionPoolListener {
     private final ConcurrentMap<ClusterIdServerAddressPair, ConnectionPoolStatistics> map =
     new ConcurrentHashMap<ClusterIdServerAddressPair, ConnectionPoolStatistics>();
+    private final String clusterDescription;
+
+    public JMXConnectionPoolListener(final String clusterDescription) {
+        this.clusterDescription = clusterDescription;
+    }
 
     public String getMBeanObjectName(final String clusterId, final ServerAddress serverAddress) {
         // we could do a url encode, but since : is the only invalid character in an object name, then
         // we'll simply do it.
         String adjustedClusterId = clusterId.replace(":", "%3A");
         String adjustedHost = serverAddress.getHost().replace(":", "%3A");
 
-        return format("org.mongodb.driver:type=ConnectionPool,clusterId=%s,host=%s,port=%s", adjustedClusterId, adjustedHost,
-                      serverAddress.getPort());
+        String objectName = format("org.mongodb.driver:type=ConnectionPool,clusterId=%s,host=%s,port=%s", adjustedClusterId, adjustedHost,
+                               serverAddress.getPort());
+        if (clusterDescription != null) {
+            String adjustedClusterDescription = clusterDescription.replace(":", "%3A");
+            objectName = objectName + format(",description=%s", adjustedClusterDescription);
+        }
+
+        return objectName;
     }
 
     public ConnectionPoolStatisticsMBean getMBean(final String clusterId, final ServerAddress serverAddress) {

src/main/com/mongodb/util/management/jmx/JMXMBeanServer.java

@@ -18,17 +18,19 @@
 
 import com.mongodb.util.management.MBeanServer;
 
+import javax.management.InstanceAlreadyExistsException;
 import javax.management.MalformedObjectNameException;
 import javax.management.ObjectName;
 import java.lang.management.ManagementFactory;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
+import static java.lang.String.format;
+
 /**
  * This class is NOT part of the public API.  It may change at any time without notification.
  *
- * @deprecated This class will be removed in 3.x versions of the driver,
- *             so please remove it from your compile time dependencies.
+ * @deprecated This class will be removed in 3.x versions of the driver, so please remove it from your compile time dependencies.
  */
 @Deprecated
 public class JMXMBeanServer implements MBeanServer {
@@ -57,6 +59,8 @@ public void unregisterMBean(String mBeanName) {
     public void registerMBean(Object mBean, String mBeanName) {
         try {
             server.registerMBean(mBean, createObjectName(mBeanName));
+        } catch (InstanceAlreadyExistsException e) {
+            LOGGER.log(Level.INFO, format("A JMX MBean with the name '%s' already exists", mBeanName));
         } catch (Exception e) {
             LOGGER.log(Level.WARNING, "Unable to register MBean " + mBeanName, e);
         }

src/test/com/mongodb/JMXConnectionPoolListenerSpecification.groovy

@@ -19,7 +19,6 @@
 package com.mongodb
 
 import spock.lang.Specification
-import spock.lang.Subject
 
 import javax.management.ObjectName
 import java.lang.management.ManagementFactory
@@ -30,14 +29,12 @@ class JMXConnectionPoolListenerSpecification extends Specification {
     private static final String CLUSTER_ID = '42'
     private static final ServerAddress SERVER_ADDRESS = new ServerAddress()
 
-    @Subject
-    private final JMXConnectionPoolListener jmxListener = new JMXConnectionPoolListener()
-
     private final openEvent = new ConnectionPoolOpenedEvent(CLUSTER_ID, SERVER_ADDRESS,
                                                             ConnectionPoolSettings.builder().maxSize(5).maxWaitTime(1, SECONDS).build())
 
     def 'statistics should reflect values from the provider'() {
         given:
+        def jmxListener = new JMXConnectionPoolListener(null)
         def event = new ConnectionEvent(CLUSTER_ID, SERVER_ADDRESS)
 
         when:
@@ -70,6 +67,7 @@ class JMXConnectionPoolListenerSpecification extends Specification {
 
     def 'should remove MBean'() {
         given:
+        def jmxListener = new JMXConnectionPoolListener(null)
         jmxListener.connectionPoolOpened(openEvent);
 
         when:
@@ -82,6 +80,7 @@ class JMXConnectionPoolListenerSpecification extends Specification {
 
     def 'should create a valid ObjectName for hostname'() {
         given:
+        def jmxListener = new JMXConnectionPoolListener(null)
         String beanName = jmxListener.getMBeanObjectName(CLUSTER_ID, new ServerAddress('localhost'));
 
         when:
@@ -93,6 +92,7 @@ class JMXConnectionPoolListenerSpecification extends Specification {
 
     def 'should create a valid ObjectName for ipv4 addresses'() {
         given:
+        def jmxListener = new JMXConnectionPoolListener(null)
         String beanName = jmxListener.getMBeanObjectName(CLUSTER_ID, new ServerAddress('127.0.0.1'))
 
         when:
@@ -104,6 +104,7 @@ class JMXConnectionPoolListenerSpecification extends Specification {
 
     def 'should create a valid ObjectName for ipv6 address'() {
         given:
+        def jmxListener = new JMXConnectionPoolListener(null)
         String beanName = jmxListener.getMBeanObjectName(CLUSTER_ID, new ServerAddress('[::1]'))
 
         when:
@@ -115,6 +116,7 @@ class JMXConnectionPoolListenerSpecification extends Specification {
 
     def 'should create a valid ObjectName when cluster id has a :'() {
         given:
+        def jmxListener = new JMXConnectionPoolListener(null)
         String beanName = jmxListener.getMBeanObjectName('kd:dk', new ServerAddress())
 
         when:
@@ -123,4 +125,30 @@ class JMXConnectionPoolListenerSpecification extends Specification {
         then:
         objectName.toString() == 'org.mongodb.driver:type=ConnectionPool,clusterId=kd%3Adk,host=127.0.0.1,port=27017'
     }
+
+    def 'should include a non-null cluster description in the object name'() {
+        given:
+        def jmxListener = new JMXConnectionPoolListener('cluster description 1')
+        String beanName = jmxListener.getMBeanObjectName('1', new ServerAddress())
+
+        when:
+        ObjectName objectName = new ObjectName(beanName)
+
+        then:
+        objectName.toString() ==
+        'org.mongodb.driver:type=ConnectionPool,clusterId=1,host=127.0.0.1,port=27017,description=cluster description 1'
+    }
+
+    def 'should replace colon in cluster description'() {
+        given:
+        def jmxListener = new JMXConnectionPoolListener('description: 1')
+        String beanName = jmxListener.getMBeanObjectName('1', new ServerAddress())
+
+        when:
+        ObjectName objectName = new ObjectName(beanName)
+
+        then:
+        objectName.toString() ==
+        'org.mongodb.driver:type=ConnectionPool,clusterId=1,host=127.0.0.1,port=27017,description=description%3A 1'
+    }
 }