SOFALookout as Actuator default Metrics Impl enhancement (#18)

Actuator API adapter to lookout

Author: guanchao-yang

client/lookout-common/src/main/java/com/alipay/lookout/common/utils/CommonUtil.java

@@ -0,0 +1,44 @@
+/*
+ * 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 com.alipay.lookout.common.utils;
+
+import com.alipay.lookout.api.Id;
+import com.alipay.lookout.api.Tag;
+
+/**
+ * CommonUtil
+ *
+ * @author yangguanchao
+ * @since 2018/06/19
+ */
+public class CommonUtil {
+
+    /**
+     * Convert a dimensional metric id {@link Id} to  a hierarchical metric name.
+     *
+     * @param id a dimensional metric id
+     * @return hierarchical metric name
+     */
+    public static String toMetricName(Id id) {
+        StringBuilder buf = new StringBuilder();
+        buf.append(id.name());
+        for (Tag t : id.tags()) {
+            buf.append('.').append(t.key()).append('-').append(t.value());
+        }
+        return buf.toString();
+    }
+}

client/lookout-ext-jvm/src/main/java/com/alipay/lookout/jvm/JvmSystemPropertiesInfoMetricImporter.java

@@ -31,15 +31,15 @@ public class JvmSystemPropertiesInfoMetricImporter implements MetricsImporter {
 
     @Override
     public void register(Registry registry) {
-        Id id = registry.createId("jvm.system.properties");
+        Id id = registry.createId(LookoutIdNameConstants.JVM_SYSTEM_PROP_NAME);
         registry.info(id, new Info<Properties>() {
             @Override
             public Properties value() {
                 return System.getProperties();
             }
         });
 
-        Id envId = registry.createId("jvm.system.env");
+        Id envId = registry.createId(LookoutIdNameConstants.JVM_SYSTEM_ENV_NAME);
         registry.info(envId, new Info<Map<String, String>>() {
             @Override
             public Map<String, String> value() {

client/lookout-ext-jvm/src/main/java/com/alipay/lookout/jvm/LookoutIdNameConstants.java

@@ -0,0 +1,30 @@
+/*
+ * 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 com.alipay.lookout.jvm;
+
+/**
+ * LookoutIdNameConstants
+ *
+ * @author yangguanchao
+ * @since 2018/01/27
+ */
+public class LookoutIdNameConstants {
+
+    public static final String JVM_SYSTEM_PROP_NAME = "jvm.system.properties";
+
+    public static final String JVM_SYSTEM_ENV_NAME  = "jvm.system.env";
+}

client/lookout-reg-dropwizard/src/main/java/com/alipay/lookout/dropwizard/metrics/DropWizardMetricsRegistry.java

@@ -35,6 +35,7 @@
 /**
  * Created by [email protected] on 2017/1/26.
  */
+@Deprecated
 public class DropWizardMetricsRegistry extends MetricRegistry {
     protected final Logger                            logger        = LookoutLoggerFactory
                                                                         .getLogger(DropWizardMetricsRegistry.class);

client/lookout-reg-dropwizard/src/main/java/com/alipay/lookout/dropwizard/metrics/NameUtils.java

@@ -17,7 +17,7 @@
 package com.alipay.lookout.dropwizard.metrics;
 
 import com.alipay.lookout.api.Id;
-import com.alipay.lookout.api.Tag;
+import com.alipay.lookout.common.utils.CommonUtil;
 
 /**
  * http://metrics20.org/
@@ -36,12 +36,7 @@ private NameUtils() {
      * @return hierarchical metric name
      */
     static String toMetricName(Id id) {
-        StringBuilder buf = new StringBuilder();
-        buf.append(id.name());
-        for (Tag t : id.tags()) {
-            buf.append('.').append(t.key()).append('-').append(t.value());
-        }
-        return buf.toString();
+        return CommonUtil.toMetricName(id);
     }
 
 }

client/lookout-reg-prometheus/src/main/java/com/alipay/lookout/reg/prometheus/exporter/ExporterServer.java

@@ -39,7 +39,8 @@ public ExporterServer(int port) {
             httpServer = HttpServer.create(new InetSocketAddress(port), 2);
             httpServer.setExecutor(singleThreadPool);
         } catch (IOException e) {
-            throw new RuntimeException("prometheus exporter server create err!", e);
+            throw new RuntimeException("prometheus exporter server create err! And port = " + port,
+                e);
         }
     }
 

client/lookout-reg-server/src/main/java/com/alipay/lookout/remote/step/LookoutRegistry.java

@@ -47,29 +47,43 @@ public final class LookoutRegistry extends StepRegistry implements CommonTagsAcc
      */
     public LookoutRegistry(Clock clock, MetricObserver<LookoutMeasurement> observer,
                            LookoutConfig config) {
+        this(clock, observer, config, null);
+    }
+
+    public LookoutRegistry(Clock clock, MetricObserver<LookoutMeasurement> observer,
+                           LookoutConfig config, AddressService addressService) {
         super(clock, config);
         if (observer == null) {
-            observer = new HttpObserver(config, getAddressService(config), this,
-                new ReportDecider());
+            observer = new HttpObserver(config, addressService == null ? getAddressService(config)
+                : addressService, this, new ReportDecider());
         }
         addMetricObserver(observer);
         this.poller = new SchedulerPoller(this, config, metricObserverComposite);
         this.poller.start();
     }
 
+    /***
+     * Generate Lookout AddressService
+     * @param config lookout config
+     * @return AddressService generated
+     */
+    public static AddressService getAddressService(LookoutConfig config) {
+        String addressServiceClassName = config.getString(LookoutConfig.ADDRESS_SERVICE_CLASS_NAME,
+            DefaultAddressService.class.getName());
+        return ClassUtil.newInstance(addressServiceClassName, new Class[] { String.class },
+            new Object[] { config.getString(LookoutConfig.APP_NAME) });
+    }
+
     public LookoutRegistry(LookoutConfig config) {
         this(Clock.SYSTEM, null, config);
     }
 
-    public LookoutRegistry(MetricObserver<LookoutMeasurement> observer) {
-        this(Clock.SYSTEM, observer, new LookoutConfig());
+    public LookoutRegistry(LookoutConfig config, AddressService addressService) {
+        this(Clock.SYSTEM, null, config, addressService);
     }
 
-    protected AddressService getAddressService(LookoutConfig config) {
-        String addressServiceClassName = config.getString(LookoutConfig.ADDRESS_SERVICE_CLASS_NAME,
-            DefaultAddressService.class.getName());
-        return ClassUtil.newInstance(addressServiceClassName, new Class[] { String.class },
-            new Object[] { config.getString(LookoutConfig.APP_NAME) });
+    public LookoutRegistry(MetricObserver<LookoutMeasurement> observer) {
+        this(Clock.SYSTEM, observer, new LookoutConfig());
     }
 
     @Override
@@ -79,8 +93,9 @@ public String getCommonTagValue(String name) {
 
     @Override
     public void setCommonTag(String name, String value) {
-        if (name != null && value != null)
+        if (name != null && value != null) {
             commonTags.put(name, value);
+        }
     }
 
     @Override

client/lookout-sofa-boot-starter/pom.xml

@@ -54,6 +54,11 @@
             <artifactId>lookout-reg-prometheus</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>io.dropwizard.metrics</groupId>
+            <artifactId>metrics-core</artifactId>
+            <scope>provided</scope>
+        </dependency>
         <!-- adapter spring boot v1 actuator begin-->
         <dependency>
             <groupId>org.springframework.boot</groupId>
@@ -65,11 +70,6 @@
             <artifactId>lookout-reg-dropwizard</artifactId>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-core</artifactId>
-            <scope>provided</scope>
-        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
@@ -81,6 +81,11 @@
             <artifactId>spring-boot-starter-test</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-web</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>

client/lookout-sofa-boot-starter/src/main/java/com/alipay/lookout/starter/LookoutClientProperties.java

@@ -38,9 +38,11 @@ public class LookoutClientProperties {
     private int     maxMetricsNum                = DEFAULT_MAX_METRICS_NUM;
 
     private int     reportBatchSize              = DEFAULT_REPORT_BATCH_SIZE;
+
     private boolean autopollEnable               = true;
 
     private boolean autopollInfoIgnore           = true;
+
     private int     prometheusExporterServerPort = DEFAULT_PROMETHEUS_EXPORTER_SERVER_PORT;
 
     public long getPollingInterval() {

client/lookout-sofa-boot-starter/src/main/java/com/alipay/lookout/starter/autoConfiguration/LookoutAutoConfiguration.java

@@ -22,20 +22,29 @@
 import com.alipay.lookout.client.DefaultLookoutClient;
 import com.alipay.lookout.core.config.LookoutConfig;
 import com.alipay.lookout.remote.model.LookoutMeasurement;
+import com.alipay.lookout.remote.report.AddressService;
+import com.alipay.lookout.remote.step.LookoutRegistry;
 import com.alipay.lookout.report.MetricObserver;
 import com.alipay.lookout.starter.LookoutClientProperties;
-import com.alipay.lookout.starter.support.reg.DropWizardMetricsRegistryFactory;
-import com.alipay.lookout.starter.support.reg.LookoutServerRegistryFactory;
-import com.alipay.lookout.starter.support.reg.MetricsRegistryFactory;
-import com.alipay.lookout.starter.support.reg.PrometheusMetricsRegistryFactory;
+import com.alipay.lookout.starter.support.actuator.LookoutSpringBootMetricsImpl;
+import com.alipay.lookout.starter.support.actuator.SpringBootActuatorRegistry;
+import com.alipay.lookout.starter.support.reader.LookoutRegistryMetricReader;
+import com.alipay.lookout.starter.support.reg.*;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.BeansException;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.BeanFactoryAware;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.actuate.autoconfigure.MetricsDropwizardAutoConfiguration;
+import org.springframework.boot.actuate.endpoint.MetricReaderPublicMetrics;
+import org.springframework.boot.actuate.metrics.CounterService;
+import org.springframework.boot.actuate.metrics.GaugeService;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
 import org.springframework.boot.autoconfigure.AutoConfigureOrder;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
@@ -52,6 +61,7 @@
 @AutoConfigureOrder(-100)
 @Configuration
 @EnableConfigurationProperties(LookoutClientProperties.class)
+@AutoConfigureBefore(MetricsDropwizardAutoConfiguration.class)
 public class LookoutAutoConfiguration implements BeanFactoryAware {
     private static final Logger                      logger = LoggerFactory
                                                                 .getLogger(LookoutAutoConfiguration.class);
@@ -76,9 +86,22 @@ public LookoutConfig lookoutConfig(LookoutClientProperties lookoutClientProperti
     }
 
     @Bean
+    @ConditionalOnMissingBean
     @ConditionalOnClass(name = "com.alipay.lookout.remote.step.LookoutRegistry")
-    public MetricsRegistryFactory lookoutServerRegistryFactory() {
-        return new LookoutServerRegistryFactory(metricObservers);
+    public AddressService lookoutAddressService(LookoutConfig config) {
+        return LookoutRegistry.getAddressService(config);
+    }
+
+    @Bean
+    @ConditionalOnClass(name = "com.alipay.lookout.remote.step.LookoutRegistry")
+    public MetricsRegistryFactory lookoutServerRegistryFactory(AddressService addressService) {
+        return new LookoutServerRegistryFactory(metricObservers, addressService);
+    }
+
+    @Bean
+    @ConditionalOnClass(name = "org.springframework.boot.actuate.metrics.Metric")
+    public SpringBootActuatorRegistryFactory springBootActuatorServerRegistryFactory() {
+        return new SpringBootActuatorRegistryFactory();
     }
 
     @Bean
@@ -130,6 +153,30 @@ public Registry registry(List<MetricsRegistryFactory> metricsRegistryFactoryList
         return lookoutClient.getRegistry();
     }
 
+    @Bean
+    @ConditionalOnMissingBean({ LookoutSpringBootMetricsImpl.class, CounterService.class,
+            GaugeService.class })
+    public LookoutSpringBootMetricsImpl lookoutMetricServices(Registry lookoutMetricRegistry) {
+        logger.info("Spring Boot Metrics binding to SOFALookout Implementation!");
+        return new LookoutSpringBootMetricsImpl(lookoutMetricRegistry);
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    @ConditionalOnBean(SpringBootActuatorRegistryFactory.class)
+    public LookoutRegistryMetricReader lookoutRegistryMetricReader(SpringBootActuatorRegistryFactory springBootActuatorRegistryFactory,
+                                                                   LookoutConfig lookoutConfig) {
+        SpringBootActuatorRegistry springBootActuatorRegistry = springBootActuatorRegistryFactory
+            .get(lookoutConfig);
+        return new LookoutRegistryMetricReader(springBootActuatorRegistry);
+    }
+
+    @Bean
+    @ConditionalOnBean(LookoutRegistryMetricReader.class)
+    public MetricReaderPublicMetrics lookoutPublicMetrics(LookoutRegistryMetricReader lookoutRegistryMetricReader) {
+        return new MetricReaderPublicMetrics(lookoutRegistryMetricReader);
+    }
+
     protected LookoutConfig buildLookoutConfig(LookoutClientProperties lookoutClientProperties) {
         LookoutConfig lookoutConfig = new LookoutConfig();
         lookoutConfig.setProperty(LOOKOUT_ENABLE, lookoutClientProperties.isEnable());
@@ -153,5 +200,4 @@ protected LookoutConfig buildLookoutConfig(LookoutClientProperties lookoutClient
         }
         return lookoutConfig;
     }
-
 }