Merge pull request #24 from armory-plugins/fix-prom-endpoint

fix(prometheus): Expose aop-prometheus endpoint for scraping metric data.

Author: jasonmcintosh

.gitignore

@@ -6,3 +6,5 @@ build
 
 .idea
 .vscode
+*.ipr
+*.iws

build.gradle

@@ -2,6 +2,7 @@ plugins {
     id("com.palantir.git-version").version("0.12.2")
     id("io.spinnaker.plugin.bundler").version("$spinnakerGradleVersion")
     id "com.github.kt3k.coveralls" version "2.9.0"
+    id 'idea'
 }
 
 spinnakerBundle {

common/src/main/java/io/armory/plugin/observability/ArmoryObservabilityPlugin.java

@@ -18,9 +18,10 @@
 
 import com.netflix.spinnaker.kork.plugins.api.spring.PrivilegedSpringPlugin;
 import io.armory.plugin.observability.model.PluginConfig;
+import io.armory.plugin.observability.model.SecurityConfig;
 import io.armory.plugin.observability.newrelic.NewRelicRegistrySupplier;
-import io.armory.plugin.observability.promethus.PrometheusRegistrySupplier;
-import io.armory.plugin.observability.promethus.PrometheusScrapeEndpoint;
+import io.armory.plugin.observability.prometheus.PrometheusRegistrySupplier;
+import io.armory.plugin.observability.prometheus.PrometheusScrapeEndpoint;
 import io.armory.plugin.observability.registry.AddDefaultTagsRegistryCustomizer;
 import io.armory.plugin.observability.registry.AddFiltersRegistryCustomizer;
 import io.armory.plugin.observability.registry.ArmoryObservabilityCompositeRegistry;
@@ -49,6 +50,7 @@ public void registerBeanDefinitions(BeanDefinitionRegistry registry) {
       registerBean(beanDefinitionFor(AddDefaultTagsRegistryCustomizer.class), registry);
       registerBean(beanDefinitionFor(MeterFilterService.class), registry);
       registerBean(beanDefinitionFor(AddFiltersRegistryCustomizer.class), registry);
+      registerBean(beanDefinitionFor(SecurityConfig.class), registry);
 
       // Prometheus Beans
       registerBean(beanDefinitionFor(CollectorRegistry.class), registry);

common/src/main/java/io/armory/plugin/observability/model/PluginConfig.java

@@ -17,24 +17,12 @@
 package io.armory.plugin.observability.model;
 
 import lombok.Data;
-import org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.context.annotation.Configuration;
-import org.springframework.security.config.annotation.web.builders.HttpSecurity;
-import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
 
 @Data
 @Configuration
 @ConfigurationProperties("spinnaker.extensibility.plugins.armory.observability-plugin.config")
-public class PluginConfig extends WebSecurityConfigurerAdapter {
+public class PluginConfig  {
     PluginMetricsConfig metrics = new PluginMetricsConfig();
-
-    @Override
-    protected void configure(HttpSecurity http) throws Exception {
-        if (metrics.getPrometheus().isEnabled()) {
-            http.requestMatcher(EndpointRequest.to("aop-prometheus")).authorizeRequests((requests) ->
-                    requests.anyRequest().permitAll());
-        }
-    }
-
 }

common/src/main/java/io/armory/plugin/observability/model/SecurityConfig.java

@@ -0,0 +1,33 @@
+package io.armory.plugin.observability.model;
+
+import org.springframework.boot.actuate.autoconfigure.security.servlet.EndpointRequest;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.Order;
+import org.springframework.security.config.annotation.web.builders.HttpSecurity;
+import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
+import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
+
+//To avoid collision with other WebSecurityConfigurerAdapters
+@Order(Ordered.HIGHEST_PRECEDENCE + 27)
+@Configuration
+@EnableWebSecurity
+public class SecurityConfig extends WebSecurityConfigurerAdapter {
+
+    private final PluginConfig pluginConfig;
+
+    public SecurityConfig(PluginConfig pluginConfig) {
+        this.pluginConfig = pluginConfig;
+    }
+
+    @Override
+    protected void configure(HttpSecurity http) throws Exception {
+       if (pluginConfig.getMetrics().getPrometheus().isEnabled()) {
+           http.requestMatcher(EndpointRequest.to("aop-prometheus")).authorizeRequests((requests) ->
+                   requests.anyRequest().permitAll());
+       } else {
+           http.requestMatcher(EndpointRequest.to("aop-prometheus")).authorizeRequests((requests) ->
+                   requests.anyRequest().denyAll());
+       }
+    }
+}

common/src/main/java/io/armory/plugin/observability/promethus/PrometheusRegistryConfig.java renamed to common/src/main/java/io/armory/plugin/observability/prometheus/PrometheusRegistryConfig.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.armory.plugin.observability.promethus;
+package io.armory.plugin.observability.prometheus;
 
 import io.armory.plugin.observability.model.PluginMetricsPrometheusConfig;
 import io.micrometer.prometheus.PrometheusConfig;

common/src/main/java/io/armory/plugin/observability/promethus/PrometheusRegistrySupplier.java renamed to common/src/main/java/io/armory/plugin/observability/prometheus/PrometheusRegistrySupplier.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.armory.plugin.observability.promethus;
+package io.armory.plugin.observability.prometheus;
 
 import io.armory.plugin.observability.model.PluginConfig;
 import io.armory.plugin.observability.model.PluginMetricsPrometheusConfig;

common/src/main/java/io/armory/plugin/observability/promethus/PrometheusScrapeEndpoint.java renamed to common/src/main/java/io/armory/plugin/observability/prometheus/PrometheusScrapeEndpoint.java

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-package io.armory.plugin.observability.promethus;
+package io.armory.plugin.observability.prometheus;
 
 import io.prometheus.client.Collector;
 import io.prometheus.client.CollectorRegistry;

common/src/test/java/io/armory/plugin/observability/prometheus/PrometheusRegistryConfigTest.java

@@ -20,7 +20,7 @@
 import static org.junit.Assert.assertNull;
 
 import io.armory.plugin.observability.model.PluginMetricsPrometheusConfig;
-import io.armory.plugin.observability.promethus.PrometheusRegistryConfig;
+import io.armory.plugin.observability.prometheus.PrometheusRegistryConfig;
 import java.time.Duration;
 import org.junit.Before;
 import org.junit.Test;

common/src/test/java/io/armory/plugin/observability/prometheus/PrometheusRegistrySupplierTest.java

@@ -23,7 +23,7 @@
 import io.armory.plugin.observability.model.PluginConfig;
 import io.armory.plugin.observability.model.PluginMetricsConfig;
 import io.armory.plugin.observability.model.PluginMetricsPrometheusConfig;
-import io.armory.plugin.observability.promethus.PrometheusRegistrySupplier;
+import io.armory.plugin.observability.prometheus.PrometheusRegistrySupplier;
 import io.micrometer.core.instrument.Clock;
 import io.prometheus.client.CollectorRegistry;
 import org.junit.Before;