Enhancement to add EnablePrometheusRSocketProxyServer annotation (#36)

smsteele · ss047890 · web-flow · commit 666f53f0278a · 2020-08-20T11:17:28.000-07:00
Co-authored-by: ss047890 &lt;scott.steele@cerner.com&gt;
diff --git a/proxy-server/build.gradle b/proxy-server/build.gradle
@@ -0,0 +1,29 @@
+plugins {
+    id 'java-library'
+    id 'io.spring.dependency-management' version '1.0.10.RELEASE'
+}
+
+repositories {
+    mavenCentral()
+}
+
+dependencyManagement {
+    imports {
+        mavenBom 'org.springframework.boot:spring-boot-dependencies:2.3.3.RELEASE'
+    }
+}
+
+dependencies {
+    implementation 'org.springframework.boot:spring-boot-starter-actuator'
+    implementation 'org.springframework.boot:spring-boot-starter-webflux'
+    implementation 'io.micrometer:micrometer-registry-prometheus'
+
+    implementation 'io.rsocket:rsocket-micrometer:1.0.2'
+    implementation 'io.rsocket:rsocket-transport-netty:1.0.2'
+
+    implementation 'org.xerial.snappy:snappy-java:latest.release'
+    annotationProcessor "org.springframework.boot:spring-boot-configuration-processor"
+
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+    testImplementation 'io.projectreactor:reactor-test'
+}
diff --git a/proxy-server/src/main/java/io/micrometer/prometheus/rsocket/PrometheusController.java b/proxy-server/src/main/java/io/micrometer/prometheus/rsocket/PrometheusController.java
@@ -58,7 +58,7 @@
  * @author Christian Tzolov
  */
 @RestController
-class PrometheusController {
+public class PrometheusController {
   private final PrometheusMeterRegistry meterRegistry;
   private final Timer scrapeTimerSuccess;
   private final Timer scrapeTimerClosed;
@@ -67,12 +67,11 @@ class PrometheusController {
   private final PrometheusControllerProperties properties;
   private final Map<RSocket, ConnectionState> scrapableApps = new ConcurrentHashMap<>();
 
-  PrometheusController(PrometheusMeterRegistry meterRegistry, PrometheusControllerProperties properties) {
+  public PrometheusController(PrometheusMeterRegistry meterRegistry, PrometheusControllerProperties properties) {
     this.meterRegistry = meterRegistry;
     this.metricsInterceptor = new MicrometerRSocketInterceptor(meterRegistry);
     this.properties = properties;
     meterRegistry.gaugeMapSize("prometheus.proxy.scrape.active.connections", Tags.empty(), scrapableApps);
-
     this.scrapeTimerSuccess = Timer.builder("prometheus.proxy.scrape")
         .tag("outcome", "success")
         .tag("exception", "none")
diff --git a/proxy-server/src/main/java/io/micrometer/prometheus/rsocket/PrometheusControllerProperties.java b/proxy-server/src/main/java/io/micrometer/prometheus/rsocket/PrometheusControllerProperties.java
diff --git a/proxy/build.gradle b/proxy/build.gradle
@@ -25,6 +25,7 @@ dependencies {
   implementation 'org.springframework.boot:spring-boot-starter-actuator'
   implementation 'org.springframework.boot:spring-boot-starter-webflux'
   implementation 'io.micrometer:micrometer-registry-prometheus'
+  implementation project(':prometheus-rsocket-spring')
 
   implementation 'io.rsocket:rsocket-micrometer:1.0.2'
   implementation 'io.rsocket:rsocket-transport-netty:1.0.2'
diff --git a/proxy/src/main/java/io/micrometer/prometheus/rsocket/PrometheusRSocketProxyMain.java b/proxy/src/main/java/io/micrometer/prometheus/rsocket/PrometheusRSocketProxyMain.java
@@ -15,12 +15,12 @@
  */
 package io.micrometer.prometheus.rsocket;
 
+import io.micrometer.prometheus.rsocket.autoconfigure.EnablePrometheusRSocketProxyServer;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
-import org.springframework.boot.context.properties.EnableConfigurationProperties;
 
 @SpringBootApplication
-@EnableConfigurationProperties(PrometheusControllerProperties.class)
+@EnablePrometheusRSocketProxyServer
 public class PrometheusRSocketProxyMain {
   public static void main(String[] args) {
     SpringApplication.run(PrometheusRSocketProxyMain.class, args);
diff --git a/settings.gradle b/settings.gradle
@@ -21,5 +21,9 @@ project(':prometheus-rsocket-proxy').projectDir = new File(rootProject.projectDi
 include 'prometheus-rsocket-client'
 project(':prometheus-rsocket-client').projectDir = new File(rootProject.projectDir, 'client')
 
+include 'prometheus-rsocket-proxy-server'
+project(':prometheus-rsocket-proxy-server').projectDir = new File(rootProject.projectDir, 'proxy-server')
+
 include 'prometheus-rsocket-spring'
-project(':prometheus-rsocket-spring').projectDir = new File(rootProject.projectDir, 'starter-spring')
+project(':prometheus-rsocket-spring').projectDir = new File(rootProject.projectDir, 'starter-spring')
+
diff --git a/starter-spring/build.gradle b/starter-spring/build.gradle
@@ -19,6 +19,7 @@ dependencies {
   implementation 'org.springframework.boot:spring-boot-actuator-autoconfigure'
   implementation 'org.springframework.boot:spring-boot-autoconfigure'
   implementation project(':prometheus-rsocket-client')
+  implementation project(':prometheus-rsocket-proxy-server')
 
   implementation 'io.rsocket:rsocket-transport-netty:1.0.2'
 
diff --git a/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/EnablePrometheusRSocketProxyServer.java b/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/EnablePrometheusRSocketProxyServer.java
@@ -0,0 +1,36 @@
+/**
+ * Copyright 2020 Pivotal Software, Inc.
+ * <p>
+ * Licensed 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.micrometer.prometheus.rsocket.autoconfigure;
+
+import io.micrometer.prometheus.rsocket.PrometheusController;
+import org.springframework.context.annotation.Import;
+
+import java.lang.annotation.*;
+
+/**
+ * Annotation to activate Prometheus RSocket Proxy Server related configuration.
+ * {@link PrometheusController}
+ *
+ * @author Scott Steele
+ * @author Doug Saus
+ */
+@Target(ElementType.TYPE)
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Import(PrometheusRSocketProxyServerMarkerConfiguration.class)
+public @interface EnablePrometheusRSocketProxyServer {
+
+}
diff --git a/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketClientAutoConfiguration.java b/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketClientAutoConfiguration.java
@@ -16,11 +16,8 @@
 
 package io.micrometer.prometheus.rsocket.autoconfigure;
 
-import io.micrometer.core.instrument.Clock;
-import io.micrometer.prometheus.PrometheusConfig;
 import io.micrometer.prometheus.PrometheusMeterRegistry;
 import io.micrometer.prometheus.rsocket.PrometheusRSocketClient;
-import io.prometheus.client.CollectorRegistry;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.prometheus.PrometheusMetricsExportAutoConfiguration;
 import org.springframework.boot.autoconfigure.AutoConfigureAfter;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -35,36 +32,12 @@
 @AutoConfigureAfter(PrometheusMetricsExportAutoConfiguration.class)
 @ConditionalOnClass(PrometheusMeterRegistry.class)
 @ConditionalOnProperty(prefix = "management.metrics.export.prometheus.rsocket", name = "enabled", havingValue = "true", matchIfMissing = true)
-@EnableConfigurationProperties(PrometheusRSocketProperties.class)
-public class PrometheusRSocketAutoConfiguration {
-
-  @ConditionalOnMissingBean
-  @Bean
-  Clock micrometerClock() {
-    return Clock.SYSTEM;
-  }
-
-  @ConditionalOnMissingBean
-  @Bean
-  PrometheusConfig prometheusConfig() {
-    return PrometheusConfig.DEFAULT;
-  }
-
-  @ConditionalOnMissingBean
-  @Bean
-  CollectorRegistry prometheusCollectorRegistry() {
-    return new CollectorRegistry(true);
-  }
-
-  @ConditionalOnMissingBean
-  @Bean
-  PrometheusMeterRegistry prometheusMeterRegistry(PrometheusConfig config, CollectorRegistry collectorRegistry, Clock clock) {
-    return new PrometheusMeterRegistry(config, collectorRegistry, clock);
-  }
+@EnableConfigurationProperties(PrometheusRSocketClientProperties.class)
+public class PrometheusRSocketClientAutoConfiguration {
 
   @ConditionalOnMissingBean
   @Bean(destroyMethod = "pushAndClose")
-  PrometheusRSocketClient prometheusRSocketClient(PrometheusMeterRegistry meterRegistry, PrometheusRSocketProperties properties) {
+  PrometheusRSocketClient prometheusRSocketClient(PrometheusMeterRegistry meterRegistry, PrometheusRSocketClientProperties properties) {
     return PrometheusRSocketClient.build(meterRegistry, properties.createClientTransport())
         .retry(Retry.backoff(properties.getMaxRetries(), properties.getFirstBackoff())
             .maxBackoff(properties.getMaxBackoff()))
diff --git a/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketClientProperties.java b/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketClientProperties.java
@@ -26,7 +26,7 @@
 import java.time.Duration;
 
 @ConfigurationProperties("management.metrics.export.prometheus.rsocket")
-public class PrometheusRSocketProperties {
+public class PrometheusRSocketClientProperties {
 
   /**
    * The host name of the proxy to connect to.
diff --git a/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketProxyServerAutoConfiguration.java b/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketProxyServerAutoConfiguration.java
@@ -0,0 +1,51 @@
+/**
+ * Copyright 2020 Pivotal Software, Inc.
+ * <p>
+ * Licensed 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.micrometer.prometheus.rsocket.autoconfigure;
+
+import io.micrometer.prometheus.PrometheusMeterRegistry;
+import io.micrometer.prometheus.rsocket.PrometheusController;
+import io.micrometer.prometheus.rsocket.PrometheusControllerProperties;
+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;
+import org.springframework.context.annotation.Lazy;
+
+/**
+ * Conditionally creates a {@link PrometheusController} bean if one does not already exist.
+ * Creation is dependent on the presence of {@link PrometheusRSocketProxyServerMarkerConfiguration.Marker}
+ * and {@link PrometheusMeterRegistry} beans. The marker can be created through the use of the
+ * {@link EnablePrometheusRSocketProxyServer} annotation.
+ *
+ * @author Scott Steele
+ * @author Doug Saus
+ */
+@Configuration(proxyBeanMethods = false)
+@ConditionalOnClass(PrometheusMeterRegistry.class)
+@ConditionalOnBean(PrometheusRSocketProxyServerMarkerConfiguration.Marker.class)
+@EnableConfigurationProperties(PrometheusControllerProperties.class)
+@Lazy(value = false)
+class PrometheusRSocketProxyServerAutoConfiguration {
+
+  @ConditionalOnMissingBean
+  @Bean
+  PrometheusController prometheusController(PrometheusMeterRegistry meterRegistry, PrometheusControllerProperties controllerProperties) {
+    return new PrometheusController(meterRegistry, controllerProperties);
+  }
+
+}
diff --git a/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketProxyServerMarkerConfiguration.java b/starter-spring/src/main/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketProxyServerMarkerConfiguration.java
@@ -0,0 +1,39 @@
+/**
+ * Copyright 2020 Pivotal Software, Inc.
+ * <p>
+ * Licensed 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
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * 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 io.micrometer.prometheus.rsocket.autoconfigure;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * A configuration class that supplies a marker bean used to trigger {@link PrometheusRSocketClientAutoConfiguration}.
+ *
+ * @author Scott Steele
+ * @author Doug Saus
+ */
+@Configuration(proxyBeanMethods = false)
+class PrometheusRSocketProxyServerMarkerConfiguration {
+
+  @Bean
+  Marker prometheusRSocketProxyServerMarker() {
+    return new Marker();
+  }
+
+  static class Marker {
+
+  }
+
+}
diff --git a/starter-spring/src/main/resources/META-INF/spring.factories b/starter-spring/src/main/resources/META-INF/spring.factories
@@ -1,2 +1,3 @@
 org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
-io.micrometer.prometheus.rsocket.autoconfigure.PrometheusRSocketAutoConfiguration
+io.micrometer.prometheus.rsocket.autoconfigure.PrometheusRSocketClientAutoConfiguration,\
+io.micrometer.prometheus.rsocket.autoconfigure.PrometheusRSocketProxyServerAutoConfiguration
diff --git a/starter-spring/src/test/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketClientAutoConfigurationTest.java b/starter-spring/src/test/java/io/micrometer/prometheus/rsocket/autoconfigure/PrometheusRSocketClientAutoConfigurationTest.java
@@ -37,12 +37,12 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 
-class PrometheusRSocketAutoConfigurationTest {
+class PrometheusRSocketClientAutoConfigurationTest {
   private final ApplicationContextRunner contextRunner = new ApplicationContextRunner()
       .withConfiguration(AutoConfigurations.of(
           MetricsAutoConfiguration.class,
           PrometheusMetricsExportAutoConfiguration.class,
-          PrometheusRSocketAutoConfiguration.class
+          PrometheusRSocketClientAutoConfiguration.class
       ));
 
   private Mono<CloseableChannel> startServer(ServerTransport<CloseableChannel> serverTransport, CountDownLatch latch) {
