Added new fields to request context and fixed a couple of issues with log formatter for #116

Author: sapessi

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/internal/servlet/ApacheCombinedServletLogFormatter.java

@@ -11,7 +11,9 @@
 import javax.ws.rs.core.SecurityContext;
 
 import java.text.SimpleDateFormat;
+import java.time.Instant;
 import java.util.Calendar;
+import java.util.Date;
 import java.util.Locale;
 
 import static com.amazonaws.serverless.proxy.RequestReader.API_GATEWAY_CONTEXT_PROPERTY;
@@ -36,29 +38,37 @@ public ApacheCombinedServletLogFormatter() {
     public String format(ContainerRequestType servletRequest, ContainerResponseType servletResponse, SecurityContext ctx) {
         //LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-agent}i\"" combined
         StringBuilder logLineBuilder = new StringBuilder();
+        ApiGatewayRequestContext gatewayContext = (ApiGatewayRequestContext)servletRequest.getAttribute(API_GATEWAY_CONTEXT_PROPERTY);
 
         // %h
         logLineBuilder.append(servletRequest.getRemoteAddr());
         logLineBuilder.append(" ");
 
         // %l
-        if (servletRequest instanceof AwsProxyHttpServletRequest && servletRequest.getAttribute(API_GATEWAY_CONTEXT_PROPERTY) != null) {
-            ApiGatewayRequestContext gatewayContext = (ApiGatewayRequestContext)servletRequest.getAttribute(API_GATEWAY_CONTEXT_PROPERTY);
-            logLineBuilder.append(gatewayContext.getIdentity().getUserArn());
-            logLineBuilder.append(" ");
+        if (gatewayContext != null) {
+            if (gatewayContext.getIdentity().getUserArn() != null) {
+                logLineBuilder.append(gatewayContext.getIdentity().getUserArn());
+            } else {
+                logLineBuilder.append("-");
+            }
         } else {
-            logLineBuilder.append("- ");
+            logLineBuilder.append("-");
         }
+        logLineBuilder.append(" ");
 
         // %u
-        if (ctx != null) {
+        if (ctx != null && ctx.getUserPrincipal().getName() != null) {
             logLineBuilder.append(ctx.getUserPrincipal().getName());
+            logLineBuilder.append(" ");
         }
-        logLineBuilder.append(" ");
 
 
         // %t
-        logLineBuilder.append(dateFormat.format(Calendar.getInstance().getTime()));
+        if (gatewayContext != null) {
+            logLineBuilder.append(dateFormat.format(Date.from(Instant.ofEpochMilli(gatewayContext.getRequestTimeEpoch()))));
+        } else {
+            logLineBuilder.append(dateFormat.format(Calendar.getInstance().getTime()));
+        }
         logLineBuilder.append(" ");
 
         // %r
@@ -68,7 +78,7 @@ public String format(ContainerRequestType servletRequest, ContainerResponseType
         logLineBuilder.append(servletRequest.getPathInfo());
         logLineBuilder.append(" ");
         logLineBuilder.append(servletRequest.getProtocol());
-        logLineBuilder.append(" \" ");
+        logLineBuilder.append("\" ");
 
         // %>s
         logLineBuilder.append(servletResponse.getStatus());
@@ -89,15 +99,23 @@ public String format(ContainerRequestType servletRequest, ContainerResponseType
 
         // \"%{Referer}i\"
         logLineBuilder.append("\"");
-        logLineBuilder.append(servletRequest.getHeader("referer"));
-        logLineBuilder.append("\"");
+        if (servletRequest.getHeader("referer") != null) {
+            logLineBuilder.append(servletRequest.getHeader("referer"));
+        } else {
+            logLineBuilder.append("-");
+        }
+        logLineBuilder.append("\" ");
 
         // \"%{User-agent}i\"
         logLineBuilder.append("\"");
-        logLineBuilder.append(servletRequest.getHeader("user-agent"));
-        logLineBuilder.append("\"");
+        if (servletRequest.getHeader("user-agent") != null) {
+            logLineBuilder.append(servletRequest.getHeader("user-agent"));
+        } else {
+            logLineBuilder.append("-");
+        }
+        logLineBuilder.append("\" ");
 
-        logLineBuilder.append(" combined");
+        logLineBuilder.append("combined");
 
 
         return logLineBuilder.toString();

aws-serverless-java-container-core/src/main/java/com/amazonaws/serverless/proxy/model/ApiGatewayRequestContext.java

@@ -44,6 +44,8 @@ public class ApiGatewayRequestContext {
     private String stage;
     private String path;
     private String protocol;
+    private String requestTime;
+    private long requestTimeEpoch;
 
 
     //-------------------------------------------------------------
@@ -157,4 +159,24 @@ public String getProtocol() {
     public void setProtocol(String protocol) {
         this.protocol = protocol;
     }
+
+
+    public String getRequestTime() {
+        return requestTime;
+    }
+
+
+    public void setRequestTime(String requestTime) {
+        this.requestTime = requestTime;
+    }
+
+
+    public long getRequestTimeEpoch() {
+        return requestTimeEpoch;
+    }
+
+
+    public void setRequestTimeEpoch(long requestTimeEpoch) {
+        this.requestTimeEpoch = requestTimeEpoch;
+    }
 }