code review last episode

Author: jeromevdl

docs/core/logging.md

@@ -233,7 +233,7 @@ You can leverage the standard configuration files (_log4j2.xml_ or _logback.xml_
     <?xml version="1.0" encoding="UTF-8"?>
     <configuration>
         <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
-            <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+            <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
             </encoder>
         </appender>
         <logger name="com.example" level="DEBUG" additivity="false">
@@ -1008,7 +1008,7 @@ Logback configuration is done in _logback.xml_ and the Powertools [`LambdaJsonEn
 
 ```xml
     <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
-        <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+        <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
         </encoder>
     </appender>
 ```
@@ -1020,7 +1020,7 @@ The `LambdaJsonEncoder` can be customized in different ways:
 With the following configuration, you choose to log all the JSON messages as JSON and not as String (default is `false`):
 
 ```xml
-    <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+    <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
         <logMessagesAsJson>true</logMessagesAsJson>
     </encoder>
 ```
@@ -1030,7 +1030,7 @@ Utility by default emits `timestamp` field in the logs in format `yyyy-MM-dd'T'H
 If you need to customize format and timezone, you can change use the following:
 
 ```xml
-    <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+    <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
         <timestampFormat>yyyy-MM-dd HH:mm:ss</timestampFormat>
         <timestampFormatTimezoneId>Europe/Paris</timestampFormatTimezoneId>
     </encoder>
@@ -1041,7 +1041,7 @@ If you need to customize format and timezone, you can change use the following:
 - You can use a standard `ThrowableHandlingConverter` to customize the exception format (default is no converter). Example:
 
 ```xml
-    <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+    <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
         <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
             <maxDepthPerThrowable>30</maxDepthPerThrowable>
             <maxLength>2048</maxLength>
@@ -1058,15 +1058,15 @@ If you need to customize format and timezone, you can change use the following:
 - You can choose to add information about threads (default is `false`):
 
 ```xml
-    <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+    <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
         <includeThreadInfo>true</includeThreadInfo>
     </encoder>
 ```
 
 - You can even choose to remove Powertools information from the logs like function name, arn:
 
 ```xml
-    <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+    <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
         <includePowertoolsInfo>false</includePowertoolsInfo>
     </encoder>
 ```
@@ -1134,7 +1134,7 @@ Use the `LambdaEcsEncoder` rather than the `LambdaJsonEncoder` when configuring
     ```xml hl_lines="3"
     <configuration>
         <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
-            <encoder class="software.amazon.lambda.powertools.logging.LambdaEcsEncoder">
+            <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaEcsEncoder">
             </encoder>
         </appender>
         <root level="INFO">

powertools-logging/powertools-logging-log4j/src/main/java/software/amazon/lambda/powertools/logging/internal/Log4jLoggingManager.java renamed to powertools-logging/powertools-logging-log4j/src/main/java/software/amazon/lambda/powertools/logging/log4/internal/Log4jLoggingManager.java

@@ -12,13 +12,14 @@
  *
  */
 
-package software.amazon.lambda.powertools.logging.internal;
+package software.amazon.lambda.powertools.logging.log4.internal;
 
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.core.LoggerContext;
 import org.apache.logging.log4j.core.config.Configurator;
 import org.slf4j.Logger;
+import software.amazon.lambda.powertools.logging.internal.LoggingManager;
 
 /**
  * LoggingManager for Log4j2 (see {@link LoggingManager}).

powertools-logging/powertools-logging-log4j/src/main/resources/META-INF/services/software.amazon.lambda.powertools.logging.internal.LoggingManager

@@ -1 +1 @@
-software.amazon.lambda.powertools.logging.internal.Log4jLoggingManager
+software.amazon.lambda.powertools.logging.log4.internal.Log4jLoggingManager

powertools-logging/powertools-logging-log4j/src/test/java/software/amazon/lambda/powertools/logging/internal/Log4jLoggingManagerTest.java

@@ -10,6 +10,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.slf4j.event.Level;
+import software.amazon.lambda.powertools.logging.log4.internal.Log4jLoggingManager;
 
 class Log4jLoggingManagerTest {
 

powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/LambdaEcsEncoder.java renamed to powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/logback/LambdaEcsEncoder.java

@@ -12,7 +12,7 @@
  *
  */
 
-package software.amazon.lambda.powertools.logging;
+package software.amazon.lambda.powertools.logging.logback;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.FUNCTION_ARN;
@@ -31,7 +31,7 @@
 import ch.qos.logback.core.encoder.EncoderBase;
 import java.util.Map;
 import software.amazon.lambda.powertools.common.internal.LambdaHandlerProcessor;
-import software.amazon.lambda.powertools.logging.internal.LambdaEcsSerializer;
+import software.amazon.lambda.powertools.logging.logback.internal.LambdaEcsSerializer;
 
 
 /**
@@ -128,7 +128,7 @@ public byte[] footerBytes() {
      * (default is <b>null</b>, no throwableConverter):
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaEcsEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaEcsEncoder">
      *         <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
      *              <maxDepthPerThrowable>30</maxDepthPerThrowable>
      *              <maxLength>2048</maxLength>
@@ -160,7 +160,7 @@ public void setThrowableConverter(ThrowableHandlingConverter throwableConverter)
      * We strongly recommend to keep these information.
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaEcsEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaEcsEncoder">
      *         <includeCloudInfo>false</includeCloudInfo>
      *     </encoder>
      * }</pre>
@@ -186,7 +186,7 @@ public void setIncludeCloudInfo(boolean includeCloudInfo) {
      * We strongly recommend to keep these information.
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaEcsEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaEcsEncoder">
      *         <includeFaasInfo>false</includeFaasInfo>
      *     </encoder>
      * }</pre>

powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/LambdaJsonEncoder.java renamed to powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/logback/LambdaJsonEncoder.java

@@ -12,7 +12,7 @@
  *
  */
 
-package software.amazon.lambda.powertools.logging;
+package software.amazon.lambda.powertools.logging.logback;
 
 import static java.nio.charset.StandardCharsets.UTF_8;
 import static software.amazon.lambda.powertools.logging.LoggingUtils.LOG_MESSAGES_AS_JSON;
@@ -23,7 +23,7 @@
 import ch.qos.logback.classic.spi.IThrowableProxy;
 import ch.qos.logback.classic.spi.ThrowableProxy;
 import ch.qos.logback.core.encoder.EncoderBase;
-import software.amazon.lambda.powertools.logging.internal.LambdaJsonSerializer;
+import software.amazon.lambda.powertools.logging.logback.internal.LambdaJsonSerializer;
 
 /**
  * Custom encoder for logback that encodes logs in JSON format.
@@ -97,7 +97,7 @@ public byte[] footerBytes() {
      * Note that if you use the Lambda Advanced Logging Configuration, you should keep the default format.
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
      *         <timestampFormat>yyyy-MM-dd'T'HH:mm:ss.SSSZz</timestampFormat>
      *     </encoder>
      * }</pre>
@@ -112,7 +112,7 @@ public void setTimestampFormat(String timestampFormat) {
      * Specify the format of the time zone id for timestamp (default is <b>null</b>, no timezone):
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
      *         <timestampFormatTimezoneId>Europe/Paris</timestampFormatTimezoneId>
      *     </encoder>
      * }</pre>
@@ -128,7 +128,7 @@ public void setTimestampFormatTimezoneId(String timestampFormatTimezoneId) {
      * (default is <b>null</b>, no throwableConverter):
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
      *         <throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
      *              <maxDepthPerThrowable>30</maxDepthPerThrowable>
      *              <maxLength>2048</maxLength>
@@ -152,7 +152,7 @@ public void setThrowableConverter(ThrowableHandlingConverter throwableConverter)
      * Specify if thread information should be logged (default is <b>false</b>)
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
      *         <includeThreadInfo>true</includeThreadInfo>
      *     </encoder>
      * }</pre>
@@ -180,7 +180,7 @@ public void setIncludeThreadInfo(boolean includeThreadInfo) {
      * We strongly recommend to keep these information.
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
      *         <includePowertoolsInfo>false</includePowertoolsInfo>
      *     </encoder>
      * }</pre>
@@ -195,7 +195,7 @@ public void setIncludePowertoolsInfo(boolean includePowertoolsInfo) {
      * Specify if messages should be logged as JSON, without escaping string (default is <b>false</b>):
      * <br/>
      * <pre>{@code
-     *     <encoder class="software.amazon.lambda.powertools.logging.LambdaJsonEncoder">
+     *     <encoder class="software.amazon.lambda.powertools.logging.logback.LambdaJsonEncoder">
      *         <logMessagesAsJson>true</logMessagesAsJson>
      *     </encoder>
      * }</pre>

powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/internal/JsonUtils.java renamed to powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/logback/internal/JsonUtils.java

@@ -12,7 +12,7 @@
  *
  */
 
-package software.amazon.lambda.powertools.logging.internal;
+package software.amazon.lambda.powertools.logging.logback.internal;
 
 /**
  * Json tools to serialize attributes manually, to avoid using further dependencies (jackson, gson...)

powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/internal/LambdaEcsSerializer.java renamed to powertools-logging/powertools-logging-logback/src/main/java/software/amazon/lambda/powertools/logging/logback/internal/LambdaEcsSerializer.java

@@ -12,9 +12,7 @@
  *
  */
 
-package software.amazon.lambda.powertools.logging.internal;
-
-import static software.amazon.lambda.powertools.logging.internal.JsonUtils.serializeAttributeAsString;
+package software.amazon.lambda.powertools.logging.logback.internal;
 
 import ch.qos.logback.classic.Level;
 import java.text.DateFormat;
@@ -25,6 +23,7 @@
 import java.util.TimeZone;
 import java.util.TreeMap;
 import java.util.regex.Matcher;
+import software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields;
 
 /**
  * This class will serialize the log events in ecs format (ElasticSearch).<br/>
@@ -83,28 +82,28 @@ public static void serializeTimestamp(StringBuilder builder, long timestamp, Str
             }
             formattedTimestamp = format.format(date);
         }
-        serializeAttributeAsString(builder, TIMESTAMP_ATTR_NAME, formattedTimestamp, false);
+        JsonUtils.serializeAttributeAsString(builder, TIMESTAMP_ATTR_NAME, formattedTimestamp, false);
     }
 
     public static void serializeThreadName(StringBuilder builder, String threadName) {
         if (threadName != null) {
-            serializeAttributeAsString(builder, THREAD_ATTR_NAME, threadName);
+            JsonUtils.serializeAttributeAsString(builder, THREAD_ATTR_NAME, threadName);
         }
     }
 
     public static void serializeLogLevel(StringBuilder builder, Level level) {
-        serializeAttributeAsString(builder, LEVEL_ATTR_NAME, level.toString());
+        JsonUtils.serializeAttributeAsString(builder, LEVEL_ATTR_NAME, level.toString());
     }
 
     public static void serializeFormattedMessage(StringBuilder builder, String formattedMessage) {
-        serializeAttributeAsString(builder, FORMATTED_MESSAGE_ATTR_NAME,
+        JsonUtils.serializeAttributeAsString(builder, FORMATTED_MESSAGE_ATTR_NAME,
                 formattedMessage.replace("\"", Matcher.quoteReplacement("\\\"")));
     }
 
     public static void serializeException(StringBuilder builder, String className, String message, String stackTrace) {
-        serializeAttributeAsString(builder, EXCEPTION_MSG_ATTR_NAME, message);
-        serializeAttributeAsString(builder, EXCEPTION_CLASS_ATTR_NAME, className);
-        serializeAttributeAsString(builder, EXCEPTION_STACK_ATTR_NAME, stackTrace);
+        JsonUtils.serializeAttributeAsString(builder, EXCEPTION_MSG_ATTR_NAME, message);
+        JsonUtils.serializeAttributeAsString(builder, EXCEPTION_CLASS_ATTR_NAME, className);
+        JsonUtils.serializeAttributeAsString(builder, EXCEPTION_STACK_ATTR_NAME, stackTrace);
     }
 
     public static void serializeException(StringBuilder builder, Throwable throwable) {
@@ -113,76 +112,76 @@ public static void serializeException(StringBuilder builder, Throwable throwable
     }
 
     public static void serializeThreadId(StringBuilder builder, String threadId) {
-        serializeAttributeAsString(builder, THREAD_ID_ATTR_NAME, threadId);
+        JsonUtils.serializeAttributeAsString(builder, THREAD_ID_ATTR_NAME, threadId);
     }
 
     public static void serializeAdditionalFields(StringBuilder builder, Map<String, String> mdc) {
         TreeMap<String, String> sortedMap = new TreeMap<>(mdc);
 
         sortedMap.forEach((k, v) -> {
             if (!PowertoolsLoggedFields.stringValues().contains(k)) {
-                serializeAttributeAsString(builder, k, v);
+                JsonUtils.serializeAttributeAsString(builder, k, v);
             }
         });
     }
 
     public static void serializeEcsVersion(StringBuilder builder, String ecsVersion) {
-        serializeAttributeAsString(builder, ECS_VERSION_ATTR_NAME, ecsVersion);
+        JsonUtils.serializeAttributeAsString(builder, ECS_VERSION_ATTR_NAME, ecsVersion);
     }
 
     public static void serializeServiceName(StringBuilder builder, String serviceName) {
-        serializeAttributeAsString(builder, SERVICE_NAME_ATTR_NAME, serviceName);
+        JsonUtils.serializeAttributeAsString(builder, SERVICE_NAME_ATTR_NAME, serviceName);
     }
 
     public static void serializeServiceVersion(StringBuilder builder, String serviceVersion) {
-        serializeAttributeAsString(builder, SERVICE_VERSION_ATTR_NAME, serviceVersion);
+        JsonUtils.serializeAttributeAsString(builder, SERVICE_VERSION_ATTR_NAME, serviceVersion);
     }
 
     public static void serializeLoggerName(StringBuilder builder, String loggerName) {
-        serializeAttributeAsString(builder, LOGGER_ATTR_NAME, loggerName);
+        JsonUtils.serializeAttributeAsString(builder, LOGGER_ATTR_NAME, loggerName);
     }
 
     public static void serializeCloudProvider(StringBuilder builder, String cloudProvider) {
-        serializeAttributeAsString(builder, CLOUD_PROVIDER_ATTR_NAME, cloudProvider);
+        JsonUtils.serializeAttributeAsString(builder, CLOUD_PROVIDER_ATTR_NAME, cloudProvider);
     }
 
     public static void serializeCloudService(StringBuilder builder, String cloudService) {
-        serializeAttributeAsString(builder, CLOUD_SERVICE_ATTR_NAME, cloudService);
+        JsonUtils.serializeAttributeAsString(builder, CLOUD_SERVICE_ATTR_NAME, cloudService);
     }
 
     public static void serializeCloudRegion(StringBuilder builder, String cloudRegion) {
-        serializeAttributeAsString(builder, CLOUD_REGION_ATTR_NAME, cloudRegion);
+        JsonUtils.serializeAttributeAsString(builder, CLOUD_REGION_ATTR_NAME, cloudRegion);
     }
 
     public static void serializeCloudAccountId(StringBuilder builder, String cloudAccountId) {
-        serializeAttributeAsString(builder, CLOUD_ACCOUNT_ATTR_NAME, cloudAccountId);
+        JsonUtils.serializeAttributeAsString(builder, CLOUD_ACCOUNT_ATTR_NAME, cloudAccountId);
     }
 
     public static void serializeColdStart(StringBuilder builder, String coldStart) {
-        serializeAttributeAsString(builder, FUNCTION_COLD_START_ATTR_NAME, coldStart);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_COLD_START_ATTR_NAME, coldStart);
     }
 
     public static void serializeFunctionExecutionId(StringBuilder builder, String requestId) {
-        serializeAttributeAsString(builder, FUNCTION_REQUEST_ID_ATTR_NAME, requestId);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_REQUEST_ID_ATTR_NAME, requestId);
     }
 
     public static void serializeFunctionId(StringBuilder builder, String functionArn) {
-        serializeAttributeAsString(builder, FUNCTION_ARN_ATTR_NAME, functionArn);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_ARN_ATTR_NAME, functionArn);
     }
 
     public static void serializeFunctionName(StringBuilder builder, String functionName) {
-        serializeAttributeAsString(builder, FUNCTION_NAME_ATTR_NAME, functionName);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_NAME_ATTR_NAME, functionName);
     }
 
     public static void serializeFunctionVersion(StringBuilder builder, String functionVersion) {
-        serializeAttributeAsString(builder, FUNCTION_VERSION_ATTR_NAME, functionVersion);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_VERSION_ATTR_NAME, functionVersion);
     }
 
     public static void serializeFunctionMemory(StringBuilder builder, String functionMemory) {
-        serializeAttributeAsString(builder, FUNCTION_MEMORY_ATTR_NAME, functionMemory);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_MEMORY_ATTR_NAME, functionMemory);
     }
 
     public static void serializeTraceId(StringBuilder builder, String traceId) {
-        serializeAttributeAsString(builder, FUNCTION_TRACE_ID_ATTR_NAME, traceId);
+        JsonUtils.serializeAttributeAsString(builder, FUNCTION_TRACE_ID_ATTR_NAME, traceId);
     }
 }