Merge pull request #12 from hortega/improve-logging-and-error-handling

Add Logback and Filter to log requests

Author: well1791

.env.example

@@ -1,4 +1,4 @@
-TWILIO_ACCOUNT_SID=
-TWILIO_API_KEY=
-TWILIO_API_SECRET=
-TWILIO_CONFIGURATION_SID=
+export TWILIO_ACCOUNT_SID=
+export TWILIO_API_KEY=
+export TWILIO_API_SECRET=
+export TWILIO_CONFIGURATION_SID=

.gitignore

@@ -25,6 +25,9 @@ local.properties
 .loadpath
 nb-configuration.xml
 
+.idea
+*.iml
+
 # Eclipse Core
 .project
 

pom.xml

@@ -16,7 +16,13 @@
         <dependency>
             <groupId>com.sparkjava</groupId>
             <artifactId>spark-core</artifactId>
-            <version>2.3</version>
+            <version>2.5.5</version>
+            <exclusions>
+                <exclusion>
+                    <groupId>org.slf4j</groupId>
+                    <artifactId>slf4j-simple</artifactId>
+                </exclusion>
+            </exclusions>
         </dependency>
         <dependency>
             <groupId>com.google.code.gson</groupId>
@@ -33,10 +39,30 @@
             <artifactId>twilio</artifactId>
             <version>(7.0,7.9)</version>
         </dependency>
+        <dependency>
+            <groupId>ch.qos.logback</groupId>
+            <artifactId>logback-classic</artifactId>
+            <version>1.2.2</version>
+        </dependency>
     </dependencies>
 
     <build>
          <plugins>
+             <plugin>
+                 <groupId>org.codehaus.mojo</groupId>
+                 <artifactId>exec-maven-plugin</artifactId>
+                 <version>1.1</version>
+                 <executions>
+                     <execution>
+                         <goals>
+                             <goal>java</goal>
+                         </goals>
+                     </execution>
+                 </executions>
+                 <configuration>
+                     <mainClass>com.twilio.Webapp</mainClass>
+                 </configuration>
+             </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-shade-plugin</artifactId>

src/main/java/com/twilio/LoggingFilter.java

@@ -0,0 +1,61 @@
+package com.twilio;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import spark.Filter;
+import spark.Request;
+import spark.Response;
+
+import java.util.Collection;
+import java.util.function.Function;
+import java.util.stream.Collectors;
+
+public class LoggingFilter implements Filter {
+
+    private static final String TEMPLATE_WITH_BODY =
+            "\nRequest {} {} {} HEADERS:[{}] BODY: {}\nResponse {} HEADERS:[{}] BODY: {} ";
+    private static final String TEMPLATE_WITH_NO_BODY =
+            "\nRequest {} {} {} HEADERS:[{}] \nResponse {} HEADERS:[{}]";
+    private static Logger logger = LoggerFactory.getLogger(LoggingFilter.class);
+
+    @Override
+    public void handle(Request request, Response response) throws Exception {
+        String requestHeaderString = buildHeadersString(request.headers(),
+                h -> request.headers(h));
+        String responseHeaderString = buildHeadersString(response.raw().getHeaderNames(),
+                h -> response.raw().getHeader(h));
+        String template;
+        Object[] params;
+        if(logger.isDebugEnabled()) {
+            template = TEMPLATE_WITH_BODY;
+            params = new Object[] {
+                    request.requestMethod(),
+                    request.pathInfo(),
+                    request.protocol(),
+                    requestHeaderString,
+                    request.body(),
+                    response.raw().getStatus(),
+                    responseHeaderString,
+                    response.body()
+            };
+        } else {
+            template = TEMPLATE_WITH_NO_BODY;
+            params = new Object[] {
+                    request.requestMethod(),
+                    request.pathInfo(),
+                    request.protocol(),
+                    requestHeaderString,
+                    response.raw().getStatus(),
+                    responseHeaderString,
+            };
+        }
+        logger.info(template, params);
+    }
+
+    private String buildHeadersString(Collection<String> headers, Function<String, String> getHeader) {
+        return headers
+                .stream()
+                .map(h -> h + ":" + getHeader.apply(h))
+                .collect(Collectors.joining(", "));
+    }
+}

src/main/java/com/twilio/Webapp.java

@@ -10,6 +10,7 @@
 import java.util.HashMap;
 import java.util.Properties;
 
+import static spark.Spark.afterAfter;
 import static spark.Spark.get;
 import static spark.Spark.staticFileLocation;
 
@@ -25,6 +26,9 @@ public static void main(String[] args) throws Exception {
     // Create a Faker instance to generate a random username for the connecting user
     Faker faker = new Faker();
 
+    // Log all requests and responses
+    afterAfter(new LoggingFilter());
+
     // Create an access token using our Twilio credentials
     get("/token", "application/json", (request, response) -> {
       // Generate a random username for the connecting client
@@ -50,6 +54,8 @@ public static void main(String[] args) throws Exception {
       Gson gson = new Gson();
       return gson.toJson(json);
     });
+
+
   }
 
   private static void dotenv() throws Exception {

src/main/resources/logback.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration scan="true" scanPeriod="30 seconds">
+    <!-- address performance concern with jul-to-slf4j -->
+    <contextListener class="ch.qos.logback.classic.jul.LevelChangePropagator">
+        <resetJUL>true</resetJUL>
+    </contextListener>
+
+    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
+            </pattern>
+        </encoder>
+    </appender>
+
+    <root level="info">
+        <appender-ref ref="STDOUT"/>
+    </root>
+</configuration>