[GitHub] sijie closed pull request #1223: Add a `internalConfiguration` admin restful endpoint for query internal configuration

[GitBox <gi...@apache.org>]

sijie closed pull request #1223: Add a `internalConfiguration` admin restful endpoint for query internal configuration
URL: https://github.com/apache/incubator-pulsar/pull/1223
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java
index 8098f97f8..60329d767 100644
--- a/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java
+++ b/pulsar-broker/src/main/java/org/apache/pulsar/broker/admin/impl/BrokersBase.java
@@ -30,12 +30,14 @@
 import javax.ws.rs.PathParam;
 import javax.ws.rs.core.Response.Status;
 
+import org.apache.bookkeeper.conf.ClientConfiguration;
 import org.apache.bookkeeper.util.ZkUtils;
 import org.apache.pulsar.broker.ServiceConfiguration;
 import org.apache.pulsar.broker.admin.AdminResource;
 import org.apache.pulsar.broker.loadbalance.LoadManager;
 import org.apache.pulsar.broker.service.BrokerService;
 import org.apache.pulsar.broker.web.RestException;
+import org.apache.pulsar.common.conf.InternalConfigurationData;
 import org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus;
 import org.apache.pulsar.common.util.ObjectMapperFactory;
 import org.apache.pulsar.zookeeper.ZooKeeperDataCache;
@@ -183,4 +185,15 @@ private synchronized void updateDynamicConfigurationOnZk(String configName, Stri
         }
     }
 
+    @GET
+    @Path("/internal-configuration")
+    @ApiOperation(value = "Get the internal configuration data", response = InternalConfigurationData.class)
+    public InternalConfigurationData getInternalConfigurationData() {
+        ClientConfiguration conf = new ClientConfiguration();
+        return new InternalConfigurationData(
+            pulsar().getConfiguration().getZookeeperServers(),
+            pulsar().getConfiguration().getGlobalZookeeperServers(),
+            conf.getZkLedgersRootPath());
+    }
+
 }
diff --git a/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/AdminTest.java b/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/AdminTest.java
index 52d118647..dec776849 100644
--- a/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/AdminTest.java
+++ b/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/AdminTest.java
@@ -46,6 +46,7 @@
 import javax.ws.rs.core.StreamingOutput;
 import javax.ws.rs.core.UriInfo;
 
+import org.apache.bookkeeper.conf.ClientConfiguration;
 import org.apache.bookkeeper.mledger.proto.PendingBookieOpsStats;
 import org.apache.bookkeeper.util.ZkUtils;
 import org.apache.pulsar.broker.admin.v1.BrokerStats;
@@ -59,6 +60,7 @@
 import org.apache.pulsar.broker.cache.ConfigurationCacheService;
 import org.apache.pulsar.broker.web.PulsarWebResource;
 import org.apache.pulsar.broker.web.RestException;
+import org.apache.pulsar.common.conf.InternalConfigurationData;
 import org.apache.pulsar.common.naming.NamespaceName;
 import org.apache.pulsar.common.policies.data.AuthAction;
 import org.apache.pulsar.common.policies.data.AutoFailoverPolicyData;
@@ -190,6 +192,16 @@ public void cleanup() throws Exception {
         super.internalCleanup();
     }
 
+    @Test
+    void internalConfiguration() throws Exception {
+        InternalConfigurationData expectedData = new InternalConfigurationData(
+            pulsar.getConfiguration().getZookeeperServers(),
+            pulsar.getConfiguration().getGlobalZookeeperServers(),
+            new ClientConfiguration().getZkLedgersRootPath());
+
+        assertEquals(brokers.getInternalConfigurationData(), expectedData);
+    }
+
     @Test
     void clusters() throws Exception {
         assertEquals(clusters.getClusters(), Lists.newArrayList(configClusterName));
diff --git a/pulsar-broker/src/test/java/org/apache/pulsar/broker/auth/MockedPulsarServiceBaseTest.java b/pulsar-broker/src/test/java/org/apache/pulsar/broker/auth/MockedPulsarServiceBaseTest.java
index 51a4c0349..a185a7e79 100644
--- a/pulsar-broker/src/test/java/org/apache/pulsar/broker/auth/MockedPulsarServiceBaseTest.java
+++ b/pulsar-broker/src/test/java/org/apache/pulsar/broker/auth/MockedPulsarServiceBaseTest.java
@@ -98,6 +98,7 @@ protected void resetConfig() {
         this.conf.setActiveConsumerFailoverDelayTimeMillis(0);
         this.conf.setDefaultNumberOfNamespaceBundles(1);
         this.conf.setZookeeperServers("localhost:2181");
+        this.conf.setGlobalZookeeperServers("localhost:3181");
     }
 
     protected final void internalSetup() throws Exception {
diff --git a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Brokers.java b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Brokers.java
index ed5864186..a6fadd16d 100644
--- a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Brokers.java
+++ b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Brokers.java
@@ -23,6 +23,7 @@
 
 import org.apache.pulsar.client.admin.PulsarAdminException.NotAuthorizedException;
 import org.apache.pulsar.client.admin.PulsarAdminException.NotFoundException;
+import org.apache.pulsar.common.conf.InternalConfigurationData;
 import org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus;
 
 /**
@@ -98,4 +99,10 @@
      */
     Map<String, String> getAllDynamicConfigurations() throws PulsarAdminException;
 
+    /**
+     * Get the internal configuration data.
+     *
+     * @return internal configuration data.
+     */
+    InternalConfigurationData getInternalConfigurationData() throws PulsarAdminException;
 }
diff --git a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/BrokersImpl.java b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/BrokersImpl.java
index 994fa1720..096666b20 100644
--- a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/BrokersImpl.java
+++ b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/internal/BrokersImpl.java
@@ -28,6 +28,7 @@
 import org.apache.pulsar.client.admin.Brokers;
 import org.apache.pulsar.client.admin.PulsarAdminException;
 import org.apache.pulsar.client.api.Authentication;
+import org.apache.pulsar.common.conf.InternalConfigurationData;
 import org.apache.pulsar.common.policies.data.ErrorData;
 import org.apache.pulsar.common.policies.data.NamespaceOwnershipStatus;
 
@@ -91,4 +92,13 @@ public void updateDynamicConfiguration(String configName, String configValue) th
         }
     }
 
+    @Override
+    public InternalConfigurationData getInternalConfigurationData() throws PulsarAdminException {
+        try {
+            return request(brokers.path("/internal-configuration")).get(InternalConfigurationData.class);
+        } catch (Exception e) {
+            throw getApiException(e);
+        }
+    }
+
 }
diff --git a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdBrokers.java b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdBrokers.java
index 65fa962f0..9dc50a057 100644
--- a/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdBrokers.java
+++ b/pulsar-client-tools/src/main/java/org/apache/pulsar/admin/cli/CmdBrokers.java
@@ -82,6 +82,16 @@ void run() throws Exception {
             print(admin.brokers().getDynamicConfigurationNames());
         }
     }
+
+    @Parameters(commandDescription = "Get internal configuration information")
+    private class GetInternalConfigurationCmd extends CliCommand {
+
+        @Override
+        void run() throws Exception {
+            print(admin.brokers().getInternalConfigurationData());
+        }
+
+    }
     
     public CmdBrokers(PulsarAdmin admin) {
         super("brokers", admin);
@@ -90,5 +100,6 @@ public CmdBrokers(PulsarAdmin admin) {
         jcommander.addCommand("update-dynamic-config", new UpdateConfigurationCmd());
         jcommander.addCommand("list-dynamic-config", new GetUpdatableConfigCmd());
         jcommander.addCommand("get-all-dynamic-config", new GetAllConfigurationsCmd());
+        jcommander.addCommand("get-internal-config", new GetInternalConfigurationCmd());
     }
 }
diff --git a/pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/PulsarAdminToolTest.java b/pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/PulsarAdminToolTest.java
index 00f18a977..6328f41d3 100644
--- a/pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/PulsarAdminToolTest.java
+++ b/pulsar-client-tools/src/test/java/org/apache/pulsar/admin/cli/PulsarAdminToolTest.java
@@ -37,7 +37,6 @@
 import org.apache.pulsar.client.admin.PulsarAdmin;
 import org.apache.pulsar.client.admin.ResourceQuotas;
 import org.apache.pulsar.client.api.MessageId;
-import org.apache.pulsar.client.impl.MessageIdImpl;
 import org.apache.pulsar.common.policies.data.AuthAction;
 import org.apache.pulsar.common.policies.data.BacklogQuota;
 import org.apache.pulsar.common.policies.data.BacklogQuota.RetentionPolicy;
@@ -57,6 +56,7 @@
 
 @Test
 public class PulsarAdminToolTest {
+
     @Test
     void brokers() throws Exception {
         PulsarAdmin admin = Mockito.mock(PulsarAdmin.class);
@@ -76,6 +76,9 @@ void brokers() throws Exception {
 
         brokers.run(split("update-dynamic-config --config brokerShutdownTimeoutMs --value 100"));
         verify(mockBrokers).updateDynamicConfiguration("brokerShutdownTimeoutMs", "100");
+
+        brokers.run(split("get-internal-config"));
+        verify(mockBrokers).getInternalConfigurationData();
     }
 
     @Test
diff --git a/pulsar-common/src/main/java/org/apache/pulsar/common/conf/InternalConfigurationData.java b/pulsar-common/src/main/java/org/apache/pulsar/common/conf/InternalConfigurationData.java
new file mode 100644
index 000000000..aa1068a45
--- /dev/null
+++ b/pulsar-common/src/main/java/org/apache/pulsar/common/conf/InternalConfigurationData.java
@@ -0,0 +1,78 @@
+/**
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://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 org.apache.pulsar.common.conf;
+
+import com.google.common.base.MoreObjects;
+import java.util.Objects;
+
+public class InternalConfigurationData {
+
+    private String zookeeperServers;
+    private String globalZooKeeperServers;
+    private String ledgersRootPath;
+
+    public InternalConfigurationData() {
+    }
+
+    public InternalConfigurationData(String zookeeperServers,
+                                     String globalZooKeeperServers,
+                                     String ledgersRootPath) {
+        this.zookeeperServers = zookeeperServers;
+        this.globalZooKeeperServers = globalZooKeeperServers;
+        this.ledgersRootPath = ledgersRootPath;
+    }
+
+    public String getZookeeperServers() {
+        return zookeeperServers;
+    }
+
+    public String getGlobalZooKeeperServers() {
+        return globalZooKeeperServers;
+    }
+
+    public String getLedgersRootPath() {
+        return ledgersRootPath;
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (!(obj instanceof InternalConfigurationData)) {
+            return false;
+        }
+        InternalConfigurationData other = (InternalConfigurationData) obj;
+        return Objects.equals(zookeeperServers, other.zookeeperServers)
+            && Objects.equals(globalZooKeeperServers, other.globalZooKeeperServers)
+            && Objects.equals(ledgersRootPath, other.ledgersRootPath);
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(zookeeperServers, globalZooKeeperServers, ledgersRootPath);
+    }
+
+    @Override
+    public String toString() {
+        return MoreObjects.toStringHelper(this)
+            .add("zookeeperServers", zookeeperServers)
+            .add("globalZooKeeperServers", globalZooKeeperServers)
+            .add("ledgersRootPath", ledgersRootPath)
+            .toString();
+    }
+
+}


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services