Prometheus for management

docker/latest/consumers/consumers.yaml

@@ -11,7 +11,8 @@ consumer:
   graphite:
     host: "graphite"
   metrics:
-    graphiteReporterEnabled: true
+    metric-registry:
+      graphiteReporterEnabled: true
   workload:
     consumerPerSubscription: 1
   schema:

docker/latest/frontend/frontend.yaml

@@ -11,7 +11,8 @@ frontend:
   graphite:
     host: "graphite"
   metrics:
-    graphiteReporterEnabled: true
+    metric-registry:
+      graphiteReporterEnabled: true
   schema:
     cache:
       refreshAfterWrite: 1m

docker/latest/management/management.yaml

@@ -44,10 +44,7 @@ management:
     enabled: true
   consumer-groups:
     create-manually: true
-  metrics:
-    export:
-      prometheus:
-        enabled: false
+
 
 audit.enabled: false
 

hermes-management/src/main/java/pl/allegro/tech/hermes/management/config/ManagementConfiguration.java

@@ -7,15 +7,17 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
 import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
-import io.micrometer.core.instrument.MeterRegistry;
-import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
+import io.micrometer.prometheus.PrometheusConfig;
+import io.micrometer.prometheus.PrometheusMeterRegistry;
 import org.springframework.beans.factory.annotation.Autowired;
 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 pl.allegro.tech.hermes.api.Topic;
 import pl.allegro.tech.hermes.common.clock.ClockFactory;
+import pl.allegro.tech.hermes.common.di.factories.MicrometerRegistryParameters;
+import pl.allegro.tech.hermes.common.di.factories.PrometheusMeterRegistryFactory;
 import pl.allegro.tech.hermes.management.domain.subscription.SubscriptionLagSource;
 import pl.allegro.tech.hermes.management.infrastructure.metrics.NoOpSubscriptionLagSource;
 
@@ -26,7 +28,10 @@
         TopicProperties.class,
         MetricsProperties.class,
         HttpClientProperties.class,
-        ConsistencyCheckerProperties.class})
+        ConsistencyCheckerProperties.class,
+        PrometheusProperties.class,
+        MicrometerRegistryProperties.class
+})
 public class ManagementConfiguration {
 
     @Autowired
@@ -57,8 +62,16 @@ public MetricRegistry metricRegistry() {
 
     @Bean
     @ConditionalOnMissingBean
-    public MeterRegistry micrometerRegistry() {
-        return new SimpleMeterRegistry();
+    public PrometheusMeterRegistry micrometerRegistry(MicrometerRegistryParameters micrometerRegistryParameters,
+                                                      PrometheusConfig prometheusConfig) {
+        return new PrometheusMeterRegistryFactory(micrometerRegistryParameters,
+                prometheusConfig, "hermes-management").provide();
+    }
+
+    @Bean
+    @ConditionalOnMissingBean
+    PrometheusConfig prometheusConfig(PrometheusProperties properties) {
+        return new PrometheusConfigAdapter(properties);
     }
 
     @Bean

hermes-management/src/main/java/pl/allegro/tech/hermes/management/config/MicrometerRegistryProperties.java

@@ -0,0 +1,21 @@
+package pl.allegro.tech.hermes.management.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import pl.allegro.tech.hermes.common.di.factories.MicrometerRegistryParameters;
+
+import java.util.List;
+
+@ConfigurationProperties(prefix = "metrics.micrometer")
+public class MicrometerRegistryProperties implements MicrometerRegistryParameters {
+
+    private List<Double> percentiles = List.of(0.5, 0.99, 0.999);
+
+    @Override
+    public List<Double> getPercentiles() {
+        return percentiles;
+    }
+
+    public void setPercentiles(List<Double> percentiles) {
+        this.percentiles = percentiles;
+    }
+}

hermes-management/src/main/java/pl/allegro/tech/hermes/management/config/PrometheusConfigAdapter.java

@@ -0,0 +1,32 @@
+package pl.allegro.tech.hermes.management.config;
+
+import io.micrometer.prometheus.PrometheusConfig;
+
+import java.time.Duration;
+
+public class PrometheusConfigAdapter implements PrometheusConfig {
+
+    private final PrometheusProperties prometheusReporterProperties;
+
+    public PrometheusConfigAdapter(PrometheusProperties prometheusReporterProperties) {
+        this.prometheusReporterProperties = prometheusReporterProperties;
+    }
+
+    @Override
+    public boolean descriptions() {
+        return prometheusReporterProperties.isDescriptions();
+    }
+
+    @Override
+    public Duration step() {
+        return prometheusReporterProperties.getStep();
+    }
+
+    /**
+     * Returning null is fine since we override all the methods from PrometheusConfig.
+     */
+    @Override
+    public String get(String key) {
+        return null;  // Nothing to see here, move along.
+    }
+}

hermes-management/src/main/java/pl/allegro/tech/hermes/management/config/PrometheusProperties.java

@@ -0,0 +1,28 @@
+package pl.allegro.tech.hermes.management.config;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+import java.time.Duration;
+
+@ConfigurationProperties(prefix = "metrics.prometheus")
+public class PrometheusProperties {
+
+    private Duration step = Duration.ofMinutes(1);
+    private boolean descriptions = true;
+
+    public Duration getStep() {
+        return this.step;
+    }
+
+    public void setStep(Duration step) {
+        this.step = step;
+    }
+
+    public boolean isDescriptions() {
+        return this.descriptions;
+    }
+
+    public void setDescriptions(boolean descriptions) {
+        this.descriptions = descriptions;
+    }
+}

hermes-management/src/main/resources/application.yaml

@@ -30,20 +30,15 @@ server:
 management:
   endpoints:
     web:
-      base-path: /
+      base-path: /status
+      exposure:
+        include: health, prometheus
   rest-template:
     connect-timeout: 2000
     read-timeout: 2000
-  server:
-    servlet:
-      context-path: /
   health:
     periodSeconds: 30
     enabled: true
-  metrics:
-    export:
-      prometheus:
-        enabled: false
 
 audit:
   isLoggingAuditEnabled: false

hermes-management/src/test/resources/application.yaml

@@ -9,10 +9,6 @@ storage:
   connectionString: localhost:42182
 
 # this is a hack to make /status/* endpoints work with Jersey
-management:
-  server:
-    servlet:
-      context-path: /
 spring:
   mvc:
     servlet:

integration/src/test/resources/application.yaml

@@ -60,13 +60,6 @@ management:
   endpoints:
     web:
       base-path: /status
-  server:
-    servlet:
-      context-path: /
-  metrics:
-    export:
-      prometheus:
-        enabled: false
 
 spring.groovy.template.check-template-location: false