Merge branch 'add-marker-list-to-json' into 'main'

vitalijr2 · vitalijr2 · commit 8652fae120bc · 2023-04-19T07:21:28.000Z
Resolve "Add Marker list to JSON" Closes #27 See merge request bot-by/slf4j-aws-lambda!20
diff --git a/.gitignore b/.gitignore
@@ -1,6 +1,6 @@
+/public/
 target
 .flattened-pom.xml
 
 *~
 *.iml
-/public/
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml
@@ -29,7 +29,7 @@ build:
 test:
   stage: test
   script:
-    - mvn $MAVEN_CLI_OPTS -pl core,logger,json-logger verify
+    - mvn $MAVEN_CLI_OPTS verify
   artifacts:
     reports:
       junit:
diff --git a/.idea/compiler.xml b/.idea/compiler.xml
diff --git a/.idea/modules.xml b/.idea/modules.xml
diff --git a/example-lambda-json/cloudwatch-json-screenshot.png b/example-lambda-json/cloudwatch-json-screenshot.png
diff --git a/example-lambda-json/pom.xml b/example-lambda-json/pom.xml
@@ -17,7 +17,7 @@
 <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://maven.apache.org/POM/4.0.0"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-  <artifactId>slf4j-aws-lambda-json-example</artifactId>
+  <artifactId>example-lambda-json</artifactId>
   <build>
     <plugins>
       <plugin>
diff --git a/example-lambda-json/readme.md b/example-lambda-json/readme.md
@@ -9,47 +9,58 @@ The expected log lines
 
 ```json
 {
-    "level": "INFO",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "info message",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "level":"INFO",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "message":"info message",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 {
-    "level": "WARN",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "warning message",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "level":"WARN",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "message":"warning message",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 {
-    "level": "ERROR",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "error message",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "level":"ERROR",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "message":"error message",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 {
-    "level": "TRACE",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "CRLF\ninjection",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "level":"TRACE",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "markers":[
+    "important"
+  ],
+  "message":"CRLF\ninjection",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 {
-    "level": "TRACE",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "CRLF\r\ninjection",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "level":"TRACE",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "markers":[
+    "important"
+  ],
+  "message":"CRLF\r\ninjection",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 {
-    "level": "TRACE",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "CRLF\rinjection",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "level":"TRACE",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "markers":[
+    "important"
+  ],
+  "message":"CRLF\rinjection",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 {
-    "stack-trace": "java.lang.Throwable: Printable Stacktrace Demo\n\tat uk.bot_by.slf4j_demo.BotHandler.handleRequest(BotHandler.java:36)\n\tat uk.bot_by.slf4j_demo.BotHandler.handleRequest(BotHandler.java:12)\n\tat lambdainternal.EventHandlerLoader$PojoHandlerAsStreamHandler.handleRequest(EventHandlerLoader.java:205)\n\tat lambdainternal.EventHandlerLoader$2.call(EventHandlerLoader.java:905)\n\tat lambdainternal.AWSLambda.startRuntime(AWSLambda.java:261)\n\tat lambdainternal.AWSLambda.startRuntime(AWSLambda.java:200)\n\tat lambdainternal.AWSLambda.main(AWSLambda.java:194)\n",
-    "level": "WARN",
-    "logname": "uk.bot_by.slf4j_demo.BotHandler",
-    "message": "printable stacktrace",
-    "aws-request-id": "7b9af47e-d861-44b4-bde7-fa2e84ffb7cf"
+  "stack-trace":"java.lang.Throwable: Printable Stacktrace Demo\n\tat uk.bot_by.slf4j_demo.BotHandler.handleRequest(BotHandler.java:36)...",
+  "throwable-message":"Printable Stacktrace Demo",
+  "throwable-class":"java.lang.Throwable",
+  "level":"WARN",
+  "logname":"uk.bot_by.slf4j_demo.BotHandler",
+  "message":"printable stacktrace",
+  "aws-request-id":"2fd42680-a990-4b24-ae28-4213c86eb512"
 }
 ```
 
diff --git a/example-lambda/pom.xml b/example-lambda/pom.xml
@@ -17,7 +17,7 @@
 <project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://maven.apache.org/POM/4.0.0"
   xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
-  <artifactId>slf4j-aws-lambda-example</artifactId>
+  <artifactId>example-lambda</artifactId>
   <build>
     <plugins>
       <plugin>
diff --git a/json-logger/src/main/java/uk/bot_by/aws_lambda/slf4j/json_output/JSONLoggerOutput.java b/json-logger/src/main/java/uk/bot_by/aws_lambda/slf4j/json_output/JSONLoggerOutput.java
@@ -22,6 +22,7 @@
 import java.io.ByteArrayOutputStream;
 import java.io.PrintStream;
 import java.text.DateFormat;
+import java.util.ArrayList;
 import java.util.Date;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -42,6 +43,7 @@ public class JSONLoggerOutput implements AWSLambdaLoggerOutput {
   private static final String RELATIVE_TIMESTAMP = "relative-timestamp";
   private static final String LEVEL = "level";
   private static final String LOGNAME = "logname";
+  private static final String MARKERS = "markers";
   private static final String MESSAGE = "message";
   private static final String STACK_TRACE = "stack-trace";
   private static final Long START_TIME = System.currentTimeMillis();
@@ -62,6 +64,16 @@ private static void addLogName(AWSLambdaLoggerConfiguration configuration,
     }
   }
 
+  private static void addMarkerAndReferences(Marker marker, JSONObject jsonObject) {
+    if (nonNull(marker)) {
+      var markers = new ArrayList<String>();
+
+      marker.iterator().forEachRemaining(referenceMarker -> markers.add(referenceMarker.getName()));
+      markers.add(0, marker.getName());
+      jsonObject.put(MARKERS, markers);
+    }
+  }
+
   private static void addRequestId(AWSLambdaLoggerConfiguration configuration,
       JSONObject jsonObject) {
     if (nonNull(MDC.get(configuration.requestId()))) {
@@ -143,6 +155,7 @@ void log(@NotNull AWSLambdaLoggerConfiguration configuration, @NotNull LambdaLog
     addRequestId(configuration, jsonObject);
     addTimestamp(configuration, jsonObject);
     addThread(configuration, jsonObject);
+    addMarkerAndReferences(marker, jsonObject);
     addLevel(level, jsonObject);
     addLogName(configuration, jsonObject);
     jsonObject.put(MESSAGE, message);
diff --git a/json-logger/src/test/java/uk/bot_by/aws_lambda/slf4j/json_output/JSONLoggerOutputTest.java b/json-logger/src/test/java/uk/bot_by/aws_lambda/slf4j/json_output/JSONLoggerOutputTest.java
@@ -120,6 +120,48 @@ void logMessage() {
         stringCaptor.getValue(), true);
   }
 
+  @DisplayName("Marker")
+  @Test
+  void marker() {
+    // given
+    var marker = new BasicMarkerFactory().getMarker("aMarker");
+
+    when(configuration.requestId()).thenReturn("request#");
+
+    // when
+    loggerOutput.log(configuration, lambdaLogger, marker, Level.ERROR, "test error message", null);
+
+    // then
+    verify(lambdaLogger).log(stringCaptor.capture());
+
+    assertEquals(
+        "{\"level\":\"ERROR\",\"markers\":[\"aMarker\"],\"message\":\"test error message\"}",
+        stringCaptor.getValue(), true);
+  }
+
+  @DisplayName("Markers")
+  @Test
+  void markers() {
+    // given
+    var markerFactory = new BasicMarkerFactory();
+    var marker = markerFactory.getMarker("aMarker");
+    marker.add(markerFactory.getMarker("marker a"));
+    marker.add(markerFactory.getMarker("marker 1"));
+    marker.add(markerFactory.getMarker("marker *"));
+
+    when(configuration.requestId()).thenReturn("request#");
+
+    // when
+    loggerOutput.log(configuration, lambdaLogger, marker, Level.ERROR, "test error message", null);
+
+    // then
+    verify(lambdaLogger).log(stringCaptor.capture());
+
+    assertEquals(
+        "{\"level\":\"ERROR\",\"markers\":[\"aMarker\",\"marker a\",\"marker 1\",\"marker *\"],\"message\":\"test error message\"}",
+        stringCaptor.getValue(), true);
+  }
+
   @DisplayName("Show relative time")
   @Test
   void relativeTime() {
diff --git a/logger/src/test/java/uk/bot_by/aws_lambda/slf4j/lambda_logger/LambdaLoggerOutputTest.java b/logger/src/test/java/uk/bot_by/aws_lambda/slf4j/lambda_logger/LambdaLoggerOutputTest.java
@@ -259,7 +259,8 @@ void stackTrace() {
     when(configuration.requestId()).thenReturn("request#");
 
     // when
-    loggerOutput.log(configuration, lambdaLogger, null, Level.ERROR, "test error message", throwable);
+    loggerOutput.log(configuration, lambdaLogger, null, Level.ERROR, "test error message",
+        throwable);
 
     // then
     verify(lambdaLogger).log(stringCaptor.capture());
