feat(client): Add more observability in apollo config client

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/AbstractConfigFile.java

@@ -17,8 +17,7 @@
 package com.ctrip.framework.apollo.internals;
 
 
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CLIENT_CONFIGCHANGES;
-
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 import com.ctrip.framework.apollo.build.ApolloInjector;
 import com.ctrip.framework.apollo.core.utils.DeferredLoggerFactory;
 import com.ctrip.framework.apollo.enums.ConfigSourceType;

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/AbstractConfigRepository.java

@@ -16,8 +16,7 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIG_EXCEPTION;
-
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 import com.ctrip.framework.apollo.build.ApolloInjector;
 import com.ctrip.framework.apollo.util.factory.PropertiesFactory;
 import java.util.List;

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/ConfigMonitorInitializer.java

@@ -20,17 +20,17 @@
 import com.ctrip.framework.apollo.core.utils.ClassLoaderUtil;
 import com.ctrip.framework.apollo.monitor.api.ConfigMonitor;
 import com.ctrip.framework.apollo.monitor.internal.DefaultConfigMonitor;
-import com.ctrip.framework.apollo.monitor.internal.collector.MetricsCollector;
-import com.ctrip.framework.apollo.monitor.internal.collector.MetricsCollectorManager;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloExceptionCollector;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloNamespaceCollector;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloRunningParamsCollector;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloThreadPoolCollector;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultMetricsCollectorManager;
-import com.ctrip.framework.apollo.monitor.internal.exporter.MetricsExporter;
-import com.ctrip.framework.apollo.monitor.internal.exporter.MetricsExporterFactory;
-import com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite;
-import com.ctrip.framework.apollo.monitor.internal.tracer.MonitorMessageProducer;
+import com.ctrip.framework.apollo.monitor.internal.listener.ApolloClientMetricsEventListener;
+import com.ctrip.framework.apollo.monitor.internal.listener.ApolloClientMetricsEventListenerManager;
+import com.ctrip.framework.apollo.monitor.internal.listener.impl.DefaultApolloClientBootstrapArgsApi;
+import com.ctrip.framework.apollo.monitor.internal.listener.impl.DefaultApolloClientExceptionApi;
+import com.ctrip.framework.apollo.monitor.internal.listener.impl.DefaultApolloClientNamespaceApi;
+import com.ctrip.framework.apollo.monitor.internal.listener.impl.DefaultApolloClientThreadPoolApi;
+import com.ctrip.framework.apollo.monitor.internal.listener.impl.DefaultApolloClientMetricsEventListenerManager;
+import com.ctrip.framework.apollo.monitor.internal.exporter.ApolloClientMetricsExporter;
+import com.ctrip.framework.apollo.monitor.internal.exporter.ApolloClientMetricsExporterFactory;
+import com.ctrip.framework.apollo.monitor.internal.tracer.ApolloClientMonitorMessageProducer;
+import com.ctrip.framework.apollo.monitor.internal.tracer.ApolloClientMessageProducerComposite;
 import com.ctrip.framework.apollo.tracer.internals.NullMessageProducer;
 import com.ctrip.framework.apollo.tracer.internals.cat.CatMessageProducer;
 import com.ctrip.framework.apollo.tracer.internals.cat.CatNames;
@@ -43,92 +43,82 @@
 import org.slf4j.LoggerFactory;
 
 /**
- * @author Rawven
+ * ConfigMonitorInitializer initializes the Apollo Config Monitor.
  */
 public class ConfigMonitorInitializer {
 
   private static final Logger logger = LoggerFactory.getLogger(ConfigMonitorInitializer.class);
-
-  private static ConfigUtil m_configUtil = ApolloInjector.getInstance(ConfigUtil.class);
-  private static Boolean hasInitialized = false;
+  private static final ConfigUtil CONFIG_UTIL = ApolloInjector.getInstance(ConfigUtil.class);
+  private static boolean hasInitialized = false;
 
   public static void initialize() {
-    if (m_configUtil.isClientMonitorEnabled() && !hasInitialized) {
-      logger.info("Initializing ConfigMonitor...");
-      DefaultMetricsCollectorManager manager = initializeMetricsCollectorManager();
-      List<MetricsCollector> collectors = initializeCollectors(manager);
-      MetricsExporter metricsExporter = initializeMetricsExporter(collectors);
+    if (CONFIG_UTIL.getClientMonitorEnabled() && !hasInitialized) {
+      logger.debug("Initializing ConfigMonitor");
+      DefaultApolloClientMetricsEventListenerManager manager = initializeMetricsEventListenerManager();
+      List<ApolloClientMetricsEventListener> collectors = initializeCollectors(manager);
+      ApolloClientMetricsExporter metricsExporter = initializeMetricsExporter(collectors);
       initializeConfigMonitor(collectors, metricsExporter);
       hasInitialized = true;
-      logger.info("ConfigMonitor initialized successfully.");
+      logger.debug("ConfigMonitor initialized successfully.");
     }
   }
 
-  private static DefaultMetricsCollectorManager initializeMetricsCollectorManager() {
-    return (DefaultMetricsCollectorManager) ApolloInjector.getInstance(
-        MetricsCollectorManager.class);
+  private static DefaultApolloClientMetricsEventListenerManager initializeMetricsEventListenerManager() {
+    return (DefaultApolloClientMetricsEventListenerManager) ApolloInjector.getInstance(
+        ApolloClientMetricsEventListenerManager.class);
   }
 
-  private static List<MetricsCollector> initializeCollectors(
-      DefaultMetricsCollectorManager manager) {
-    DefaultConfigManager configManager = (DefaultConfigManager) ApolloInjector.getInstance(
-        ConfigManager.class);
-    DefaultApolloExceptionCollector exceptionCollector = new DefaultApolloExceptionCollector();
-    DefaultApolloThreadPoolCollector threadPoolCollector = new DefaultApolloThreadPoolCollector(
-        RemoteConfigRepository.m_executorService, AbstractConfig.m_executorService,
-        AbstractConfigFile.m_executorService);
-    DefaultApolloNamespaceCollector namespaceCollector = new DefaultApolloNamespaceCollector(
-        configManager.m_configs, configManager.m_configLocks, configManager.m_configFiles,
-        configManager.m_configFileLocks);
-    DefaultApolloRunningParamsCollector startupCollector = new DefaultApolloRunningParamsCollector(
-        m_configUtil);
-
-    List<MetricsCollector> collectors = Lists.newArrayList(exceptionCollector, namespaceCollector,
-        threadPoolCollector, startupCollector);
+  private static List<ApolloClientMetricsEventListener> initializeCollectors(
+      DefaultApolloClientMetricsEventListenerManager manager) {
+
+    DefaultConfigManager configManager = (DefaultConfigManager) ApolloInjector.getInstance(ConfigManager.class);
+
+    List<ApolloClientMetricsEventListener> collectors = Lists.newArrayList(
+        new DefaultApolloClientExceptionApi(),
+        new DefaultApolloClientNamespaceApi(configManager.m_configs, configManager.m_configFiles),
+        new DefaultApolloClientThreadPoolApi(RemoteConfigRepository.m_executorService,
+            AbstractConfig.m_executorService, AbstractConfigFile.m_executorService),
+        new DefaultApolloClientBootstrapArgsApi(CONFIG_UTIL)
+    );
+
     manager.setCollectors(collectors);
     return collectors;
   }
 
-  private static MetricsExporter initializeMetricsExporter(List<MetricsCollector> collectors) {
-    MetricsExporterFactory reporterFactory = ApolloInjector.getInstance(
-        MetricsExporterFactory.class);
-    return reporterFactory.getMetricsReporter(collectors);
+  private static ApolloClientMetricsExporter initializeMetricsExporter(List<ApolloClientMetricsEventListener> collectors) {
+    ApolloClientMetricsExporterFactory exporterFactory = ApolloInjector.getInstance(
+        ApolloClientMetricsExporterFactory.class);
+    return exporterFactory.getMetricsReporter(collectors);
   }
 
-  private static void initializeConfigMonitor(List<MetricsCollector> collectors,
-      MetricsExporter metricsExporter) {
-    DefaultConfigMonitor defaultConfigMonitor = (DefaultConfigMonitor) ApolloInjector.getInstance(
-        ConfigMonitor.class);
-    DefaultApolloExceptionCollector exceptionCollector = (DefaultApolloExceptionCollector) collectors.get(
-        0);
-    DefaultApolloNamespaceCollector namespaceCollector = (DefaultApolloNamespaceCollector) collectors.get(
-        1);
-    DefaultApolloThreadPoolCollector threadPoolCollector = (DefaultApolloThreadPoolCollector) collectors.get(
-        2);
-    DefaultApolloRunningParamsCollector startupCollector = (DefaultApolloRunningParamsCollector) collectors.get(
-        3);
-    defaultConfigMonitor.init(namespaceCollector, threadPoolCollector, exceptionCollector,
-        startupCollector, metricsExporter);
-  }
+  private static void initializeConfigMonitor(List<ApolloClientMetricsEventListener> collectors,
+      ApolloClientMetricsExporter metricsExporter) {
 
-  public static MessageProducerComposite initializeMessageProducerComposite() {
+    DefaultConfigMonitor configMonitor = (DefaultConfigMonitor) ApolloInjector.getInstance(ConfigMonitor.class);
+    configMonitor.init(
+        (DefaultApolloClientNamespaceApi) collectors.get(1),
+        (DefaultApolloClientThreadPoolApi) collectors.get(2),
+        (DefaultApolloClientExceptionApi) collectors.get(0),
+        (DefaultApolloClientBootstrapArgsApi) collectors.get(3),
+        metricsExporter
+    );
+  }
 
-    // Prioritize loading user-defined producers from SPI
+  public static ApolloClientMessageProducerComposite initializeMessageProducerComposite() {
     List<MessageProducer> producers = ServiceBootstrap.loadAllOrdered(MessageProducer.class);
 
-    // The producer that comes with the client
-    if (m_configUtil.isClientMonitorEnabled()) {
-      producers.add(new MonitorMessageProducer());
+    if (CONFIG_UTIL.getClientMonitorEnabled()) {
+      producers.add(new ApolloClientMonitorMessageProducer());
     }
 
     if (ClassLoaderUtil.isClassPresent(CatNames.CAT_CLASS)) {
       producers.add(new CatMessageProducer());
     }
 
-    // default logic
     if (producers.isEmpty()) {
       producers.add(new NullMessageProducer());
     }
-    return new MessageProducerComposite(producers);
+
+    return new ApolloClientMessageProducerComposite(producers);
   }
 }

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/ConfigServiceLocator.java

@@ -16,10 +16,7 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIG_EXCEPTION;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIG_SERVICES;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_META_SERVICE;
-
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 import com.ctrip.framework.apollo.build.ApolloInjector;
 import com.ctrip.framework.apollo.core.ApolloClientSystemConsts;
 import com.ctrip.framework.apollo.core.ServiceNameConsts;

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultConfig.java

@@ -16,8 +16,7 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CLIENT_CONFIGCHANGES;
-
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 import com.ctrip.framework.apollo.core.utils.DeferredLoggerFactory;
 import com.ctrip.framework.apollo.enums.ConfigSourceType;
 import com.google.common.collect.Maps;

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultConfigManager.java

@@ -16,17 +16,16 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloNamespaceCollector.NAMESPACE_MONITOR;
-import static com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloNamespaceCollector.NAMESPACE_USAGE_COUNT;
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.APOLLO_CLIENT_NAMESPACE_USAGE;
 
 import com.ctrip.framework.apollo.Config;
 import com.ctrip.framework.apollo.ConfigFile;
 import com.ctrip.framework.apollo.build.ApolloInjector;
 import com.ctrip.framework.apollo.core.enums.ConfigFileFormat;
-import com.ctrip.framework.apollo.monitor.internal.MonitorConstant;
-import com.ctrip.framework.apollo.monitor.internal.model.MetricsEvent;
+import com.ctrip.framework.apollo.enums.ConfigSourceType;
 import com.ctrip.framework.apollo.spi.ConfigFactory;
 import com.ctrip.framework.apollo.spi.ConfigFactoryManager;
+import com.ctrip.framework.apollo.tracer.Tracer;
 import com.google.common.collect.Maps;
 import java.util.Map;
 
@@ -62,10 +61,9 @@ public Config getConfig(String namespace) {
         }
       }
     }
-
-    MetricsEvent.builder().withName(NAMESPACE_USAGE_COUNT)
-        .putAttachment(MonitorConstant.NAMESPACE, namespace)
-        .withTag(NAMESPACE_MONITOR).push();
+    if(!ConfigSourceType.NONE.equals(config.getSourceType())) {
+      Tracer.logMetricsForCount(APOLLO_CLIENT_NAMESPACE_USAGE+":"+namespace);
+    }
 
     return config;
   }

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/DefaultInjector.java

@@ -19,10 +19,10 @@
 import com.ctrip.framework.apollo.exceptions.ApolloConfigException;
 import com.ctrip.framework.apollo.monitor.api.ConfigMonitor;
 import com.ctrip.framework.apollo.monitor.internal.DefaultConfigMonitor;
-import com.ctrip.framework.apollo.monitor.internal.exporter.internals.DefaultMetricsExporterFactory;
-import com.ctrip.framework.apollo.monitor.internal.collector.MetricsCollectorManager;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultMetricsCollectorManager;
-import com.ctrip.framework.apollo.monitor.internal.exporter.MetricsExporterFactory;
+import com.ctrip.framework.apollo.monitor.internal.exporter.impl.DefaultApolloClientMetricsExporterFactory;
+import com.ctrip.framework.apollo.monitor.internal.listener.ApolloClientMetricsEventListenerManager;
+import com.ctrip.framework.apollo.monitor.internal.listener.impl.DefaultApolloClientMetricsEventListenerManager;
+import com.ctrip.framework.apollo.monitor.internal.exporter.ApolloClientMetricsExporterFactory;
 import com.ctrip.framework.apollo.spi.ApolloInjectorCustomizer;
 import com.ctrip.framework.apollo.spi.ConfigFactory;
 import com.ctrip.framework.apollo.spi.ConfigFactoryManager;
@@ -113,8 +113,9 @@ protected void configure() {
       bind(YamlParser.class).in(Singleton.class);
       bind(PropertiesFactory.class).to(DefaultPropertiesFactory.class).in(Singleton.class);
       bind(ConfigMonitor.class).to(DefaultConfigMonitor.class).in(Singleton.class);
-      bind(MetricsCollectorManager.class).to(DefaultMetricsCollectorManager.class).in(Singleton.class);
-      bind(MetricsExporterFactory.class).to(DefaultMetricsExporterFactory.class).in(Singleton.class);
+      bind(ApolloClientMetricsEventListenerManager.class).to(
+          DefaultApolloClientMetricsEventListenerManager.class).in(Singleton.class);
+      bind(ApolloClientMetricsExporterFactory.class).to(DefaultApolloClientMetricsExporterFactory.class).in(Singleton.class);
     }
   }
 }

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/LocalFileConfigRepository.java

@@ -16,8 +16,7 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIG_EXCEPTION;
-
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 import com.ctrip.framework.apollo.core.utils.DeferredLoggerFactory;
 import com.ctrip.framework.apollo.enums.ConfigSourceType;
 import java.io.File;

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/RemoteConfigLongPollService.java

@@ -16,9 +16,7 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.MonitorConstant.NAMESPACE;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIG_EXCEPTION;
-
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 import com.ctrip.framework.apollo.build.ApolloInjector;
 import com.ctrip.framework.apollo.core.ConfigConsts;
 import com.ctrip.framework.apollo.core.dto.ApolloConfigNotification;
@@ -31,8 +29,6 @@
 import com.ctrip.framework.apollo.core.utils.ApolloThreadFactory;
 import com.ctrip.framework.apollo.core.utils.StringUtils;
 import com.ctrip.framework.apollo.exceptions.ApolloConfigException;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloNamespaceCollector;
-import com.ctrip.framework.apollo.monitor.internal.model.MetricsEvent;
 import com.ctrip.framework.apollo.spi.ConfigServiceLoadBalancerClient;
 import com.ctrip.framework.apollo.tracer.Tracer;
 import com.ctrip.framework.apollo.tracer.spi.Transaction;
@@ -219,9 +215,7 @@ private void doLongPollingRefresh(String appId, String cluster, String dataCente
         transaction.setStatus(ex);
         long sleepTimeInSecond = m_longPollFailSchedulePolicyInSecond.fail();
         if (ex.getCause() instanceof SocketTimeoutException) {
-          MetricsEvent.builder().withName(DefaultApolloNamespaceCollector.NAMESPACE_TIMEOUT)
-              .putAttachment(NAMESPACE, assembleNamespaces())
-              .withTag(DefaultApolloNamespaceCollector.NAMESPACE_MONITOR).push();
+          Tracer.logEvent(APOLLO_CLIENT_NAMESPACE_TIMEOUT,assembleNamespaces());
         }
         logger.warn(
             "Long polling failed, will retry in {} seconds. appId: {}, cluster: {}, namespaces: {}, long polling url: {}, reason: {}",

apollo-client/src/main/java/com/ctrip/framework/apollo/internals/RemoteConfigRepository.java

@@ -16,14 +16,7 @@
  */
 package com.ctrip.framework.apollo.internals;
 
-import static com.ctrip.framework.apollo.monitor.internal.MonitorConstant.NAMESPACE;
-import static com.ctrip.framework.apollo.monitor.internal.MonitorConstant.TIMESTAMP;
-import static com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloNamespaceCollector.NAMESPACE_MONITOR;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CLIENT_CONFIGS;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CLIENT_CONFIGMETA;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CLIENT_VERSION;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIGSERVICE;
-import static com.ctrip.framework.apollo.monitor.internal.tracer.MessageProducerComposite.APOLLO_CONFIG_EXCEPTION;
+import static com.ctrip.framework.apollo.monitor.internal.ApolloClientMonitorConstant.*;
 
 import com.ctrip.framework.apollo.Apollo;
 import com.ctrip.framework.apollo.build.ApolloInjector;
@@ -40,8 +33,6 @@
 import com.ctrip.framework.apollo.enums.ConfigSourceType;
 import com.ctrip.framework.apollo.exceptions.ApolloConfigException;
 import com.ctrip.framework.apollo.exceptions.ApolloConfigStatusCodeException;
-import com.ctrip.framework.apollo.monitor.internal.collector.internal.DefaultApolloNamespaceCollector;
-import com.ctrip.framework.apollo.monitor.internal.model.MetricsEvent;
 import com.ctrip.framework.apollo.tracer.Tracer;
 import com.ctrip.framework.apollo.tracer.spi.Transaction;
 import com.ctrip.framework.apollo.util.ConfigUtil;
@@ -124,10 +115,8 @@ public Properties getConfig() {
     if (m_configCache.get() == null) {
       long start = System.currentTimeMillis();
       this.sync();
-      MetricsEvent.builder().withName(DefaultApolloNamespaceCollector.NAMESPACE_FIRST_LOAD_SPEND).withTag(
-              NAMESPACE_MONITOR)
-          .putAttachment(NAMESPACE, m_namespace)
-          .putAttachment(TIMESTAMP, System.currentTimeMillis() - start).push();
+      Tracer.logEvent(APOLLO_CLIENT_NAMESPACE_FIRST_LOAD_SPEND+m_namespace,
+          String.valueOf(System.currentTimeMillis() - start));
     }
     return transformApolloConfigToProperties(m_configCache.get());
   }
@@ -278,8 +267,8 @@ private ApolloConfig loadApolloConfig() {
                 appId, cluster, m_namespace);
             statusCodeException = new ApolloConfigStatusCodeException(ex.getStatusCode(),
                 message);
-            MetricsEvent.builder().withName(DefaultApolloNamespaceCollector.NAMESPACE_NOT_FOUND).withTag(
-                NAMESPACE_MONITOR).putAttachment(NAMESPACE, m_namespace).push();
+            Tracer.logEvent(APOLLO_CLIENT_NAMESPACE_NOT_FOUND,m_namespace);
+
           }
           Tracer.logEvent(APOLLO_CONFIG_EXCEPTION, ExceptionUtil.getDetailMessage(statusCodeException));
           transaction.setStatus(statusCodeException);