support any Json Pointer path

Author: Pankaj Agrawal

powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/CorrelationIdPath.java

@@ -0,0 +1,23 @@
+package software.amazon.lambda.powertools.logging;
+
+/**
+ * Supported Event types from which Correlation ID can be extracted
+ */
+public class CorrelationIdPathConstants {
+    /**
+     * To use when function is expecting API Gateway Rest API Request event
+     */
+    public static final String API_GATEWAY_REST = "/requestContext/requestId";
+    /**
+     * To use when function is expecting API Gateway HTTP API Request event
+     */
+    public static final String  API_GATEWAY_HTTP = "/requestContext/requestId";
+    /**
+     * To use when function is expecting Application Load balancer Request event
+     */
+    public static final String APPLICATION_LOAD_BALANCER = "/headers/x-amzn-trace-id";
+    /**
+     * To use when function is expecting Event Bridge Request event
+     */
+    public static final String  EVENT_BRIDGE = "/id";
+}

powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/CorrelationIdPathConstants.java

@@ -18,8 +18,6 @@
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.DISABLED;
-
 /**
  * {@code Logging} is used to signal that the annotated method should be
  * extended with Logging functionality.
@@ -71,7 +69,8 @@
     double samplingRate() default 0;
 
     /**
-     * Type of Event from where to extract correlation id from.
+     * Json Pointer path to extract correlation id from.
+     * @see  <a href=https://datatracker.ietf.org/doc/html/draft-ietf-appsawg-json-pointer-03/>
      */
-    CorrelationIdPath correlationIdPath() default DISABLED;
+    String correlationIdPath() default "";
 }

powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/Logging.java

@@ -19,12 +19,9 @@
 import java.io.InputStream;
 import java.io.InputStreamReader;
 import java.io.OutputStreamWriter;
-import java.util.Arrays;
 import java.util.Map;
 import java.util.Optional;
 import java.util.Random;
-import java.util.function.Consumer;
-import java.util.function.Predicate;
 
 import com.fasterxml.jackson.core.JsonPointer;
 import com.fasterxml.jackson.core.JsonProcessingException;
@@ -39,7 +36,6 @@
 import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
 import org.aspectj.lang.annotation.Pointcut;
-import software.amazon.lambda.powertools.logging.CorrelationIdPath;
 import software.amazon.lambda.powertools.logging.Logging;
 import software.amazon.lambda.powertools.logging.LoggingUtils;
 
@@ -54,8 +50,6 @@
 import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnRequestHandler;
 import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.placedOnStreamHandler;
 import static software.amazon.lambda.powertools.core.internal.LambdaHandlerProcessor.serviceName;
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.AUTO_DETECT;
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.DISABLED;
 import static software.amazon.lambda.powertools.logging.LoggingUtils.appendKey;
 import static software.amazon.lambda.powertools.logging.LoggingUtils.appendKeys;
 import static software.amazon.lambda.powertools.logging.LoggingUtils.objectMapper;
@@ -103,7 +97,7 @@ public Object around(ProceedingJoinPoint pjp,
             proceedArgs = logEvent(pjp);
         }
 
-        if (logging.correlationIdPath() != DISABLED) {
+        if (!logging.correlationIdPath().isEmpty()) {
             proceedArgs = captureCorrelationId(logging.correlationIdPath(), pjp);
         }
 
@@ -173,7 +167,7 @@ private Object[] logEvent(final ProceedingJoinPoint pjp) {
         return args;
     }
 
-    private Object[] captureCorrelationId(final CorrelationIdPath correlationIdPath,
+    private Object[] captureCorrelationId(final String correlationIdPath,
                                           final ProceedingJoinPoint pjp) {
         Object[] args = pjp.getArgs();
         if (isHandlerMethod(pjp)) {
@@ -205,37 +199,17 @@ private Object[] captureCorrelationId(final CorrelationIdPath correlationIdPath,
         return args;
     }
 
-    private void setCorrelationIdFromNode(CorrelationIdPath correlationIdPath, ProceedingJoinPoint pjp, JsonNode jsonNode) {
-        if (correlationIdPath == AUTO_DETECT) {
-            autoDetect(pjp, jsonNode);
-        } else {
-            JsonNode node = jsonNode.at(JsonPointer.compile(correlationIdPath.getPath()));
+    private void setCorrelationIdFromNode(String correlationIdPath, ProceedingJoinPoint pjp, JsonNode jsonNode) {
+        JsonNode node = jsonNode.at(JsonPointer.compile(correlationIdPath));
 
-            String asText = node.asText();
-            if (null != asText && !asText.isEmpty()) {
-                LoggingUtils.setCorrelationId(asText);
-            } else {
-                logger(pjp).debug("Unable to extract any correlation id. Is your function expecting supported event type?");
-            }
+        String asText = node.asText();
+        if (null != asText && !asText.isEmpty()) {
+            LoggingUtils.setCorrelationId(asText);
+        } else {
+            logger(pjp).debug("Unable to extract any correlation id. Is your function expecting supported event type?");
         }
     }
 
-    private void autoDetect(ProceedingJoinPoint pjp,
-                            JsonNode jsonNode) {
-        Arrays.stream(CorrelationIdPath.values())
-                .filter(path -> path != AUTO_DETECT && path != DISABLED)
-                .forEach(correlationIdPath1 -> {
-                    JsonNode node = jsonNode.at(JsonPointer.compile(correlationIdPath1.getPath()));
-                    String asText = node.asText();
-
-                    if (null != asText && !asText.isEmpty()) {
-                        logger(pjp).debug("Auto detected correlation id from event type: {}", correlationIdPath1);
-                        LoggingUtils.setCorrelationId(asText);
-                    }
-                });
-    }
-
-
     private Object[] logFromInputStream(final ProceedingJoinPoint pjp) {
         Object[] args = pjp.getArgs();
 

powertools-logging/src/main/java/software/amazon/lambda/powertools/logging/internal/LambdaLoggingAspect.java

@@ -18,9 +18,11 @@
 import com.amazonaws.services.lambda.runtime.events.ApplicationLoadBalancerRequestEvent;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
+import software.amazon.lambda.powertools.logging.CorrelationIdPathConstants;
 import software.amazon.lambda.powertools.logging.Logging;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.APPLICATION_LOAD_BALANCER;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.API_GATEWAY_REST;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.APPLICATION_LOAD_BALANCER;
 
 public class PowerLogToolAlbCorrelationId implements RequestHandler<ApplicationLoadBalancerRequestEvent, Object> {
     private final Logger LOG = LogManager.getLogger(PowerLogToolAlbCorrelationId.class);
@@ -32,9 +34,4 @@ public Object handleRequest(ApplicationLoadBalancerRequestEvent input, Context c
         LOG.debug("Test debug event");
         return null;
     }
-
-    @Logging
-    public void anotherMethod() {
-        System.out.println("test");
-    }
 }

powertools-logging/src/test/java/software/amazon/lambda/powertools/logging/handlers/PowerLogToolAlbCorrelationId.java

@@ -15,14 +15,12 @@
 
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;
-import com.amazonaws.services.lambda.runtime.events.APIGatewayProxyRequestEvent;
 import com.amazonaws.services.lambda.runtime.events.APIGatewayV2HTTPEvent;
 import org.apache.logging.log4j.LogManager;
 import org.apache.logging.log4j.Logger;
 import software.amazon.lambda.powertools.logging.Logging;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.API_GATEWAY_HTTP;
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.API_GATEWAY_REST;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.API_GATEWAY_HTTP;
 
 public class PowerLogToolApiGatewayHttpApiCorrelationId implements RequestHandler<APIGatewayV2HTTPEvent, Object> {
     private final Logger LOG = LogManager.getLogger(PowerLogToolApiGatewayHttpApiCorrelationId.class);
@@ -34,9 +32,4 @@ public Object handleRequest(APIGatewayV2HTTPEvent input, Context context) {
         LOG.debug("Test debug event");
         return null;
     }
-
-    @Logging
-    public void anotherMethod() {
-        System.out.println("test");
-    }
 }

powertools-logging/src/test/java/software/amazon/lambda/powertools/logging/handlers/PowerLogToolApiGatewayHttpApiCorrelationId.java

@@ -20,7 +20,7 @@
 import org.apache.logging.log4j.Logger;
 import software.amazon.lambda.powertools.logging.Logging;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPath.API_GATEWAY_REST;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.API_GATEWAY_REST;
 
 public class PowerLogToolApiGatewayRestApiCorrelationId implements RequestHandler<APIGatewayProxyRequestEvent, Object> {
     private final Logger LOG = LogManager.getLogger(PowerLogToolApiGatewayRestApiCorrelationId.class);
@@ -32,9 +32,4 @@ public Object handleRequest(APIGatewayProxyRequestEvent input, Context context)
         LOG.debug("Test debug event");
         return null;
     }
-
-    @Logging
-    public void anotherMethod() {
-        System.out.println("test");
-    }
 }

powertools-logging/src/test/java/software/amazon/lambda/powertools/logging/handlers/PowerLogToolApiGatewayRestApiCorrelationId.java

@@ -50,7 +50,6 @@
 import software.amazon.lambda.powertools.logging.handlers.PowerLogToolAlbCorrelationId;
 import software.amazon.lambda.powertools.logging.handlers.PowerLogToolApiGatewayHttpApiCorrelationId;
 import software.amazon.lambda.powertools.logging.handlers.PowerLogToolApiGatewayRestApiCorrelationId;
-import software.amazon.lambda.powertools.logging.handlers.PowerLogToolAutoCorrelationId;
 import software.amazon.lambda.powertools.logging.handlers.PowerLogToolEnabled;
 import software.amazon.lambda.powertools.logging.handlers.PowerLogToolEnabledForStream;
 import software.amazon.lambda.powertools.logging.handlers.PowerToolDisabled;
@@ -290,18 +289,6 @@ void shouldLogCorrelationIdOnALBEvent(ApplicationLoadBalancerRequestEvent event)
                 .containsEntry("correlation_id", event.getHeaders().get("x-amzn-trace-id"));
     }
 
-    @ParameterizedTest
-    @Event(value = "albEvent.json", type = ApplicationLoadBalancerRequestEvent.class)
-    void shouldLogCorrelationIdOnAutoDetect(ApplicationLoadBalancerRequestEvent event) {
-        RequestHandler<ApplicationLoadBalancerRequestEvent, Object> handler = new PowerLogToolAutoCorrelationId();
-        handler.handleRequest(event, context);
-
-        assertThat(ThreadContext.getImmutableContext())
-                .hasSize(EXPECTED_CONTEXT_SIZE + 1)
-                .containsEntry("correlation_id", event.getHeaders().get("x-amzn-trace-id"));
-    }
-
-
     private void setupContext() {
         when(context.getFunctionName()).thenReturn("testFunction");
         when(context.getInvokedFunctionArn()).thenReturn("testArn");