Update example, custom level and marker separators

Closes #8 and #9

Author: vitalijr2

example/cloudwatch-screenshot.png

@@ -51,7 +51,7 @@
 
   <properties>
     <!-- version -->
-    <revision>1.1.0</revision>
+    <revision>1.2.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <sha1/>
     <!-- java and maven -->
@@ -74,7 +74,7 @@
     <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>1.1.0</slf4j-aws-lambda.version>
+    <slf4j-aws-lambda.version>2.1.0</slf4j-aws-lambda.version>
     <!-- other -->
     <aws-request-id>request#</aws-request-id>
   </properties>

example/pom.xml

@@ -1,16 +1,14 @@
 The expected log lines
 
 ```log
-INFO uk.bot_by.bot.slf4j_demo.BotHandler - Load version: 1.1.0
-START RequestId: 1cfba6fe-5030-4b00-9d0b-5406b30cbf8c Version: $LATEST
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c INFO uk.bot_by.bot.slf4j_demo.BotHandler - info message
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c WARN uk.bot_by.bot.slf4j_demo.BotHandler - warning message
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c ERROR uk.bot_by.bot.slf4j_demo.BotHandler - error message
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c INFO uk.bot_by.bot.slf4j_demo.BotHandler - CRLF injection
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c INFO uk.bot_by.bot.slf4j_demo.BotHandler - CRLF injection
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c INFO uk.bot_by.bot.slf4j_demo.BotHandler - CRLF injection
-1cfba6fe-5030-4b00-9d0b-5406b30cbf8c WARN uk.bot_by.bot.slf4j_demo.BotHandler - printable stacktrace java.lang.Throwable: Printable Stacktrace Demo  at ...
-END RequestId: 1cfba6fe-5030-4b00-9d0b-5406b30cbf8c
+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
 ```
 
 The screenshot of CloudWatch log

example/readme.md

@@ -7,6 +7,8 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.MDC;
+import org.slf4j.Marker;
+import org.slf4j.helpers.BasicMarkerFactory;
 
 public class BotHandler implements RequestHandler<Map<String, Object>, String> {
 
@@ -24,8 +26,11 @@ public String handleRequest(Map<String, Object> input, Context context) {
     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.info("CRLF{}injection", injection);
+      logger.trace(marker, "CRLF{}injection", injection);
     });
     logger.warn("printable stacktrace", new Throwable("Printable Stacktrace Demo"));
     return "done";

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

@@ -1 +1,6 @@
 requestId=${aws-request-id}
+log.uk.bot_by.bot=warn trace@important
+# multi-space
+logLevelSeparator=\\s+
+# single pipe symbol
+markerSeparator=\\|

example/src/main/resources/lambda-logger.properties

@@ -66,7 +66,7 @@
 
   <properties>
     <!-- version -->
-    <revision>2.0.0</revision>
+    <revision>2.1.0</revision>
     <changelist>-SNAPSHOT</changelist>
     <sha1/>
     <!-- java and maven -->

pom.xml

@@ -72,7 +72,7 @@
  * <strong>LOG_LEVEL_IN_BRACKETS</strong>, <strong>LOG_SHOW_DATE_TIME</strong>,
  * <strong>LOG_SHOW_NAME</strong>, <strong>LOG_SHOW_SHORT_NAME</strong>,
  * <strong>LOG_SHOW_THREAD_ID</strong>, <strong>LOG_SHOW_THREAD_NAME</strong>.
- *
+ * <p>
  * <strong>Fine-grained configuration with markers</strong>
  * <p>
  * The AWS Lambda Logger supports markers since <em>v2.0.0</em>.
@@ -85,12 +85,24 @@
  * The logger for {@code org.test.Class} has the common <em>warn</em> log level.
  * Also, it has additional levels <em>info</em> with the marker <em>iAmMarker</em>
  * and <em>trace</em> with markers <em>important</em> and <em>notify-admin</em>.
+ * <p>
+ * You can customize level and marker separators with properties <strong>logLevelSeparator</strong>
+ * and <strong>markerSeparator</strong>. Remember that separators are not a single characters but
+ * regular expressions. The environment variables are <strong>LOG_LEVEL_SEPARATOR</strong> and
+ * <strong>LOG_MARKER_SEPARATOR</strong> accordingly.
+ * <p>
+ * Example:
+ * <pre><code class="language-properties">
+ * log.org.test.Class=warn  info@iAmMarker trace@important|notify-admin
+ * # multi-space
+ * logLevelSeparator=\\s+
+ * # single pipe symbol
+ * markerSeparator=\\|
+ * </code></pre>
  */
 public class LambdaLoggerFactory implements ILoggerFactory {
 
   private static final String AT = "@";
-  private static final String COLON = ":";
-  private static final String COMMA = ",";
   private static final String CONFIGURATION_FILE = "lambda-logger.properties";
   private static final char DOT = '.';
   private static final String DOTS = "\\.+";
@@ -102,6 +114,8 @@ public class LambdaLoggerFactory implements ILoggerFactory {
   private final DateFormat dateTimeFormat;
   private final List<LoggerLevel> defaultLoggerLevel;
   private final boolean levelInBrackets;
+  private final String logLevelSeparator;
+  private final String markerSeparator;
   private final Properties properties;
   private final String requestId;
   private final boolean showDateTime;
@@ -119,6 +133,9 @@ public LambdaLoggerFactory() {
     loggers = new ConcurrentHashMap<>();
     properties = loadProperties(configurationFile);
     dateTimeFormat = getDateTimeFormat(ConfigurationProperty.DateTimeFormat);
+    // logLevelSeparator and markerSeparator should be resolved before defaultLoggerLevel
+    logLevelSeparator = getStringProperty(ConfigurationProperty.LogLevelSeparator);
+    markerSeparator = getStringProperty(ConfigurationProperty.MarkerSeparator);
     defaultLoggerLevel = getLoggerLevelProperty(ConfigurationProperty.DefaultLogLevel);
     levelInBrackets = getBooleanProperty(ConfigurationProperty.LevelInBrackets);
     requestId = getStringProperty(ConfigurationProperty.RequestId);
@@ -272,13 +289,13 @@ private List<LoggerLevel> parseLoggerLevelString(String loggerLevelString)
       throws IllegalArgumentException {
     var loggerLevels = new ArrayList<LoggerLevel>();
 
-    for (String loggerLevel : loggerLevelString.split(COMMA)) {
+    for (String loggerLevel : loggerLevelString.split(logLevelSeparator)) {
       var loggerLevelBuilder = LoggerLevel.builder();
       var loggerLevelWithMarkers = loggerLevel.split(AT);
 
       loggerLevelBuilder.level(Level.valueOf(loggerLevelWithMarkers[0].toUpperCase()));
       if (loggerLevelWithMarkers.length > 1) {
-        for (String markerName : loggerLevelWithMarkers[1].split(COLON)) {
+        for (String markerName : loggerLevelWithMarkers[1].split(markerSeparator)) {
           loggerLevelBuilder.marker(markerName);
         }
       }
@@ -292,12 +309,13 @@ public enum ConfigurationProperty {
 
     DateTimeFormat("dateTimeFormat", "LOG_DATE_TIME_FORMAT", null), DefaultLogLevel(
         "defaultLogLevel", "LOG_DEFAULT_LEVEL", "INFO"), LevelInBrackets("levelInBrackets",
-        "LOG_LEVEL_IN_BRACKETS", "false"), LogLevel("log.", "LOG_", null), RequestId("requestId",
-        "LOG_AWS_REQUEST_ID", "AWS_REQUEST_ID"), ShowDateTime("showDateTime", "LOG_SHOW_DATE_TIME",
-        "false"), ShowLogName("showLogName", "LOG_SHOW_NAME", "true"), ShowShortLogName(
-        "showShortLogName", "LOG_SHOW_SHORT_NAME", "false"), ShowThreadId("showThreadId",
-        "LOG_SHOW_THREAD_ID", "false"), ShowThreadName("showThreadName", "LOG_SHOW_THREAD_NAME",
-        "false");
+        "LOG_LEVEL_IN_BRACKETS", "false"), LogLevel("log.", "LOG_", null), LogLevelSeparator(
+        "logLevelSeparator", "LOG_LEVEL_SEPARATOR", ","), MarkerSeparator("markerSeparator",
+        "LOG_MARKER_SEPARATOR", ":"), RequestId("requestId", "LOG_AWS_REQUEST_ID",
+        "AWS_REQUEST_ID"), ShowDateTime("showDateTime", "LOG_SHOW_DATE_TIME", "false"), ShowLogName(
+        "showLogName", "LOG_SHOW_NAME", "true"), ShowShortLogName("showShortLogName",
+        "LOG_SHOW_SHORT_NAME", "false"), ShowThreadId("showThreadId", "LOG_SHOW_THREAD_ID",
+        "false"), ShowThreadName("showThreadName", "LOG_SHOW_THREAD_NAME", "false");
 
     public final String defaultValue;
     public final String propertyName;

src/main/java/uk/bot_by/aws_lambda/slf4j/LambdaLoggerFactory.java

@@ -45,6 +45,20 @@ The logger for `org.test.Class` has the common _warn_ log level.
 Also, it has additional levels _info_ with the marker _iAmMarker_
 and _trace_ with markers _important_ and _notify-admin_.
 
+You can customize level and marker separators with properties **logLevelSeparator** and
+**markerSeparator**. Remember that separators are not a single characters but regular expressions.
+The environment variables are **LOG_LEVEL_SEPARATOR** and **LOG_MARKER_SEPARATOR** accordingly.
+
+Example:
+
+```properties
+log.org.test.Class=warn  info@iAmMarker trace@important|notify-admin
+# multi-space
+logLevelSeparator=\\s+
+# single pipe symbol
+markerSeparator=\\|
+```
+
 
 [manual]: https://www.slf4j.org/manual.html
 

src/site/markdown/usage.md

@@ -260,6 +260,30 @@ void defaultLogLevelMulti() {
         () -> assertTrue(logger.isTraceEnabled(markerC), "trace with the marker C"));
   }
 
+  @DisplayName("Custom level and marker separators")
+  @Test
+  void customLevelAndMarkerSeparators() {
+    // given
+    var loggerFactory = spy(new LambdaLoggerFactory("custom-separators.properties"));
+
+    doReturn(printStream).when(loggerFactory).getPrintStream();
+
+    // when
+    var logger = loggerFactory.getLogger("org.test.Class");
+
+    // then
+    logger.isTraceEnabled();
+    assertAll("Check custom level and marker separators",
+        () -> assertFalse(logger.isTraceEnabled(), "trace"),
+        () -> assertFalse(logger.isDebugEnabled(), "debug"),
+        () -> assertFalse(logger.isInfoEnabled(), "info"),
+        () -> assertTrue(logger.isWarnEnabled(), "warn"),
+        () -> assertTrue(logger.isErrorEnabled(), "error"),
+        () -> assertTrue(logger.isInfoEnabled(markerA), "info with a marker"),
+        () -> assertTrue(logger.isTraceEnabled(markerB), "trace with the marker B"),
+        () -> assertTrue(logger.isTraceEnabled(markerC), "trace with the marker C"));
+  }
+
   @DisplayName("Read logger properties from the file, get logger then print out debug message")
   @Test
   void useLoggerProperties() {

src/test/java/uk/bot_by/aws_lambda/slf4j/PropertiesTest.java

@@ -0,0 +1,5 @@
+defaultLogLevel=warn  info@iAmMarker trace@important|notify-admin
+# multi-space
+logLevelSeparator=\\s+
+# single pipe symbol
+markerSeparator=\\|