Support apollo grouped dynamic configurations (#7685)

Author: wankai123

CHANGES.md

@@ -61,6 +61,7 @@ Release Notes.
 * Support etcd grouped dynamic configurations.
 * Unified the config word `namespace` in the project.
 * Switch JRE base image for dev images.
+* Support apollo grouped dynamic configurations.
 
 #### UI
 

docs/en/setup/backend/dynamic-config-apollo.md

@@ -6,9 +6,52 @@
 configuration:
   selector: ${SW_CONFIGURATION:apollo}
   apollo:
-    apolloMeta: ${SW_CONFIG_APOLLO:http://106.12.25.204:8080}
+    apolloMeta: ${SW_CONFIG_APOLLO:http://localhost:8080}
     apolloCluster: ${SW_CONFIG_APOLLO_CLUSTER:default}
     apolloEnv: ${SW_CONFIG_APOLLO_ENV:""}
     appId: ${SW_CONFIG_APOLLO_APP_ID:skywalking}
-    period: ${SW_CONFIG_APOLLO_PERIOD:5}
-```
+    period: ${SW_CONFIG_APOLLO_PERIOD:60}
+```
+
+## Config Storage
+### Single Config
+Single configs in apollo are key/value pairs:
+
+| Key | Value |
+|-----|-----|
+| configKey | configVaule |
+
+e.g. The config is:
+```
+{agent-analyzer.default.slowDBAccessThreshold}:{default:200,mongodb:50}
+```
+The config in apollo is:
+
+| Key | Value |
+|-----|-----|
+| agent-analyzer.default.slowDBAccessThreshold | default:200,mongodb:50 |
+| ... | ... |
+
+
+### Group Config
+Group config in apollo are key/value pairs as well, and the key is composited by configKey and subItemKey with `.`.
+
+| Key | Value |
+|-----|-----|
+| configKey.subItemkey1 | subItemValue1 |
+| configKey.subItemkey2 | subItemValue2 |
+| ... | ... |
+
+e.g. The config is:
+```
+{core.default.endpoint-name-grouping-openapi}:|{customerAPI-v1}:{value of customerAPI-v1}
+                                              |{productAPI-v1}:{value of productAPI-v1}
+                                              |{productAPI-v2}:{value of productAPI-v2}
+```
+The config in apollo is:
+
+| Key | Value |
+|-----|-----|
+| core.default.endpoint-name-grouping-openapi.customerAPI-v1 | value of customerAPI-v1 |
+| core.default.endpoint-name-grouping-openapi.productAPI-v1 | value of productAPI-v1 |
+| core.default.endpoint-name-grouping-openapi.productAPI-v2 | value of productAPI-v2 |

oap-server/server-configuration/configuration-apollo/src/main/java/org/apache/skywalking/oap/server/configuration/apollo/ApolloConfigWatcherRegister.java

@@ -68,7 +68,21 @@ public Optional<ConfigTable> readConfig(Set<String> keys) {
 
     @Override
     public Optional<GroupConfigTable> readGroupConfig(final Set<String> keys) {
-        // TODO: implement readGroupConfig
-        return Optional.empty();
+        GroupConfigTable groupConfigTable = new GroupConfigTable();
+        Set<String> allKeys = this.configReader.getPropertyNames();
+
+        keys.forEach(key -> {
+            GroupConfigTable.GroupConfigItems groupConfigItems = new GroupConfigTable.GroupConfigItems(key);
+            groupConfigTable.addGroupConfigItems(groupConfigItems);
+            String groupKey = key + ".";
+            if (allKeys != null) {
+                allKeys.stream().filter(it -> it.startsWith(groupKey)).forEach(groupItemKey -> {
+                    String itemValue = this.configReader.getProperty(groupItemKey, null);
+                    String itemName = groupItemKey.substring(groupKey.length());
+                    groupConfigItems.add(new ConfigTable.ConfigItem(itemName, itemValue));
+                });
+            }
+        });
+        return Optional.of(groupConfigTable);
     }
 }

oap-server/server-configuration/configuration-apollo/src/test/java/org/apache/skywalking/oap/server/configuration/apollo/ApolloConfigurationTestProvider.java

@@ -18,21 +18,23 @@
 
 package org.apache.skywalking.oap.server.configuration.apollo;
 
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.skywalking.oap.server.configuration.api.ConfigChangeWatcher;
 import org.apache.skywalking.oap.server.configuration.api.ConfigurationModule;
 import org.apache.skywalking.oap.server.configuration.api.DynamicConfigurationService;
+import org.apache.skywalking.oap.server.configuration.api.GroupConfigChangeWatcher;
 import org.apache.skywalking.oap.server.library.module.ModuleConfig;
 import org.apache.skywalking.oap.server.library.module.ModuleDefine;
 import org.apache.skywalking.oap.server.library.module.ModuleProvider;
 import org.apache.skywalking.oap.server.library.module.ModuleStartException;
 import org.apache.skywalking.oap.server.library.module.ServiceNotProvidedException;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 
+@Slf4j
 public class ApolloConfigurationTestProvider extends ModuleProvider {
-    private static final Logger LOGGER = LoggerFactory.getLogger(ApolloConfigurationTestProvider.class);
-
     ConfigChangeWatcher watcher;
+    GroupConfigChangeWatcher groupWatcher;
 
     @Override
     public String name() {
@@ -57,7 +59,7 @@ public void prepare() throws ServiceNotProvidedException, ModuleStartException {
 
             @Override
             public void notify(ConfigChangeWatcher.ConfigChangeEvent value) {
-                LOGGER.info("ConfigChangeWatcher.ConfigChangeEvent: {}", value);
+                log.info("ConfigChangeWatcher.ConfigChangeEvent: {}", value);
                 if (EventType.DELETE.equals(value.getEventType())) {
                     testValue = null;
                 } else {
@@ -70,18 +72,44 @@ public String value() {
                 return testValue;
             }
         };
+
+        groupWatcher = new GroupConfigChangeWatcher(ApolloConfigurationTestModule.NAME, this, "testKeyGroup") {
+            private Map<String, String> config = new ConcurrentHashMap<>();
+
+            @Override
+            public void notifyGroup(Map<String, ConfigChangeEvent> groupItems) {
+                log.info("GroupConfigChangeWatcher.ConfigChangeEvents: {}", groupItems);
+                groupItems.forEach((groupItemName, event) -> {
+                    if (EventType.DELETE.equals(event.getEventType())) {
+                        config.remove(groupItemName);
+                    } else {
+                        config.put(groupItemName, event.getNewValue());
+                    }
+                });
+            }
+
+            @Override
+            public Map<String, String> groupItems() {
+                return config;
+            }
+        };
     }
 
     @Override
-    public void start() throws ServiceNotProvidedException, ModuleStartException {
+    public void start() throws ServiceNotProvidedException {
         getManager().find(ConfigurationModule.NAME)
                     .provider()
                     .getService(DynamicConfigurationService.class)
                     .registerConfigChangeWatcher(watcher);
+
+        getManager().find(ConfigurationModule.NAME)
+                    .provider()
+                    .getService(DynamicConfigurationService.class)
+                    .registerConfigChangeWatcher(groupWatcher);
     }
 
     @Override
-    public void notifyAfterCompleted() throws ServiceNotProvidedException, ModuleStartException {
+    public void notifyAfterCompleted() throws ServiceNotProvidedException {
 
     }