Add logback json appender

Bill O'Neil · Bill O'Neil · commit 7f5af272fac5 · 2021-11-20T01:18:06.000-05:00
diff --git a/gradle/dependencies.gradle b/gradle/dependencies.gradle
@@ -5,16 +5,17 @@ ext {
         okhttp            : '4.9.1',       // HTTP Client
         slf4j             : '1.7.31',      // Logging 
         logback           : '1.2.5',       // Logging
-        undertow          : '2.2.8.Final',// Webserver
+        logbackJson       : '0.1.5',
+        undertow          : '2.2.8.Final', // Webserver
         metrics           : '4.2.2',       // Metrics
-        guava             : '30.1.1-jre',    // Common / Helper libraries
+        guava             : '30.1.1-jre',  // Common / Helper libraries
         typesafeConfig    : '1.4.1',       // Configuration
         handlebars        : '4.2.0',       // HTML templating
         htmlCompressor    : '1.5.2',       // HTML compression
         hikaricp          : '4.0.3',       // JDBC connection pool
         jool              : '0.9.14',      // Functional Utils
         hsqldb            : '2.6.0',       // In memory SQL db
-        aws               : '1.12.62',    // AWS Java SDK
+        aws               : '1.12.62',     // AWS Java SDK
         flyway            : '5.1.4',       // DB migrations
         connectorj        : '8.0.25',      // JDBC MYSQL driver
         jooq              : '3.15.0',      // jOOQ
@@ -25,7 +26,7 @@ ext {
         sitemapgen4j      : '1.1.2',       // Sitemap generator for SEO
         jbcrypt           : '0.4',         // BCrypt salted hashing library
         romeRss           : '1.0',         // RSS Library
-        kotlin            : '1.4.0',      // Kotlin
+        kotlin            : '1.4.0',       // Kotlin
         javax             : '1.3.2',
         jbossLogging      : '3.4.2.Final',
         jbossThreads      : '3.4.0.Final',
@@ -55,6 +56,8 @@ ext {
         slf4jLog4j                : "org.slf4j:log4j-over-slf4j:$versions.slf4j",
         logback                   : "ch.qos.logback:logback-classic:$versions.logback",
         logbackCore               : "ch.qos.logback:logback-core:$versions.logback",
+        logbackJson               : "ch.qos.logback.contrib:logback-json-classic:$versions.logbackJson",
+        logbackJackson			  : "ch.qos.logback.contrib:logback-jackson:$versions.logbackJson",
         guava                     : "com.google.guava:guava:$versions.guava",
         typesafeConfig            : "com.typesafe:config:$versions.typesafeConfig",
         handlebars                : "com.github.jknack:handlebars:$versions.handlebars",
diff --git a/k8s/chart/templates/stubbornjava.yaml b/k8s/chart/templates/stubbornjava.yaml
@@ -52,6 +52,8 @@ spec:
           env:
             - name: ENV
               value: "prod"
+            - name: LOG_APPENDER
+              value: "JSON"
             - name: github.clientId
               valueFrom:
                 secretKeyRef:
diff --git a/stubbornjava-common/build.gradle b/stubbornjava-common/build.gradle
@@ -4,6 +4,8 @@ dependencies {
     api project(':stubbornjava-undertow')
     api libs.slf4j
     api libs.logback
+    api libs.logbackJson
+    api libs.logbackJackson
     api libs.jacksonCore
     api libs.jacksonDatabind
     api libs.jacksonDatabind
diff --git a/stubbornjava-webapp/src/main/resources/logback.xml b/stubbornjava-webapp/src/main/resources/logback.xml
@@ -1,5 +1,8 @@
 <configuration> 
 
+  <property name="LOG_APPENDER" value="${LOG_APPENDER:-STDOUT}" />
+
+  <!-- This appender is primarily used for local development -->
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
     <!-- encoders are  by default assigned the type
          ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
@@ -8,8 +11,19 @@
     </encoder>
   </appender>
 
+  <!-- The JSON appender is meant to be machine friendly for log parsing -->
+  <appender name="JSON" class="ch.qos.logback.core.ConsoleAppender">
+    <layout class="ch.qos.logback.contrib.json.classic.JsonLayout">
+        <jsonFormatter
+            class="ch.qos.logback.contrib.jackson.JacksonJsonFormatter">
+            <prettyPrint>true</prettyPrint>
+        </jsonFormatter>
+        <timestampFormat>yyyy-MM-dd' 'HH:mm:ss.SSS</timestampFormat>
+    </layout>
+  </appender>
+
   <root level="INFO">
-    <appender-ref ref="STDOUT" />
+    <appender-ref ref="${LOG_APPENDER}" />
   </root>
   
   <!-- 
