Apply PR requested changes

Author: wlatif

plume-web-jersey-monitoring/README.md

@@ -1,4 +1,4 @@
-Plume Web Jersey info
+Plume Web Jersey monitoring
 ================
 
 This module provides utilities to expose backend monitoring API similarly to what is offered by Spring Actuator:
@@ -18,14 +18,11 @@ Add the dependency to the `pom.xml` file
 ```
 
 ### Install Guice modules
-In your application module :
-1. replace `GuiceJacksonModule`by the `GuiceJacksonWithMetricsModule`
-2. install the `GuiceJerseyMonitoringModule`
+In your application module replace `GuiceJacksonModule`by the `GuiceJacksonWithMetricsModule`
 
 ~~`install(new GuiceJacksonModule());`~~
 ```java
 install(new GuiceJacksonWithMetricsModule());
-install(new GuiceJerseyMonitoringModule());
 ```
 
 Features
@@ -39,9 +36,9 @@ The `HealthCheckBuilder` provides a simple API to monitor the health status of y
 - `build`: create a health status provider
 
 
-### ApplicationInfo
-The `ApplicationInfo` is a singleton object available through dependency injection.
-It contains the basic application information retrieved from the `Pom.xml` file.
+### ApplicationInfoProvider
+The `ApplicationInfoProvider` provides an instance of `ApplicationInfo`.
+It contains the basic application information retrieved from the `pom.xml` file.
 
 `ApplicationInfo` content: 
 - name
@@ -74,6 +71,7 @@ Usage example
 **Web-service**
 
 ```java
+import com.coreoz.plume.db.transaction.TransactionManager;
 import com.coreoz.plume.jersey.security.permission.PublicApi;
 
 @Path("/monitor")
@@ -88,11 +86,11 @@ public class MonitoringWs {
     private final BasicAuthenticator<String> basicAuthenticator;
 
     @Inject
-    public MonitoringWs(ApplicationInfo applicationInfo) {
-        this.applicationInfo = applicationInfo;
+    public MonitoringWs(ApplicationInfoProvider applicationInfoProvider, TransactionManager transactionManager) {
+        this.applicationInfo = applicationInfoProvider.get();
         // Registering health checks
         this.healthStatusProvider = new HealthCheckBuilder()
-            .registerDatabaseHealthCheck()
+            .registerDatabaseHealthCheck(transactionManager)
             .build();
 
         // Registering metrics to monitor
@@ -112,7 +110,7 @@ public class MonitoringWs {
     @Path("/info")
     public ApplicationInfo get(@Context ContainerRequestContext requestContext) {
         basicAuthenticator.requireAuthentication(requestContext);
-        return this.infoService.getAppInfo();
+        return this.applicationInfo;
     }
 
     @GET

plume-web-jersey-monitoring/pom.xml

@@ -31,7 +31,17 @@
             <groupId>com.coreoz</groupId>
             <artifactId>plume-conf</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.coreoz</groupId>
+            <artifactId>plume-web-jersey</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.coreoz</groupId>
+            <artifactId>plume-db</artifactId>
+            <optional>true</optional>
+        </dependency>
 
+        <!-- logger -->
         <dependency>
 			<groupId>org.slf4j</groupId>
 			<artifactId>slf4j-api</artifactId>
@@ -51,30 +61,22 @@
             <artifactId>metrics-healthchecks</artifactId>
         </dependency>
 
-        <!-- Dependency injection -->
-        <dependency>
-            <groupId>javax.inject</groupId>
-            <artifactId>javax.inject</artifactId>
-        </dependency>
-
         <!-- Pom.xml reader -->
         <dependency>
             <groupId>org.apache.maven</groupId>
             <artifactId>maven-model</artifactId>
         </dependency>
 
-        <dependency>
-            <groupId>com.coreoz</groupId>
-            <artifactId>plume-db</artifactId>
-            <optional>true</optional>
-        </dependency>
+        <!-- dependency injection -->
         <dependency>
             <groupId>com.google.inject</groupId>
             <artifactId>guice</artifactId>
         </dependency>
+
+        <!-- lombok -->
         <dependency>
-            <groupId>com.coreoz</groupId>
-            <artifactId>plume-web-jersey</artifactId>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
         </dependency>
     </dependencies>
 

plume-web-jersey-monitoring/src/main/java/com/coreoz/plume/jersey/monitoring/guice/GuiceJerseyMonitoringModule.java

@@ -15,18 +15,16 @@
 @Singleton
 public class JerseyMonitoringObjectMapperProvider implements Provider<ObjectMapper> {
     private final ObjectMapper objectMapper;
-    private static final HealthCheckModule healthCheckModule = new HealthCheckModule();
-    private static final MetricsModule metricsModule = new MetricsModule(
-        TimeUnit.SECONDS,
-        TimeUnit.SECONDS,
-        false
-    );
 
     @Inject
     public JerseyMonitoringObjectMapperProvider(ObjectMapperProvider objectMapperProvider) {
         this.objectMapper = objectMapperProvider.get()
-            .registerModule(healthCheckModule)
-            .registerModule(metricsModule)
+            .registerModule(new HealthCheckModule())
+            .registerModule(new MetricsModule(
+                TimeUnit.SECONDS,
+                TimeUnit.SECONDS,
+                false
+            ))
             .disable(SerializationFeature.FAIL_ON_EMPTY_BEANS)
             .enable(SerializationFeature.INDENT_OUTPUT)
             .setSerializationInclusion(JsonInclude.Include.NON_EMPTY);

plume-web-jersey-monitoring/src/main/java/com/coreoz/plume/jersey/monitoring/json/JerseyMonitoringObjectMapperProvider.java

@@ -1,24 +1,12 @@
 package com.coreoz.plume.jersey.monitoring.utils.health.beans;
 
 import com.codahale.metrics.health.HealthCheck;
+import lombok.Value;
 
 import java.util.Map;
-import java.util.SortedMap;
 
+@Value
 public class HealthStatus {
-    private final boolean isHealthy;
-    private final Map<String, HealthCheck.Result> healthChecksResults;
-
-    public HealthStatus(boolean isHealthy, SortedMap<String, HealthCheck.Result> healthChecksResults) {
-        this.isHealthy = isHealthy;
-        this.healthChecksResults = Map.copyOf(healthChecksResults);
-    }
-
-    public boolean isHealthy() {
-        return isHealthy;
-    }
-
-    public Map<String, HealthCheck.Result> getHealthChecksResults() {
-        return healthChecksResults;
-    }
+    boolean isHealthy;
+    Map<String, HealthCheck.Result> healthChecksResults;
 }

plume-web-jersey-monitoring/src/main/java/com/coreoz/plume/jersey/monitoring/utils/health/beans/HealthStatus.java

@@ -4,32 +4,30 @@
 import com.coreoz.plume.jersey.monitoring.utils.info.beans.ApplicationInfo;
 import org.apache.maven.model.Model;
 import org.apache.maven.model.io.xpp3.MavenXpp3Reader;
+import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
 
 import javax.inject.Inject;
 import javax.inject.Provider;
 import javax.inject.Singleton;
 import java.io.FileReader;
+import java.io.IOException;
 import java.util.Map;
 
 @Singleton
 public class ApplicationInfoProvider implements Provider<ApplicationInfo> {
     private final ApplicationInfo applicationInfo;
 
     @Inject
-    private ApplicationInfoProvider(JerseyMonitoringConfigurationService configurationService) {
+    private ApplicationInfoProvider(JerseyMonitoringConfigurationService configurationService) throws IOException, XmlPullParserException {
         MavenXpp3Reader reader = new MavenXpp3Reader();
-        try {
-            Model model = reader.read(new FileReader("pom.xml"));
-            Map<String, Object> additionalInformation = configurationService.getCustomInfo();
-            this.applicationInfo = new ApplicationInfo(
-                model.getName(),
-                model.getDescription(),
-                model.getVersion(),
-                additionalInformation.isEmpty() ? null : additionalInformation
-            );
-        } catch (Exception e) {
-            throw new RuntimeException("Failed to retrieve the application information", e);
-        }
+        Model model = reader.read(new FileReader("pom.xml"));
+        Map<String, Object> additionalInformation = configurationService.getCustomInfo();
+        this.applicationInfo = new ApplicationInfo(
+            model.getName(),
+            model.getDescription(),
+            model.getVersion(),
+            additionalInformation.isEmpty() ? null : additionalInformation
+        );
     }
 
     @Override

plume-web-jersey-monitoring/src/main/java/com/coreoz/plume/jersey/monitoring/utils/info/ApplicationInfoProvider.java

@@ -1,33 +1,13 @@
 package com.coreoz.plume.jersey.monitoring.utils.info.beans;
 
+import lombok.Value;
+
 import java.util.Map;
 
+@Value
 public class ApplicationInfo {
-    private final String name;
-    private final String description;
-    private final String version;
-    private final Map<String, Object> additionalInformation;
-
-    public ApplicationInfo(String name, String description, String version, Map<String, Object> additionalInformation) {
-        this.name = name;
-        this.description = description;
-        this.version = version;
-        this.additionalInformation = additionalInformation;
-    }
-
-    public String getName() {
-        return name;
-    }
-
-    public String getDescription() {
-        return description;
-    }
-
-    public String getVersion() {
-        return version;
-    }
-
-    public Map<String, Object> getAdditionalInformation() {
-        return additionalInformation;
-    }
+    String name;
+    String description;
+    String version;
+    Map<String, Object> additionalInformation;
 }