Improve JWKs health indicator logging (#79)

entur · Mar 1, 2024 · 081c69a · 081c69a
1 parent 9100a95
commit 081c69a
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 19 deletions.
diff --git a/...rver/spring/jwt-spring-common/src/main/java/org/entur/jwt/spring/JwkSourceMapFactory.java b/...rver/spring/jwt-spring-common/src/main/java/org/entur/jwt/spring/JwkSourceMapFactory.java
@@ -106,10 +106,10 @@ public JwkSourceMap getJwkSourceMap(Map<String, JwtTenantProperties> tenants, Jw
 
             DefaultJwksHealthIndicator healthIndicator = null;
             if (listJwksHealthIndicator != null) {
-                healthIndicator = new DefaultJwksHealthIndicator();
+                healthIndicator = new DefaultJwksHealthIndicator(entry.getKey());
                 builder.healthReporting(healthIndicator);
 
-                LOGGER.info("Add health indicator");
+                LOGGER.info("Add health indicator for " + entry.getKey());
 
                 listJwksHealthIndicator.addHealthIndicators(healthIndicator);
             }

diff --git a/...ver/spring/jwt-spring-common/src/main/java/org/entur/jwt/spring/JwtAutoConfiguration.java b/...ver/spring/jwt-spring-common/src/main/java/org/entur/jwt/spring/JwtAutoConfiguration.java
@@ -43,7 +43,7 @@ public ListJwksHealthIndicator jwksHealthIndicator(SecurityProperties properties
 
         long maxDelay = (jwk.getConnectTimeout() + jwk.getReadTimeout()) * 1000;
 
-        return new ListJwksHealthIndicator(maxDelay, Executors.newCachedThreadPool());
+        return new ListJwksHealthIndicator(maxDelay, Executors.newCachedThreadPool(), "List");
     }
 
     @Bean(destroyMethod = "close")

diff --git a/...spring-common/src/main/java/org/entur/jwt/spring/actuate/AbstractJwksHealthIndicator.java b/...spring-common/src/main/java/org/entur/jwt/spring/actuate/AbstractJwksHealthIndicator.java
@@ -5,9 +5,6 @@
 import org.springframework.boot.actuate.health.AbstractHealthIndicator;
 import org.springframework.boot.actuate.health.Health;
 
-import java.io.Closeable;
-import java.io.IOException;
-
 /**
  * 
  * Health indicator.
@@ -20,6 +17,14 @@ public abstract class AbstractJwksHealthIndicator extends AbstractHealthIndicato
 
     private JwksHealth previousHealth;
 
+    protected final String name;
+
+    // do we want to log status?
+    protected boolean silent;
+
+    protected AbstractJwksHealthIndicator(String name) {
+        this.name = name;
+    }
 
     @Override
     protected void doHealthCheck(Health.Builder builder) throws Exception {
@@ -43,17 +48,19 @@ protected void doHealthCheck(Health.Builder builder) throws Exception {
 
     protected void logInitialOrChangedState(JwksHealth health) {
         JwksHealth previousHealth = this.previousHealth; // defensive copy
-        if(previousHealth != null) {
-        	if(!previousHealth.isSuccess() && health.isSuccess()) {
-                logger.info("JWKs health transitioned to UP");
-        	} else if(previousHealth.isSuccess() && !health.isSuccess()) {
-        		logger.warn("JWKs health transitioned to DOWN");
-        	}
-        } else {
-            if(!health.isSuccess()) {
-                logger.warn("JWKs health initialized to DOWN");
+        if(!silent) {
+            if (previousHealth != null) {
+                if (!previousHealth.isSuccess() && health.isSuccess()) {
+                    logger.info("{} JWKs health transitioned to UP", name);
+                } else if (previousHealth.isSuccess() && !health.isSuccess()) {
+                    logger.warn("{} JWKs health transitioned to DOWN", name);
+                }
             } else {
-                logger.info("JWKs health initialized to UP");
+                if (!health.isSuccess()) {
+                    logger.warn("{} JWKs health initialized to DOWN", name);
+                } else {
+                    logger.info("{} JWKs health initialized to UP", name);
+                }
             }
         }
         this.previousHealth = health;

diff --git a/...-spring-common/src/main/java/org/entur/jwt/spring/actuate/DefaultJwksHealthIndicator.java b/...-spring-common/src/main/java/org/entur/jwt/spring/actuate/DefaultJwksHealthIndicator.java
@@ -13,6 +13,10 @@ public class DefaultJwksHealthIndicator extends AbstractJwksHealthIndicator impl
 
     private HealthReport healthReport;
 
+    public DefaultJwksHealthIndicator(String name) {
+        super(name);
+    }
+
     public void setJwkSetSource(JWKSetSource jwkSetSource) {
         this.jwkSetSource = jwkSetSource;
     }

diff --git a/...jwt-spring-common/src/main/java/org/entur/jwt/spring/actuate/ListJwksHealthIndicator.java b/...jwt-spring-common/src/main/java/org/entur/jwt/spring/actuate/ListJwksHealthIndicator.java
@@ -4,15 +4,13 @@
 import org.slf4j.LoggerFactory;
 
 import java.io.Closeable;
-import java.io.IOException;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.concurrent.CancellationException;
 import java.util.concurrent.ExecutionException;
 import java.util.concurrent.ExecutorCompletionService;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Future;
-import java.util.concurrent.atomic.AtomicBoolean;
 
 public class ListJwksHealthIndicator extends AbstractJwksHealthIndicator implements Closeable {
 
@@ -23,13 +21,16 @@ public class ListJwksHealthIndicator extends AbstractJwksHealthIndicator impleme
     private final ExecutorService executorService;
     private List<DefaultJwksHealthIndicator> healthIndicators = new ArrayList<>();
 
-    public ListJwksHealthIndicator(long maxDelay, ExecutorService executorService) {
+    public ListJwksHealthIndicator(long maxDelay, ExecutorService executorService, String name) {
+        super(name);
         this.maxDelay = maxDelay;
         this.executorService = executorService;
     }
 
     public void addHealthIndicators(DefaultJwksHealthIndicator healthIndicator) {
         this.healthIndicators.add(healthIndicator);
+
+        this.silent = healthIndicators.size() <= 1;
     }
 
     @Override