Merge pull request #203 from xenit-eu/tomcat-7-json-logging

add json logging to tomcat 7 with java 8
xenit-eu · Dec 13, 2023 · f7ae7f5 · f7ae7f5
2 parents b18167c + 8e733d9
commit f7ae7f5
Show file tree

Hide file tree

Showing 8 changed files with 52 additions and 61 deletions.
diff --git a/tomcat-base/build.gradle b/tomcat-base/build.gradle
@@ -42,14 +42,14 @@ subprojects {
         implementation "org.apache.tomcat:tomcat-jasper:${tomcatVersion}"
         implementation "org.apache.tomcat:tomcat-jasper-el:${tomcatVersion}"
         implementation "org.apache.tomcat:tomcat-jsp-api:${tomcatVersion}"
-//        implementation "eu.xenit.logging:json-logging:${jsonLoggingVersion}"
+        implementation "eu.xenit.logging:json-logging-java-8:${jsonLoggingVersion}"
         implementation "com.fasterxml.jackson.core:jackson-databind:2.15.2"
         testImplementation "org.junit.jupiter:junit-jupiter-api:5.10.0"
         testImplementation("org.junit-pioneer:junit-pioneer:1.9.1")
         testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:5.10.0"
-//        sharedLibs("eu.xenit.logging:json-logging:${jsonLoggingVersion}") {
-//            transitive = false
-//        }
+        sharedLibs("eu.xenit.logging:json-logging-java-8:${jsonLoggingVersion}") {
+            transitive = false
+        }
     }
 
     boolean isRelease = ci.branch?.equals("master")

diff --git a/tomcat-base/src/shared/main/bash/entrypoint/docker-entrypoint.d/89-check-validity.sh b/tomcat-base/src/shared/main/bash/entrypoint/docker-entrypoint.d/89-check-validity.sh
@@ -1,14 +1,12 @@
 #!/bin/bash
 
 currentDate=$(date +%s)
-if [ -z "${BUILD_DATE}" ]
-then
-    1>&2 echo "$(tput -Txterm setaf 3)"'{ "timestamp" : '"$(date -d @$currentDate +"%s")"' ,"severity" : "WARN", "type" : "application","component" : "docker-entrypoint" ,"fullMessage" : "Unable to determine image age: BUILD_DATE is not set"}'"$(tput -Txterm sgr0)"
+if [ -z "${BUILD_DATE}" ]; then
+  echo '{ "timestamp" : '"$(date -d @$currentDate +"%s")"' ,"severity" : "WARN", "type" : "application","component" : "docker-entrypoint" ,"fullMessage" : "Unable to determine image age: BUILD_DATE is not set"}'
 else
-    printf -v buildDate "%.0f\n" "$BUILD_DATE"
-    timeelapsed=`expr ${currentDate} - ${buildDate}`
-    if [ $timeelapsed -ge 2592000 ] # 30 days
-    then
-	1>&2 echo "$(tput -Txterm setaf 3)"'{ "timestamp" : '"$(date -d @$currentDate +"%s")"' ,"severity" : "WARN", "type" : "application","component" : "docker-entrypoint" , "fullMessage" : "This is an old image: BUILD_DATE='"$(date -d @$BUILD_DATE +"%Y-%m-%d %H:%M:%S")"' and currentDate='"$(date -d @$currentDate +"%Y-%m-%d %H:%M:%S")"'"}'"$(tput -Txterm sgr0)"
-    fi
+  printf -v buildDate "%.0f\n" "$BUILD_DATE"
+  timeelapsed=$(expr ${currentDate} - ${buildDate})
+  if [ $timeelapsed -ge 2592000 ]; then # 30 days
+    echo '{ "timestamp" : '"$(date -d @$currentDate +"%s")"' ,"severity" : "WARN", "type" : "application","component" : "docker-entrypoint" , "fullMessage" : "This is an old image: BUILD_DATE='"$(date -d @$BUILD_DATE +"%Y-%m-%d %H:%M:%S")"' and currentDate='"$(date -d @$currentDate +"%Y-%m-%d %H:%M:%S")"'"}'
+  fi
 fi
diff --git a/tomcat-base/src/shared/main/java/eu/xenit/alfresco/tomcat/embedded/Main.java b/tomcat-base/src/shared/main/java/eu/xenit/alfresco/tomcat/embedded/Main.java
@@ -1,12 +1,12 @@
 package eu.xenit.alfresco.tomcat.embedded;
 
 import eu.xenit.alfresco.tomcat.embedded.alfresco.tomcat.AlfrescoTomcatCustomizer;
-import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
 import eu.xenit.alfresco.tomcat.embedded.config.DefaultConfigurationProvider;
 import eu.xenit.alfresco.tomcat.embedded.config.EnvironmentVariableConfigurationProvider;
+import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
 import eu.xenit.alfresco.tomcat.embedded.share.tomcat.ShareTomcatCustomizer;
 import eu.xenit.alfresco.tomcat.embedded.tomcat.TomcatFactory;
-//import eu.xenit.logging.json.jul.JsonFormatter;
+import eu.xenit.logging.json.jul.JsonFormatter;
 import org.apache.catalina.startup.Tomcat;
 
 import java.nio.file.Files;
@@ -67,14 +67,14 @@ public static void configureLoggerToJSONStdOut(Logger logger, String component,
             }
         };
 
-//        if (json) {
-//            JsonFormatter formatter = new JsonFormatter();
-//            formatter.setType("application");
-//            formatter.setComponent(component);
-//            formatter.setExtractStackTrace("true");
-//            formatter.setFilterStackTrace(true);
-//            customHandler.setFormatter(formatter);
-//        }
+        if (json) {
+            JsonFormatter formatter = new JsonFormatter();
+            formatter.setType("application");
+            formatter.setComponent(component);
+            formatter.setExtractStackTrace("true");
+            formatter.setFilterStackTrace(true);
+            customHandler.setFormatter(formatter);
+        }
 
         logger.addHandler(customHandler);
     }

diff --git a/...-base/src/shared/main/java/eu/xenit/alfresco/tomcat/embedded/healthcheck/HealthCheck.java b/...-base/src/shared/main/java/eu/xenit/alfresco/tomcat/embedded/healthcheck/HealthCheck.java
@@ -1,21 +1,13 @@
 package eu.xenit.alfresco.tomcat.embedded.healthcheck;
 
-import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
 import eu.xenit.alfresco.tomcat.embedded.config.DefaultConfigurationProvider;
 import eu.xenit.alfresco.tomcat.embedded.config.EnvironmentVariableConfigurationProvider;
+import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
 
 import java.io.IOException;
 import java.net.ConnectException;
 import java.net.HttpURLConnection;
-import java.net.URI;
 import java.net.URL;
-import java.net.http.HttpClient;
-import java.net.http.HttpClient.Version;
-import java.net.http.HttpConnectTimeoutException;
-import java.net.http.HttpRequest;
-import java.net.http.HttpResponse.BodyHandlers;
-import java.time.Duration;
-import java.util.Objects;
 
 public class HealthCheck {
     public static final String ALFRESCO_DEFAULT_LIVE_PROBE = "http://localhost:8080/alfresco";
@@ -44,7 +36,7 @@ public static void main(String[] args) throws IOException, InterruptedException
     private static int healthCheck(String endpoint, int statusCode, String[] args) throws IOException, InterruptedException {
         HealthCheckSpec spec = HealthCheck.setupHealthCheck(endpoint, statusCode, args);
         int exitCode = doHealthCheck(spec);
-        if(exitCode != 0) {
+        if (exitCode != 0) {
             System.exit(exitCode);
         }
         return exitCode;

diff --git a/tomcat-base/src/shared/main/java/eu/xenit/alfresco/tomcat/embedded/tomcat/TomcatFactory.java b/tomcat-base/src/shared/main/java/eu/xenit/alfresco/tomcat/embedded/tomcat/TomcatFactory.java
@@ -1,16 +1,7 @@
 package eu.xenit.alfresco.tomcat.embedded.tomcat;
 
-import static eu.xenit.alfresco.tomcat.embedded.utils.Utils.redirectLog4j;
-
 import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
-//import eu.xenit.logging.json.valve.JsonAccessLogValve;
-import java.io.IOException;
-import java.nio.charset.StandardCharsets;
-import java.nio.file.DirectoryStream;
-import java.nio.file.Files;
-import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.stream.Stream;
+import eu.xenit.logging.json.valve.JsonAccessLogValve;
 import org.apache.catalina.Host;
 import org.apache.catalina.LifecycleException;
 import org.apache.catalina.LifecycleListener;
@@ -19,10 +10,19 @@
 import org.apache.catalina.core.StandardContext;
 import org.apache.catalina.loader.WebappLoader;
 import org.apache.catalina.startup.Tomcat;
-import org.apache.coyote.http11.Http11NioProtocol;
 import org.apache.coyote.http11.Http11Protocol;
 import org.apache.naming.resources.VirtualDirContext;
 
+import java.io.IOException;
+import java.nio.charset.StandardCharsets;
+import java.nio.file.DirectoryStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.stream.Stream;
+
+import static eu.xenit.alfresco.tomcat.embedded.utils.Utils.redirectLog4j;
+
 public class TomcatFactory {
 
     private final TomcatConfiguration configuration;
@@ -118,11 +118,11 @@ private void addWebapp(Tomcat tomcat, Path path) {
             };
             ctx.addLifecycleListener(lifecycleListener);
 
-//            if (getConfiguration().isAccessLogging()) {
-//                JsonAccessLogValve valve = new JsonAccessLogValve();
-//                ctx.addValve(valve);
-//                ctx.getAccessLog();
-//            }
+            if (getConfiguration().isAccessLogging()) {
+                JsonAccessLogValve valve = new JsonAccessLogValve();
+                ctx.addValve(valve);
+                ctx.getAccessLog();
+            }
         }
     }
 

diff --git a/...va/eu/xenit/alfresco/tomcat/embedded/alfresco/tomcat/AlfrescoTomcatFactoryHelperTest.java b/...va/eu/xenit/alfresco/tomcat/embedded/alfresco/tomcat/AlfrescoTomcatFactoryHelperTest.java
@@ -1,22 +1,21 @@
 package eu.xenit.alfresco.tomcat.embedded.alfresco.tomcat;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-
 import eu.xenit.alfresco.tomcat.embedded.alfresco.config.AlfrescoConfiguration;
 import eu.xenit.alfresco.tomcat.embedded.alfresco.config.DefaultAlfrescoConfigurationProvider;
-import eu.xenit.alfresco.tomcat.embedded.config.ConfigurationProvider;
 import eu.xenit.alfresco.tomcat.embedded.config.DefaultConfigurationProvider;
 import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
+import org.junit.jupiter.api.Test;
+
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
 import java.net.URL;
-import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
 
 
 class AlfrescoTomcatFactoryHelperTest {

diff --git a/...est/java/eu/xenit/alfresco/tomcat/embedded/share/tomcat/ShareTomcatFactoryHelperTest.java b/...est/java/eu/xenit/alfresco/tomcat/embedded/share/tomcat/ShareTomcatFactoryHelperTest.java
@@ -1,12 +1,12 @@
 package eu.xenit.alfresco.tomcat.embedded.share.tomcat;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-
 import eu.xenit.alfresco.tomcat.embedded.config.DefaultConfigurationProvider;
 import eu.xenit.alfresco.tomcat.embedded.config.TomcatConfiguration;
 import eu.xenit.alfresco.tomcat.embedded.share.config.DefaultShareConfigurationProvider;
 import eu.xenit.alfresco.tomcat.embedded.share.config.ShareConfiguration;
+import org.junit.jupiter.api.Test;
+import org.junitpioneer.jupiter.SetEnvironmentVariable;
+
 import java.io.File;
 import java.io.IOException;
 import java.net.URISyntaxException;
@@ -15,8 +15,9 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import org.junit.jupiter.api.Test;
-import org.junitpioneer.jupiter.SetEnvironmentVariable;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
 
 
 class ShareTomcatFactoryHelperTest {

diff --git a/tomcat-base/src/shared/test/java/eu/xenit/alfresco/tomcat/embedded/utils/UtilsTest.java b/tomcat-base/src/shared/test/java/eu/xenit/alfresco/tomcat/embedded/utils/UtilsTest.java
@@ -1,13 +1,14 @@
 package eu.xenit.alfresco.tomcat.embedded.utils;
 
+import org.junit.jupiter.api.Assertions;
+import org.junit.jupiter.api.Test;
+
 import java.io.IOException;
 import java.io.Reader;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
 import java.util.Properties;
-import org.junit.jupiter.api.Assertions;
-import org.junit.jupiter.api.Test;
 
 class UtilsTest {