improve correlationId:

- use jmespath for correlationId
- add appsync + test
- rename constant

Author: jeromevdl

docs/core/logging.md

@@ -357,7 +357,7 @@ for known event sources, where either a request ID or X-Ray Trace ID are present
 === "App.java"
 
     ```java hl_lines="10"
-    import software.amazon.lambda.powertools.logging.CorrelationIdPathConstants;
+    import software.amazon.lambda.powertools.logging.CorrelationIdPaths;
 
     /**
      * Handler for requests to Lambda function.

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

@@ -17,21 +17,25 @@
 /**
  * Supported Event types from which Correlation ID can be extracted
  */
-public class CorrelationIdPathConstants {
+public class CorrelationIdPaths {
     /**
      * To use when function is expecting API Gateway Rest API Request event
      */
-    public static final String API_GATEWAY_REST = "/requestContext/requestId";
+    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";
+    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";
+    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";
+    public static final String EVENT_BRIDGE = "id";
+    /**
+     * To use when function is expecting an AppSync request
+     */
+    public static final String APPSYNC_RESOLVER = "request.headers.\"x-amzn-trace-id\"";
 }

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

@@ -64,7 +64,8 @@
 public @interface Logging {
 
     /**
-     * Set to true if you want to log the event received by the Lambda function handler
+     * Set to true if you want to log the event received by the Lambda function handler.
+     * Can also be configured with the 'POWERTOOLS_LOGGER_LOG_EVENT' environment variable
      */
     boolean logEvent() default false;
 

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

@@ -32,9 +32,9 @@
 import static software.amazon.lambda.powertools.logging.internal.PowertoolsLoggedFields.SERVICE;
 
 import com.amazonaws.services.lambda.runtime.Context;
-import com.fasterxml.jackson.core.JsonPointer;
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.databind.JsonNode;
+import io.burt.jmespath.Expression;
 import java.io.ByteArrayInputStream;
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -292,7 +292,8 @@ private Object[] captureCorrelationId(final String correlationIdPath,
     }
 
     private void setCorrelationIdFromNode(String correlationIdPath, ProceedingJoinPoint pjp, JsonNode jsonNode) {
-        JsonNode node = jsonNode.at(JsonPointer.compile(correlationIdPath));
+        Expression<JsonNode> jmesExpression = JsonConfig.get().getJmesPath().compile(correlationIdPath);
+        JsonNode node = jmesExpression.search(jsonNode);
 
         String asText = node.asText();
         if (null != asText && !asText.isEmpty()) {

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

@@ -14,7 +14,7 @@
 
 package software.amazon.lambda.powertools.logging.handlers;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.APPLICATION_LOAD_BALANCER;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPaths.APPLICATION_LOAD_BALANCER;
 
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;

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

@@ -14,7 +14,7 @@
 
 package software.amazon.lambda.powertools.logging.handlers;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.API_GATEWAY_HTTP;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPaths.API_GATEWAY_HTTP;
 
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;

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

@@ -14,7 +14,7 @@
 
 package software.amazon.lambda.powertools.logging.handlers;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.API_GATEWAY_REST;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPaths.API_GATEWAY_REST;
 
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestHandler;

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

@@ -0,0 +1,37 @@
+/*
+ * Copyright 2023 Amazon.com, Inc. or its affiliates.
+ * Licensed 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
+ * 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.
+ *
+ */
+
+package software.amazon.lambda.powertools.logging.handlers;
+
+import static software.amazon.lambda.powertools.logging.CorrelationIdPaths.APPSYNC_RESOLVER;
+
+import com.amazonaws.services.lambda.runtime.Context;
+import com.amazonaws.services.lambda.runtime.RequestStreamHandler;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import software.amazon.lambda.powertools.logging.Logging;
+
+public class PowertoolsLogAppSyncCorrelationId implements RequestStreamHandler {
+
+    private final Logger LOG = LoggerFactory.getLogger(PowertoolsLogAppSyncCorrelationId.class);
+
+    @Override
+    @Logging(correlationIdPath = APPSYNC_RESOLVER)
+    public void handleRequest(InputStream inputStream, OutputStream outputStream, Context context) throws IOException {
+        LOG.info("Test event");
+    }
+}

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

@@ -14,7 +14,7 @@
 
 package software.amazon.lambda.powertools.logging.handlers;
 
-import static software.amazon.lambda.powertools.logging.CorrelationIdPathConstants.EVENT_BRIDGE;
+import static software.amazon.lambda.powertools.logging.CorrelationIdPaths.EVENT_BRIDGE;
 
 import com.amazonaws.services.lambda.runtime.Context;
 import com.amazonaws.services.lambda.runtime.RequestStreamHandler;

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

@@ -64,6 +64,7 @@
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogAlbCorrelationId;
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogApiGatewayHttpApiCorrelationId;
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogApiGatewayRestApiCorrelationId;
+import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogAppSyncCorrelationId;
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogClearState;
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogDisabled;
 import software.amazon.lambda.powertools.logging.handlers.PowertoolsLogDisabledForStream;
@@ -314,10 +315,22 @@ void shouldLogCorrelationIdOnALBEvent(ApplicationLoadBalancerRequestEvent event)
     void shouldLogCorrelationIdOnStreamHandler() throws IOException {
         RequestStreamHandler handler = new PowertoolsLogEventBridgeCorrelationId();
         String eventId = "3";
-        String event = "{\"id\":" + eventId + "}"; // CorrelationIdPathConstants.EVENT_BRIDGE
+        String event = "{\"id\":" + eventId + "}"; // CorrelationIdPath.EVENT_BRIDGE
         ByteArrayInputStream inputStream = new ByteArrayInputStream(event.getBytes());
         handler.handleRequest(inputStream, new ByteArrayOutputStream(), context);
 
+        assertThat(MDC.getCopyOfContextMap())
+                .hasSize(EXPECTED_CONTEXT_SIZE + 1)
+                .containsEntry("correlation_id", eventId);
+    }
+
+    @Test
+    void shouldLogCorrelationIdOnAppSyncEvent() throws IOException {
+        RequestStreamHandler handler = new PowertoolsLogAppSyncCorrelationId();
+        String eventId = "456";
+        String event = "{\"request\":{\"headers\":{\"x-amzn-trace-id\":" + eventId + "}}}"; // CorrelationIdPath.APPSYNC_RESOLVER
+        ByteArrayInputStream inputStream = new ByteArrayInputStream(event.getBytes());
+        handler.handleRequest(inputStream, new ByteArrayOutputStream(), context);
 
         assertThat(MDC.getCopyOfContextMap())
                 .hasSize(EXPECTED_CONTEXT_SIZE + 1)