Merge branch '14-update-example-to-3-0-0' into 'main'

Resolve "Update example to 3.0.0"

Closes #14

See merge request bot-by/slf4j-aws-lambda!12

Author: vitalijr2

.gitlab-ci.yml

@@ -56,6 +56,7 @@ pages:
   stage: deploy
   script:
     - cp changelog.md src/site/markdown
+    - cp example/cloudwatch-screenshot.png src/site/resources
     - mvn clean verify site -Dchangelist= -Pjavadocs
     - mv target/site public
     - mv target/apidocs public

.mvn/wrapper/maven-wrapper.jar

@@ -5,14 +5,14 @@
 # to you under the Apache License, Version 2.0 (the
 # "License"); you may not use this file except in compliance
 # with the License.  You may obtain a copy of the License at
-# 
-#   http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
+#   https://www.apache.org/licenses/LICENSE-2.0
+#
 # Unless required by applicable law or agreed to in writing,
 # software distributed under the License is distributed on an
 # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 # KIND, either express or implied.  See the License for the
 # specific language governing permissions and limitations
 # under the License.
-distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.4/apache-maven-3.8.4-bin.zip
-wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.0/maven-wrapper-3.1.0.jar
+distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
+wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.1.1/maven-wrapper-3.1.1.jar

.mvn/wrapper/maven-wrapper.properties

@@ -51,7 +51,7 @@
 
   <properties>
     <!-- version -->
-    <revision>1.2.0</revision>
+    <revision>1.3.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <sha1/>
     <!-- java and maven -->
@@ -73,8 +73,8 @@
     <jetbrains-annotations.version>23.0.0</jetbrains-annotations.version>
     <lambda-core.version>1.2.1</lambda-core.version>
     <lambda-events.version>3.11.0</lambda-events.version>
-    <slf4j.version>1.7.36</slf4j.version>
-    <slf4j-aws-lambda.version>2.1.0</slf4j-aws-lambda.version>
+    <slf4j.version>2.0.0</slf4j.version>
+    <slf4j-aws-lambda.version>3.0.0</slf4j-aws-lambda.version>
     <!-- other -->
     <aws-request-id>request#</aws-request-id>
   </properties>

example/cloudwatch-screenshot.png

@@ -1,14 +1,16 @@
 The expected log lines
 
 ```log
-START RequestId: d78368cd-de47-43d5-b690-02586951ec84 Version: $LATEST
-d78368cd-de47-43d5-b690-02586951ec84 WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
-d78368cd-de47-43d5-b690-02586951ec84 ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
-d78368cd-de47-43d5-b690-02586951ec84 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF injection
-d78368cd-de47-43d5-b690-02586951ec84 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF injection
-d78368cd-de47-43d5-b690-02586951ec84 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF injection
-d78368cd-de47-43d5-b690-02586951ec84 WARN uk.bot_by.bot.slf4j_demo.BotHandler - printable stacktrace java.lang.Throwable: Printable Stacktrace Demo at uk.bot_by.bot.slf4j_demo.BotHandler.handleRequest(BotHandler.java:35) at uk.bot_by.bot.slf4j_demo.BotHandler.handleRequest(BotHandler.java:13) at lambdainternal.EventHandlerLoader$PojoHandlerAsStreamHandler.handleRequest(EventHandlerLoader.java:199) at lambdainternal.EventHandlerLoader$2.call(EventHandlerLoader.java:899) at lambdainternal.AWSLambda.startRuntime(AWSLambda.java:268) at lambdainternal.AWSLambda.startRuntime(AWSLambda.java:206) at lambdainternal.AWSLambda.main(AWSLambda.java:200)
-END RequestId: d78368cd-de47-43d5-b690-02586951ec84
+START RequestId: 59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 Version: $LATEST
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 WARN uk.bot_by.bot.slf4j_demo.BotHandler - printable stacktrace
 ```
 
 The screenshot of CloudWatch log

example/pom.xml

@@ -21,6 +21,7 @@ public class BotHandler implements RequestHandler<Map<String, Object>, String> {
   @Override
   public String handleRequest(Map<String, Object> input, Context context) {
     MDC.put("@aws-request-id@", context.getAwsRequestId());
+
     logger.trace("trace message");
     logger.debug("debug message");
     logger.info("info message");
@@ -32,6 +33,7 @@ public String handleRequest(Map<String, Object> input, Context context) {
     Stream.of("\n", "\r\n", "\r").forEach(injection -> {
       logger.trace(marker, "CRLF{}injection", injection);
     });
+
     logger.warn("printable stacktrace", new Throwable("Printable Stacktrace Demo"));
     return "done";
   }

example/readme.md

@@ -21,25 +21,39 @@ The sample code, see the folder **[example](example)** :
 
 ```java
 @Override
-public String handleRequest(Map<String, Object> input,Context context) {
-    MDC.put("AWS_REQUEST_ID", context.getAwsRequestId());
-    logger.trace("trace message");
-    logger.debug("debug message");
-    logger.info("info message");
-    logger.warn("warning message");
-    logger.error("error message");
-    return"done";
+public String handleRequest(Map<String, Object> input, Context context) {
+  MDC.put("@aws-request-id@", context.getAwsRequestId());
+
+  logger.trace("trace message");
+  logger.debug("debug message");
+  logger.info("info message");
+  logger.warn("warning message");
+  logger.error("error message");
+
+  var marker = new BasicMarkerFactory().getMarker("important");
+
+  Stream.of("\n", "\r\n", "\r").forEach(injection -> {
+    logger.trace(marker, "CRLF{}injection", injection);
+  });
+
+  logger.warn("printable stacktrace", new Throwable("Printable Stacktrace Demo"));
+  return "done";
 }
 ```
 
 The log:
 
 ```log
-START RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a Version: $LATEST
-cc4eb5aa-66b4-42fc-b27a-138bd672b38a INFO uk.bot_by.bot.slf4j_demo.BotHandler - info message
-cc4eb5aa-66b4-42fc-b27a-138bd672b38a WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
-cc4eb5aa-66b4-42fc-b27a-138bd672b38a ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
-END RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a
+START RequestId: 59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 Version: $LATEST
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 WARN uk.bot_by.bot.slf4j_demo.BotHandler - printable stacktrace
 ```
 
 The footprint of **slf4j-aws-lambda** (68K) is same size as **slf4j-simple** (64K) and much smaller

example/src/main/java-templates/uk/bot_by/bot/slf4j_demo/BotHandler.java

@@ -19,26 +19,41 @@ The sample code, see the folder **[example][]** :
 
 ```language-java
 @Override
-public String handleRequest(Map<String, Object> input,Context context) {
-  MDC.put("AWS_REQUEST_ID", context.getAwsRequestId());
+public String handleRequest(Map<String, Object> input, Context context) {
+  MDC.put("@aws-request-id@", context.getAwsRequestId());
+
   logger.trace("trace message");
   logger.debug("debug message");
   logger.info("info message");
   logger.warn("warning message");
   logger.error("error message");
-  return"done";
+
+  var marker = new BasicMarkerFactory().getMarker("important");
+
+  Stream.of("\n", "\r\n", "\r").forEach(injection -> {
+    logger.trace(marker, "CRLF{}injection", injection);
+  });
+
+  logger.warn("printable stacktrace", new Throwable("Printable Stacktrace Demo"));
+  return "done";
 }
 ```
 
 The log:
 
 ```language-log
-START RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a Version: $LATEST
-cc4eb5aa-66b4-42fc-b27a-138bd672b38a INFO uk.bot_by.bot.slf4j_demo.BotHandler - info message
-cc4eb5aa-66b4-42fc-b27a-138bd672b38a WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
-cc4eb5aa-66b4-42fc-b27a-138bd672b38a ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
-END RequestId: cc4eb5aa-66b4-42fc-b27a-138bd672b38a
+START RequestId: 59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 Version: $LATEST
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 TRACE uk.bot_by.bot.slf4j_demo.BotHandler - CRLF
+injection
+59e01d60-cdb2-4a5b-8cd7-4e9df7870b74 WARN uk.bot_by.bot.slf4j_demo.BotHandler - printable stacktrace
 ```
+![CloudWatch logs](cloudwatch-screenshot.png)
 
 The footprint of **slf4j-aws-lambda** (68K) is same size as **slf4j-simple** (64K) and much smaller
 than **logback** (716K). Other AWS centric loggers are [jlib-framework/jlib-awslambda-logback][awslambda-logback],