Apply PR requested changes

Author: wlatif

plume-web-jersey-info/README.md

@@ -15,14 +15,15 @@ Setup
 </dependency>
 ```
 
-Services
+Features
 -------
 
-### HealthCheckService
-The `HealthCheckService` provides a simple API to monitor the health status of your application.
+### HealthCheckBuilder
+The `HealthCheckBuilder` provides a simple API to monitor the health status of your application.
 
 - `registerHealthCheck`: Register your health checks
-- `isHealthy`: run the registered health checks and return the health status.
+- `registerDatabaseHealthCheck`: Register the built-in database health check
+- `build`: create a health status provider
 
 Usage example:
 
@@ -33,25 +34,25 @@ Usage example:
 public class HealthWs {
     private static final Logger logger = LoggerFactory.getLogger(HealthWs.class);
 
-    private final HealthCheckService healthCheckService;
-    private final ObjectMapper objectMapper = PlmWebJerseyInfoObjectMapperProvider.get();
+    private final Provider<HealthStatus> healthStatusProvider;
 
     @Inject
     public HealthWs(TransactionManager transactionManager, HealthCheckService healthCheckService) {
-        this.healthCheckService = healthCheckService;
-        healthCheckService.registerHealthCheck("database", new DatabaseHealthCheck(transactionManager));
+        this.healthStatusProvider = new HealthCheckBuilder()
+            .registerDatabaseHealthCheck()
+            .build();
     }
 
     @GET
     @Produces(MediaType.APPLICATION_JSON)
-    public HealthStatus get(@Context ContainerRequestContext requestContext) throws JsonProcessingException {
-        return this.healthCheckService.isHealthy();
+    public HealthStatus get(@Context ContainerRequestContext requestContext) {
+        return this.healthStatusProvider.get();
     }
 }
 ```
 
-### InfoCheckService
-The `InfoCheckService` provides a unique getter that retrieves the basic application information from the `Pom.xml` :
+### InfoService
+The `InfoService` provides a unique getter that retrieves the basic application information from the `Pom.xml` :
 - name
 - description
 - version
@@ -87,13 +88,14 @@ public class InfoWs {
 }
 ```
 
-### MetricsService
-The `MetricsService` uses the [io.dropwizard.metrics](https://github.com/dropwizard/metrics) library
+### MetricsCheckBuilder
+The `MetricsCheckBuilder` uses the [io.dropwizard.metrics](https://github.com/dropwizard/metrics) library
 to provide some basic functionality for monitoring your application's metrics (CPU usage, memory usage, ...).
 
 Exposed API :
 - `registerMetric`: Register metrics to monitor
-- `getMetrics`: Provides the metrics that are monitored.
+- `registerJvmMetrics`: Register the basic JVM metrics to monitor
+- `build`: create a metrics provider that provides the status of the metrics that are monitored.
 
 Usage example:
 
@@ -102,50 +104,31 @@ Usage example:
 @Path("/monitor/metrics")
 @Singleton
 public class MetricsWs {
-    private final MetricsService metricsService;
-    private final PlmWebJerseyInfoObjectMapper objectMapper = new PlmWebJerseyInfoObjectMapper();
+    private final JerseyInfoObjectMapper objectMapper = JerseyInfoObjectMapper.get();
+    private final Provider<Map<String, Metric>> metricsStatusProvider;
 
     @Inject
     public MetricsWs(MetricsService metricsService) {
-        this.metricsService = metricsService;
-
-        metricsService.registerMetric("memory-usage", new MemoryUsageGaugeSet());
-        metricsService.registerMetric("thread-states", new ThreadStatesGaugeSet());
+        this.metricsStatusProvider = new MetricsCheckBuilder()
+            .registerJvmMetrics()
+            .build();
     }
-
-
+    
     @GET
     @Produces(MediaType.APPLICATION_JSON)
     public String get(@Context ContainerRequestContext requestContext) throws JsonProcessingException {
         return objectMapper.writeValueAsString(Map.of(
-            "metrics", metricsService.getMetrics()
+            "metrics", metricsStatusProvider.get()
         ));
     }
 }
 ```
 
-
-Built-in HealthChecks
--------
-
-### DatabaseHealthCheck
-Check the health of your connection to the database.
-
-Usage example:
-
-```java
-@Inject
-    public HealthWs(TransactionManager transactionManager, HealthCheckService healthCheckService) {
-        this.healthCheckService = healthCheckService;
-        healthCheckService.registerHealthCheck("database", new DatabaseHealthCheck(transactionManager));
-    }
-```
-
-### PlmWebJerseyInfoObjectMapperProvider
+### JerseyInfoObjectMapper
 Provides an ObjectMapper to serialize the types provided by plume-web-jersey-info services.
 
 Usage example:
 
 ```java
-    private final PlmWebJerseyInfoObjectMapper objectMapper = new PlmWebJerseyInfoObjectMapper();
+    private final ObjectMapper objectMapper = JerseyInfoObjectMapper.get();
 ```

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/configuration/PlmWebJerseyInfoConfigurationService.java renamed to plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/configuration/JerseyInfoConfigurationService.java

@@ -8,12 +8,12 @@
 import java.util.Map;
 
 @Singleton
-public class PlmWebJerseyInfoConfigurationService {
+public class JerseyInfoConfigurationService {
 
     private final Config config;
 
     @Inject
-    public PlmWebJerseyInfoConfigurationService(Config config) {
+    public JerseyInfoConfigurationService(Config config) {
         this.config = config.withFallback(ConfigFactory.parseResources("plume-web-jersey-info.conf"));
     }
 

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/health/HealthCheckService.java

@@ -0,0 +1,30 @@
+package com.coreoz.plume.jersey.info.json;
+
+import com.codahale.metrics.json.HealthCheckModule;
+import com.codahale.metrics.json.MetricsModule;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+
+import java.util.concurrent.TimeUnit;
+
+public class JerseyInfoObjectMapper {
+    private static final HealthCheckModule healthCheckModule = new HealthCheckModule();
+    private static final MetricsModule metricsModule = new MetricsModule(
+        TimeUnit.SECONDS,
+        TimeUnit.SECONDS,
+        false
+    );
+
+    private JerseyInfoObjectMapper() {
+    }
+
+    public static ObjectMapper get() {
+        return new ObjectMapper()
+            .registerModule(healthCheckModule)
+            .registerModule(metricsModule)
+            .disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
+            .enable(SerializationFeature.INDENT_OUTPUT)
+            .setSerializationInclusion(JsonInclude.Include.NON_EMPTY);
+    }
+}

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/json/JerseyInfoObjectMapper.java

@@ -0,0 +1,41 @@
+package com.coreoz.plume.jersey.info.monitoring.health;
+
+import com.coreoz.plume.db.transaction.TransactionManager;
+import com.coreoz.plume.jersey.info.monitoring.health.beans.HealthStatus;
+import com.codahale.metrics.health.HealthCheck;
+import com.codahale.metrics.health.HealthCheckRegistry;
+import com.coreoz.plume.jersey.info.monitoring.health.healthchecks.DatabaseHealthCheck;
+
+import javax.inject.Provider;
+import java.util.SortedMap;
+
+public class HealthCheckBuilder {
+    private final HealthCheckRegistry healthCheckRegistry = new HealthCheckRegistry();
+
+    private HealthCheckBuilder() {
+    }
+
+    public HealthCheckBuilder registerHealthCheck(String name, HealthCheck healthCheck) {
+        this.healthCheckRegistry.register(name, healthCheck);
+        return this;
+    }
+
+    public HealthCheckBuilder registerDatabaseHealthCheck(TransactionManager transactionManager) {
+        this.healthCheckRegistry.register("database", new DatabaseHealthCheck(transactionManager));
+        return this;
+    }
+
+    public Provider<HealthStatus> build() {
+        return this::isHealthy;
+    }
+
+    /* PRIVATE */
+    private HealthStatus isHealthy() {
+        SortedMap<String, HealthCheck.Result> healthChecksResult = healthCheckRegistry.runHealthChecks();
+        boolean isAppHealthy = healthChecksResult.values()
+            .stream()
+            .reduce(true, (isHealthy, healthCheck) -> isHealthy && healthCheck.isHealthy(), Boolean::logicalAnd);
+
+        return new HealthStatus(isAppHealthy, healthChecksResult);
+    }
+}

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/metrics/MetricsService.java

@@ -1,4 +1,4 @@
-package com.coreoz.plume.jersey.info.health.beans;
+package com.coreoz.plume.jersey.info.monitoring.health.beans;
 
 import com.codahale.metrics.health.HealthCheck;
 

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/monitoring/health/HealthCheckBuilder.java

@@ -1,4 +1,4 @@
-package com.coreoz.plume.jersey.info.health.healthchecks;
+package com.coreoz.plume.jersey.info.monitoring.health.healthchecks;
 
 import com.codahale.metrics.health.HealthCheck;
 import com.coreoz.plume.db.transaction.TransactionManager;

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/health/beans/HealthStatus.java renamed to plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/monitoring/health/beans/HealthStatus.java

@@ -1,8 +1,8 @@
-package com.coreoz.plume.jersey.info.info;
+package com.coreoz.plume.jersey.info.monitoring.info;
 
-import com.coreoz.plume.jersey.info.configuration.PlmWebJerseyInfoConfigurationService;
-import com.coreoz.plume.jersey.info.info.beans.AppInformation;
-import com.coreoz.plume.jersey.info.objectmapper.PlmWebJerseyInfoObjectMapperProvider;
+import com.coreoz.plume.jersey.info.configuration.JerseyInfoConfigurationService;
+import com.coreoz.plume.jersey.info.monitoring.info.beans.AppInformation;
+import com.coreoz.plume.jersey.info.json.JerseyInfoObjectMapper;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import org.apache.maven.model.Model;
 import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
@@ -14,11 +14,11 @@
 
 @Singleton
 public class InfoService {
-    private final PlmWebJerseyInfoConfigurationService configurationService;
-    private final ObjectMapper objectMapper = PlmWebJerseyInfoObjectMapperProvider.get();
+    private final JerseyInfoConfigurationService configurationService;
+    private final ObjectMapper objectMapper = JerseyInfoObjectMapper.get();
 
     @Inject
-    private InfoService(PlmWebJerseyInfoConfigurationService configurationService) {
+    private InfoService(JerseyInfoConfigurationService configurationService) {
         this.configurationService = configurationService;
     }
 

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/health/healthchecks/DatabaseHealthCheck.java renamed to plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/monitoring/health/healthchecks/DatabaseHealthCheck.java

@@ -1,4 +1,4 @@
-package com.coreoz.plume.jersey.info.info.beans;
+package com.coreoz.plume.jersey.info.monitoring.info.beans;
 
 import java.util.Map;
 

plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/info/InfoService.java renamed to plume-web-jersey-info/src/main/java/com/coreoz/plume/jersey/info/monitoring/info/InfoService.java

@@ -0,0 +1,38 @@
+package com.coreoz.plume.jersey.info.monitoring.metrics;
+
+import com.codahale.metrics.Metric;
+import com.codahale.metrics.MetricRegistry;
+import com.codahale.metrics.MetricSet;
+import com.codahale.metrics.jvm.MemoryUsageGaugeSet;
+import com.codahale.metrics.jvm.ThreadStatesGaugeSet;
+
+import javax.inject.Provider;
+import java.util.Map;
+
+public class MetricsCheckBuilder {
+    private final MetricRegistry metricRegistry = new MetricRegistry();
+
+    public MetricsCheckBuilder registerMetric(String name, Metric metric) {
+        if (metric instanceof MetricSet) {
+            this.metricRegistry.registerAll(name, (MetricSet) metric);
+        } else {
+            this.metricRegistry.register(name, metric);
+        }
+        return this;
+    }
+
+    public MetricsCheckBuilder registerJvmMetrics() {
+        this.metricRegistry.registerAll("memory-usage", new MemoryUsageGaugeSet());
+        this.metricRegistry.registerAll("thread-states", new ThreadStatesGaugeSet());
+        return this;
+    }
+
+    public Provider<Map<String, Metric>> build() {
+        return this::getMetrics;
+    }
+
+    /* PRIVATE */
+    private Map<String, Metric> getMetrics() {
+        return this.metricRegistry.getMetrics();
+    }
+}