SF-4325 - adding APMLogData class to provide the APM project a means for providing trace information. EventAdapter updated to use APMLogData if available will fallback on existing methods.

darinhoward · darinhoward · commit b1b4563b4580 · 2016-07-12T09:26:45.000-05:00
diff --git a/.gitignore b/.gitignore
@@ -2,4 +2,6 @@
 .project
 .settings
 target
-coverage.ec
+coverage.ec
+.idea
+*.iml
diff --git a/src/main/java/com/stackify/api/common/log/APMLogData.java b/src/main/java/com/stackify/api/common/log/APMLogData.java
@@ -0,0 +1,98 @@
+package com.stackify.api.common.log;
+
+import com.stackify.api.WebRequestDetail;
+
+import java.util.Map;
+
+/**
+ * Provides means for APM to link and provide data elements from the current profiler trace.
+ *
+ * @author Darin Howard
+ */
+public class APMLogData {
+
+    /**
+     * Details if APM has established a link to this class. When false all methods return null.
+     */
+    public static boolean isLinked() {
+        return false;
+    }
+
+    public static String getTransactionId() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    public static String getUser() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    public static WebRequestDetail getWebRequest() {
+        if (isLinked()) {
+            WebRequestDetail.Builder builder = WebRequestDetail.newBuilder();
+            builder.userIpAddress(getUserIpAddress());
+            builder.httpMethod(getHttpMethod());
+            builder.requestProtocol(getRequestProtocol());
+            builder.requestUrl(getRequestUrl());
+            builder.requestUrlRoot(getRequestUrlRoot());
+            builder.referralUrl(getReferralUrl());
+            builder.headers(getHeaders());
+            builder.cookies(getCookies());
+            builder.queryString(getQueryString());
+            builder.sessionData(getSessionData());
+            return builder.build();
+        }
+        return null;
+    }
+
+    private static String getUserIpAddress() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static String getHttpMethod() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static String getRequestProtocol() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static String getRequestUrl() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static String getRequestUrlRoot() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static String getReferralUrl() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static Map<String, String> getHeaders() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static Map<String, String> getCookies() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static Map<String, String> getQueryString() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+
+    private static Map<String, String> getSessionData() {
+        // empty implementation - value will be provided by apm
+        return null;
+    }
+}
diff --git a/src/main/java/com/stackify/api/common/log/direct/LogEventAdapter.java b/src/main/java/com/stackify/api/common/log/direct/LogEventAdapter.java
@@ -15,18 +15,19 @@
  */
 package com.stackify.api.common.log.direct;
 
-import java.util.Date;
-
 import com.stackify.api.EnvironmentDetail;
 import com.stackify.api.LogMsg;
 import com.stackify.api.StackifyError;
 import com.stackify.api.WebRequestDetail;
 import com.stackify.api.common.lang.Throwables;
+import com.stackify.api.common.log.APMLogData;
 import com.stackify.api.common.log.EventAdapter;
 import com.stackify.api.common.log.ServletLogContext;
 import com.stackify.api.common.util.Maps;
 import com.stackify.api.common.util.Preconditions;
 
+import java.util.Date;
+
 /**
  * LogEvent
  * @author Eric Martin
@@ -70,14 +71,14 @@ public StackifyError getStackifyError(final LogEvent event, final Throwable exce
 			builder.error(Throwables.toErrorItem(event.getMessage(), event.getClassName(), event.getMethodName(), event.getLineNumber()));
 		}
 
-		String user = ServletLogContext.getUser();
-		
+		String user = APMLogData.isLinked() ? APMLogData.getUser() : ServletLogContext.getUser();
+
 		if (user != null) {
 			builder.userName(user);
 		}
 		
-		WebRequestDetail webRequest = ServletLogContext.getWebRequest();
-		
+		WebRequestDetail webRequest = APMLogData.isLinked() ? APMLogData.getWebRequest() : ServletLogContext.getWebRequest();
+
 		if (webRequest != null) {
 			builder.webRequestDetail(webRequest);
 		}
@@ -100,9 +101,9 @@ public LogMsg getLogMsg(final LogEvent event, final StackifyError error) {
 		if (event.getLevel() != null) {
 			builder.level(event.getLevel().toLowerCase());
 		}
-		
-		String transactionId = ServletLogContext.getTransactionId();
-		
+
+		String transactionId = APMLogData.isLinked() ? APMLogData.getTransactionId() : ServletLogContext.getTransactionId();
+
 		if (transactionId != null) {
 			builder.transId(transactionId);
 		}
