Support for custom ports for MP Health and MP Metrics. (helidon-io#570)

* Support for custom ports for MP Health and MP Metrics.

Signed-off-by: Tomas Langer <tomas.langer@oracle.com>

* Copyright added.

Signed-off-by: Tomas Langer <tomas.langer@oracle.com>

* Test and copyright fix.

Signed-off-by: Tomas Langer <tomas.langer@oracle.com>

Author: tomas-langer

health/health/pom.xml

@@ -68,5 +68,11 @@
             <artifactId>junit-jupiter-params</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>io.helidon.config</groupId>
+            <artifactId>helidon-config-yaml</artifactId>
+            <version>${project.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>

health/health/src/main/java/io/helidon/health/HealthSupport.java

@@ -168,7 +168,7 @@ public static Builder builder() {
      *
      * @return health support configured with no health checks
      */
-    public static HealthSupport create(){
+    public static HealthSupport create() {
         return builder().build();
     }
 
@@ -177,7 +177,7 @@ public static HealthSupport create(){
      * The endpoint will always return {@code UP}.
      *
      * @param config configuration of this health check, used only to get {@code web-context} property to configure
-     *      {@link Builder#webContext(String)}
+     *               {@link Builder#webContext(String)}
      * @return health support configured with no health checks
      */
     public static HealthSupport create(Config config) {
@@ -208,7 +208,11 @@ public HealthSupport build() {
          * @return updated builder instance
          */
         public Builder webContext(String path) {
-            this.webContext = path;
+            if (path.startsWith("/")) {
+                this.webContext = path;
+            } else {
+                this.webContext = "/" + path;
+            }
             return this;
         }
 
@@ -238,7 +242,6 @@ public Builder add(Collection<HealthCheck> healthChecks) {
             return this;
         }
 
-
         /**
          * Add a health check to a white list (in case {@link #includeAll} is set to {@code false}.
          *

metrics/metrics/src/main/java/io/helidon/metrics/BaseRegistry.java

@@ -50,7 +50,7 @@
  * {@code helidon.metrics.base.${metric_name}.enabled=false}
  */
 final class BaseRegistry extends Registry {
-    private static final String CONFIG_METRIC_ENABLED_BASE = "helidon.metrics.base.";
+    private static final String CONFIG_METRIC_ENABLED_BASE = "base.";
     private static final Metadata MEMORY_USED_HEAP = new Metadata("memory.usedHeap",
                                                                   "Used Heap Memory",
                                                                   "Displays the amount of used heap memory in bytes.",

metrics/metrics/src/main/java/io/helidon/metrics/HelidonMetric.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -25,6 +25,12 @@
  * All metrics should inherit from {@link MetricImpl}.
  */
 interface HelidonMetric extends Metric {
+    /**
+     * Name of this metric.
+     *
+     * @return metric name
+     */
+    String getName();
     /**
      * Add this metrics data to the JSON builder.
      *

metrics/metrics/src/main/java/io/helidon/metrics/MetricsSupport.java

@@ -17,6 +17,7 @@
 package io.helidon.metrics;
 
 import java.util.Collections;
+import java.util.Comparator;
 import java.util.Objects;
 import java.util.Optional;
 import java.util.function.Function;
@@ -130,7 +131,7 @@ public static Builder builder() {
      */
     static boolean requestsJsonData(RequestHeaders headers) {
         Optional<MediaType> mediaType = headers.bestAccepted(MediaType.TEXT_PLAIN, MediaType.APPLICATION_JSON);
-        boolean requestsJson =  mediaType.isPresent() && mediaType.get().equals(MediaType.APPLICATION_JSON);
+        boolean requestsJson = mediaType.isPresent() && mediaType.get().equals(MediaType.APPLICATION_JSON);
 
         if (LOGGER.isLoggable(Level.FINE)) {
             LOGGER.fine("Generating metrics for media type " + mediaType
@@ -184,6 +185,7 @@ static String toPrometheusData(Registry registry) {
         StringBuilder result = new StringBuilder();
 
         registry.stream()
+                .sorted(Comparator.comparing(HelidonMetric::getName))
                 .forEach(mpMetric -> result.append(mpMetric.prometheusData()));
 
         return result.toString();
@@ -209,7 +211,7 @@ private static String checkMetricTypeThenRun(Metric metric, Function<HelidonMetr
 
         if (!(metric instanceof HelidonMetric)) {
             throw new IllegalArgumentException(String.format(
-                "Metric of type %s is expected to implement %s but does not",
+                    "Metric of type %s is expected to implement %s but does not",
                     metric.getClass().getName(),
                     HelidonMetric.class.getName()));
         }
@@ -230,6 +232,7 @@ static JsonObject toJsonData(Registry... registries) {
     static JsonObject toJsonData(Registry registry) {
         JsonObjectBuilder builder = JSON.createObjectBuilder();
         registry.stream()
+                .sorted(Comparator.comparing(HelidonMetric::getName))
                 .forEach(mpMetric -> mpMetric.jsonData(builder));
         return builder.build();
     }
@@ -247,34 +250,61 @@ static JsonObject toJsonMeta(Registry... registries) {
     static JsonObject toJsonMeta(Registry registry) {
         JsonObjectBuilder builder = JSON.createObjectBuilder();
         registry.stream()
+                .sorted(Comparator.comparing(HelidonMetric::getName))
                 .forEach(mpMetric -> mpMetric.jsonMeta(builder));
         return builder.build();
     }
 
-    @Override
-    public void update(Routing.Rules rules) {
-        Registry base = rf.getARegistry(MetricRegistry.Type.BASE);
-        Registry app = rf.getARegistry(MetricRegistry.Type.APPLICATION);
-        Registry vendor = rf.getARegistry(MetricRegistry.Type.VENDOR);
+    /**
+     * Configure vendor metrics on the provided routing.
+     * This method is exclusive to {@link #update(io.helidon.webserver.Routing.Rules)}
+     * (e.g. you should not use both, as otherwise you would duplicate the metrics)
+     *
+     * @param routingName name of the routing (may be null)
+     * @param rules       routing builder or routing rules
+     */
+    public void configureVendorMetrics(String routingName,
+                                       Routing.Rules rules) {
+        String metricPrefix = (null == routingName ? "" : routingName + ".") + "requests.";
 
-        Counter totalCount = vendor.counter(new Metadata("requests.count",
+        Registry vendor = rf.getARegistry(MetricRegistry.Type.VENDOR);
+        Counter totalCount = vendor.counter(new Metadata(metricPrefix + "count",
                                                          "Total number of requests",
                                                          "Each request (regardless of HTTP method) will increase this counter",
                                                          MetricType.COUNTER,
                                                          MetricUnits.NONE));
 
-        Meter totalMeter = vendor.meter(new Metadata("requests.meter",
+        Meter totalMeter = vendor.meter(new Metadata(metricPrefix + "meter",
                                                      "Meter for overall requests",
                                                      "Each request will mark the meter to see overall throughput",
                                                      MetricType.METERED,
                                                      MetricUnits.NONE));
 
+        rules.any((req, res) -> {
+            totalCount.inc();
+            totalMeter.mark();
+            req.next();
+        });
+    }
+
+    /**
+     * Configure metrics endpoint on the provided routing rules.
+     * This method just adds the endpoint {@code /metrics} (or appropriate
+     * one as configured).
+     * For simple routings, just register {@code MetricsSupport} instance.
+     * This method is exclusive to {@link #update(io.helidon.webserver.Routing.Rules)}
+     * (e.g. you should not use both, as otherwise you would register the endpoint twice)
+     *
+     * @param rules routing rules (also accepts {@link io.helidon.webserver.Routing.Builder}
+     */
+    public void configureEndpoint(Routing.Rules rules) {
+        Registry base = rf.getARegistry(MetricRegistry.Type.BASE);
+        Registry vendor = rf.getARegistry(MetricRegistry.Type.VENDOR);
+        Registry app = rf.getARegistry(MetricRegistry.Type.APPLICATION);
         // register the metric registry and factory to be available to all
         rules.any((req, res) -> {
             req.context().register(app);
             req.context().register(rf);
-            totalCount.inc();
-            totalMeter.mark();
             req.next();
         });
 
@@ -297,6 +327,23 @@ public void update(Routing.Rules rules) {
                 });
     }
 
+    /**
+     * Method invoked by the web server to update routing rules.
+     * Register this instance with webserver through
+     * {@link io.helidon.webserver.Routing.Builder#register(io.helidon.webserver.Service...)}
+     * rather than calling this method directly.
+     * If multiple sockets (and routings) should be supported, you can use
+     * the {@link #configureEndpoint(io.helidon.webserver.Routing.Rules)}, and
+     * {@link #configureVendorMetrics(String, io.helidon.webserver.Routing.Rules)} methods.
+     *
+     * @param rules a routing rules to update
+     */
+    @Override
+    public void update(Routing.Rules rules) {
+        configureVendorMetrics(null, rules);
+        configureEndpoint(rules);
+    }
+
     private void getOne(ServerRequest req, ServerResponse res, Registry registry) {
         String metricName = req.path().param("metric");
 
@@ -380,7 +427,11 @@ public MetricsSupport build() {
          */
         public Builder config(Config config) {
             this.config = config;
-            config.get("helidon.metrics.context").asString().ifPresent(this::context);
+            // align with health checks
+            config.get("web-context").asString().ifPresent(this::context);
+            // backward compatibility
+            config.get("context").asString().ifPresent(this::context);
+
 
             return this;
         }
@@ -407,9 +458,25 @@ public Builder registryFactory(RegistryFactory factory) {
          *
          * @param newContext context to use
          * @return updated builder instance
+         * @deprecated use {@link #webContext(String)} instead, aligned with API of heatlh checks
          */
+        @Deprecated
         public Builder context(String newContext) {
-            this.context = newContext;
+            return webContext(newContext);
+        }
+
+        /**
+         * Set a new root context for REST API of metrics.
+         *
+         * @param path context to use
+         * @return updated builder instance
+         */
+        public Builder webContext(String path) {
+            if (path.startsWith("/")) {
+                this.context = path;
+            } else {
+                this.context = "/" + path;
+            }
             return this;
         }
     }

metrics/metrics/src/test/java/io/helidon/metrics/RegistryFactoryTest.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,7 +55,7 @@ static void createInstance() {
         unconfigured = RegistryFactory.create();
         Config config = Config.builder()
                 .sources(ConfigSources.create(CollectionsHelper.mapOf(
-                        "helidon.metrics.base." + METRIC_USED_HEAP + ".enabled",
+                        "base." + METRIC_USED_HEAP + ".enabled",
                         "false")))
                 .build();
         configured = RegistryFactory.create(config);

microprofile/health/src/main/java/io/helidon/microprofile/health/HealthMpService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,9 @@
 package io.helidon.microprofile.health;
 
 import java.lang.annotation.Annotation;
+import java.util.Optional;
 
+import io.helidon.config.Config;
 import io.helidon.health.HealthSupport;
 import io.helidon.microprofile.server.spi.MpService;
 import io.helidon.microprofile.server.spi.MpServiceContext;
@@ -31,9 +33,9 @@
 public class HealthMpService implements MpService {
     @Override
     public void configure(MpServiceContext mpServiceContext) {
-
+        Config healthConfig = mpServiceContext.helidonConfig().get("health");
         HealthSupport.Builder builder = HealthSupport.builder()
-                .config(mpServiceContext.helidonConfig().get("helidon.health"));
+                .config(healthConfig);
 
         mpServiceContext.cdiContainer()
                 .select(HealthCheck.class, new Health() {
@@ -45,7 +47,22 @@ public Class<? extends Annotation> annotationType() {
                 .stream()
                 .forEach(builder::add);
 
-        mpServiceContext.serverRoutingBuilder()
+        healthConfig.get("routing")
+                .asString()
+                .flatMap(routeName -> {
+                    // support for overriding the routing back to default port using config
+                    if ("@default".equals(routeName)) {
+                        return Optional.empty();
+                    } else {
+                        return Optional.of(routeName);
+                    }
+                })
+                // use named routing
+                .map(mpServiceContext::serverNamedRoutingBuilder)
+                // use default server routing
+                .orElseGet(mpServiceContext::serverRoutingBuilder)
+                // register health support
                 .register(builder.build());
+
     }
 }

microprofile/metrics/src/main/java/io/helidon/microprofile/metrics/MetricsMpService.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2018 Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2018, 2019 Oracle and/or its affiliates. All rights reserved.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -16,13 +16,17 @@
 
 package io.helidon.microprofile.metrics;
 
+import java.util.HashSet;
+import java.util.Set;
+
+import io.helidon.common.CollectionsHelper;
+import io.helidon.config.Config;
+import io.helidon.config.ConfigValue;
 import io.helidon.metrics.MetricsSupport;
 import io.helidon.metrics.RegistryFactory;
-import io.helidon.microprofile.config.MpConfig;
 import io.helidon.microprofile.server.spi.MpService;
 import io.helidon.microprofile.server.spi.MpServiceContext;
-
-import org.eclipse.microprofile.config.spi.ConfigProviderResolver;
+import io.helidon.webserver.Routing;
 
 /**
  * Extension of microprofile {@link io.helidon.microprofile.server.Server} to enable support for metrics
@@ -36,9 +40,38 @@
 public class MetricsMpService implements MpService {
     @Override
     public void configure(MpServiceContext serviceContext) {
-        MpConfig config = (MpConfig) ConfigProviderResolver.instance().getConfig();
+        Set<String> vendorMetricsAdded = new HashSet<>();
+
+        Config metricsConfig = serviceContext.helidonConfig().get("metrics");
+
+        MetricsSupport metricsSupport = MetricsSupport.create(metricsConfig);
+
+        ConfigValue<String> routingNameConfig = metricsConfig.get("routing").asString();
+        Routing.Builder defaultRouting = serviceContext.serverRoutingBuilder();
+
+        Routing.Builder endpointRouting = defaultRouting;
+
+        if (routingNameConfig.isPresent()) {
+            String routingName = routingNameConfig.get();
+            // support for overriding this back to default routing using config
+            if (!"@default".equals(routingName)) {
+                endpointRouting = serviceContext.serverNamedRoutingBuilder(routingName);
+            }
+        }
+
+        metricsSupport.configureVendorMetrics(null, defaultRouting);
+        vendorMetricsAdded.add("@default");
+        metricsSupport.configureEndpoint(endpointRouting);
 
-        MetricsSupport.create(config.helidonConfig())
-                .update(serviceContext.serverRoutingBuilder());
+        // now we may have additional sockets we want to add vendor metrics to
+        metricsConfig.get("vendor-metrics-routings")
+                .asList(String.class)
+                .orElseGet(CollectionsHelper::listOf)
+                .forEach(routeName -> {
+                    if (!vendorMetricsAdded.contains(routeName)) {
+                        metricsSupport.configureVendorMetrics(routeName, serviceContext.serverNamedRoutingBuilder(routeName));
+                        vendorMetricsAdded.add(routeName);
+                    }
+                });
     }
 }