New diagnostic REST resource

Author: adrienlauer

CHANGELOG.md

@@ -6,6 +6,8 @@
 * [new] The `SEEDSTACK_PROFILES` environment variable can now be used to specify comma-separated configuration profiles
   to enable. These profiles will be added to the profiles already defined in the `seedstack.profiles` system property if
   any.
+* [new] If config option `rest.diagnosticResource` is set to `true`, the diagnostic report will be available as a JSON
+  representation at `/seedstack/diagnostic`. Do not enable permanently in production. Default is `false`.
 
 # Version 3.12.1 (2021-05-21)
 

core/src/main/java/org/seedstack/seed/core/SeedRuntime.java

@@ -8,15 +8,7 @@
 
 package org.seedstack.seed.core;
 
-import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 import io.nuun.kernel.api.Plugin;
-import java.io.IOException;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Map;
-import java.util.ServiceLoader;
-import java.util.Set;
 import org.seedstack.coffig.Coffig;
 import org.seedstack.coffig.provider.CompositeProvider;
 import org.seedstack.coffig.provider.InMemoryProvider;
@@ -26,9 +18,15 @@
 import org.seedstack.seed.diagnostic.spi.DiagnosticInfoCollector;
 import org.seedstack.seed.spi.ConfigurationPriority;
 
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Map;
+import java.util.ServiceLoader;
+import java.util.Set;
+
 public class SeedRuntime {
     private static final String SEED_PACKAGE_PREFIX = "org.seedstack.seed";
-    private static final YAMLMapper yamlMapper = new YAMLMapper();
     private final Object context;
     private final DiagnosticManager diagnosticManager;
     private final Coffig configuration;
@@ -45,7 +43,7 @@ private SeedRuntime(Object context, DiagnosticManager diagnosticManager, Coffig
         this.configuration = configuration;
         this.seedVersion = seedVersion;
         this.businessVersion = businessVersion;
-        this.diagnosticManager.registerDiagnosticInfoCollector("seed", new RuntimeDiagnosticCollector());
+        this.diagnosticManager.registerDiagnosticInfoCollector("seedstack", new RuntimeDiagnosticCollector());
         this.prioritizedProvider = ((CompositeProvider) this.configuration.getProvider()).get(
                 PrioritizedProvider.class);
         this.inMemoryProvider = new InMemoryProvider();
@@ -168,11 +166,6 @@ public Map<String, Object> collect() {
             result.put("businessVersion", businessVersion == null ? "UNKNOWN" : businessVersion);
             result.put("inconsistentPlugins", inconsistentPlugins);
             result.put("contextClass", context == null ? "NONE" : context.getClass().getName());
-            try {
-                result.put("configuration", yamlMapper.readValue(configuration.toString(), Map.class));
-            } catch (IOException | RuntimeException e) {
-                result.put("rawConfiguration", configuration.toString());
-            }
 
             return result;
         }

core/src/main/java/org/seedstack/seed/core/internal/configuration/ApplicationDiagnosticCollector.java

@@ -7,12 +7,19 @@
  */
 package org.seedstack.seed.core.internal.configuration;
 
-import java.util.HashMap;
-import java.util.Map;
+import com.fasterxml.jackson.dataformat.yaml.YAMLMapper;
 import org.seedstack.seed.Application;
 import org.seedstack.seed.diagnostic.spi.DiagnosticInfoCollector;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
 
 class ApplicationDiagnosticCollector implements DiagnosticInfoCollector {
+    private static final Logger LOGGER = LoggerFactory.getLogger(ApplicationDiagnosticCollector.class);
+    private final YAMLMapper yamlMapper = new YAMLMapper();
     private final Application application;
 
     ApplicationDiagnosticCollector(Application application) {
@@ -30,6 +37,15 @@ public Map<String, Object> collect() {
             result.put("storage", application.getStorageLocation(""));
         }
 
+        try {
+            result.put("configuration", yamlMapper.readValue(application.getConfiguration().toString(), Map.class));
+        } catch (IOException | RuntimeException e) {
+            LOGGER.warn("Error building diagnostic configuration, using toString() instead", e);
+            result.put("configuration", application.getConfiguration().toString());
+        }
+
+        result.put("configurationProfiles", application.getConfigurationProfiles());
+
         return result;
     }
 }

core/src/main/java/org/seedstack/seed/core/internal/configuration/ApplicationImpl.java

@@ -8,9 +8,12 @@
 package org.seedstack.seed.core.internal.configuration;
 
 import com.google.inject.util.Types;
+
 import java.io.File;
 import java.util.Collections;
 import java.util.Map;
+import java.util.Set;
+
 import org.seedstack.coffig.Coffig;
 import org.seedstack.coffig.node.ValueNode;
 import org.seedstack.seed.Application;
@@ -77,6 +80,11 @@ public Coffig getConfiguration() {
         return coffig;
     }
 
+    @Override
+    public Set<String> getConfigurationProfiles() {
+        return ProfileProcessor.activeProfiles();
+    }
+
     @Override
     @SuppressWarnings("unchecked")
     public <T> ClassConfiguration<T> getConfiguration(Class<T> someClass) {

core/src/test/java/custom/CustomApplicationProvider.java

@@ -9,6 +9,7 @@
 
 import java.io.File;
 import java.util.Map;
+import java.util.Set;
 import javax.inject.Provider;
 import org.seedstack.coffig.Coffig;
 import org.seedstack.seed.Application;
@@ -50,6 +51,11 @@ public Coffig getConfiguration() {
                 return null;
             }
 
+            @Override
+            public Set<String> getConfigurationProfiles() {
+                return null;
+            }
+
             @Override
             public <T> ClassConfiguration<T> getConfiguration(Class<T> someClass) {
                 return null;

core/src/test/java/org/seedstack/seed/core/DiagnosticManagerIT.java

@@ -68,11 +68,10 @@ public void seed_info_is_present() {
 
         assertThat(diagnosticInfo).isNotNull();
 
-        Map<String, Object> seedInfo = (Map<String, Object>) diagnosticInfo.get("seed");
+        Map<String, Object> seedInfo = (Map<String, Object>) diagnosticInfo.get("seedstack");
         assertThat((String) (seedInfo.get("version"))).isNotEmpty();
         assertThat((Set<String>) (seedInfo.get("inconsistentPlugins"))).isNotNull();
         assertThat((String) (seedInfo.get("contextClass"))).isNotEmpty();
-        assertThat(seedInfo.get("configuration")).isNotNull();
     }
 
     @Test
@@ -104,7 +103,9 @@ public void diagnostic_application_information_is_present() {
         assertThat(applicationInfo.get("id")).isNotNull();
         assertThat(applicationInfo.get("name")).isNotNull();
         assertThat(applicationInfo.get("version")).isNotNull();
-        assertThat(applicationInfo.get("storage-location")).isNull();
+        assertThat(applicationInfo.get("storage")).isNotNull(); // storage is automatically enabled during integration testing
+        assertThat(applicationInfo.get("configuration")).isNotNull();
+        assertThat(applicationInfo.get("configurationProfiles")).isNotNull();
     }
 
     @Test

rest/core/src/main/java/org/seedstack/seed/rest/internal/DiagnosticResource.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright © 2013-2021, The SeedStack authors <http://seedstack.org>
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+package org.seedstack.seed.rest.internal;
+
+import org.seedstack.seed.diagnostic.DiagnosticManager;
+import org.seedstack.seed.diagnostic.spi.DiagnosticInfoCollector;
+
+import javax.inject.Inject;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.MediaType;
+import java.util.Map;
+
+@Path("/seedstack/diagnostic")
+public class DiagnosticResource {
+    @Inject
+    private DiagnosticManager diagnosticManager;
+
+    @GET
+    @Produces(MediaType.APPLICATION_JSON)
+    public Map<String, Object> diag() {
+        return diagnosticManager.getDiagnosticInfo(null);
+    }
+}

rest/core/src/main/java/org/seedstack/seed/rest/internal/RestPlugin.java

@@ -15,16 +15,6 @@
 import io.nuun.kernel.api.plugin.InitState;
 import io.nuun.kernel.api.plugin.context.InitContext;
 import io.nuun.kernel.api.plugin.request.ClasspathScanRequest;
-import java.util.Collection;
-import java.util.HashMap;
-import java.util.HashSet;
-import java.util.Locale;
-import java.util.Map;
-import java.util.Set;
-import java.util.function.Predicate;
-import javax.servlet.ServletContext;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Variant;
 import org.seedstack.seed.core.SeedRuntime;
 import org.seedstack.seed.core.internal.AbstractSeedPlugin;
 import org.seedstack.seed.core.internal.init.ValidationManager;
@@ -46,6 +36,17 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import javax.servlet.ServletContext;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Variant;
+import java.util.Collection;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Locale;
+import java.util.Map;
+import java.util.Set;
+import java.util.function.Predicate;
+
 public class RestPlugin extends AbstractSeedPlugin implements RestProvider {
     private static final Logger LOGGER = LoggerFactory.getLogger(RestPlugin.class);
     private final Map<Variant, Class<? extends RootResource>> rootResourcesByVariant = new HashMap<>();
@@ -89,6 +90,7 @@ public InitState initialize(InitContext initContext) {
 
             configureExceptionMappers();
             configureStreamSupport();
+            configureDiagResource();
 
             initializeHypermedia(servletContext.getContextPath());
 
@@ -141,6 +143,15 @@ private boolean isDynamicValidationSupported() {
         return ValidationManager.get().getValidationLevel().compareTo(ValidationManager.ValidationLevel.LEVEL_1_1) >= 0;
     }
 
+    private void configureDiagResource() {
+        if (!restConfig.isDiagnosticResource()) {
+            resources.remove(DiagnosticResource.class);
+            LOGGER.debug("Diagnostic resource disabled");
+        } else {
+            LOGGER.info("Diagnostic resource accessible at {}/{}", restConfig.getPath(), "seedstack/diag");
+        }
+    }
+
     private void configureStreamSupport() {
         if (!restConfig.isStreamSupport()) {
             providers.remove(StreamMessageBodyReader.class);

rest/jersey2/src/test/java/org/seedstack/seed/rest/jersey2/Jersey2IT.java

@@ -7,11 +7,7 @@
  */
 package org.seedstack.seed.rest.jersey2;
 
-import static io.restassured.RestAssured.expect;
-import static org.assertj.core.api.Assertions.assertThat;
-
 import io.restassured.response.Response;
-import javax.ws.rs.core.MediaType;
 import org.json.JSONException;
 import org.junit.Test;
 import org.junit.runner.RunWith;
@@ -20,6 +16,11 @@
 import org.seedstack.seed.undertow.LaunchWithUndertow;
 import org.skyscreamer.jsonassert.JSONAssert;
 
+import javax.ws.rs.core.MediaType;
+
+import static io.restassured.RestAssured.expect;
+import static org.assertj.core.api.Assertions.assertThat;
+
 @RunWith(SeedITRunner.class)
 @LaunchWithUndertow
 public class Jersey2IT {
@@ -79,4 +80,10 @@ public void streamReading() {
                 .asString();
         assertThat(result).isEqualTo("Hello world!");
     }
+
+    @Test
+    public void diagnostic() {
+        expect().statusCode(200).given()
+                .get(baseUrl + "/seedstack/diagnostic");
+    }
 }

rest/jersey2/src/test/resources/application.yaml

@@ -21,5 +21,6 @@ rest:
   path<withPrefix>: /rest
   jsonHome: true
   jsonHome<withoutRootResource>: false
+  diagnosticResource: true
 
 textHome<withoutRootResource>: false