Added HTTP tracing option (via tracing attribute to HTTPMonitored ann…

…otation) to microservices
wso2 · Mar 1, 2016 · 3422d6d · 3422d6d
1 parent 3596c4b
commit 3422d6d
Show file tree

Hide file tree

Showing 9 changed files with 118 additions and 10 deletions.
diff --git a/analytics/das-setup/capps/msf4j_http_monitoring_capp.car b/analytics/das-setup/capps/msf4j_http_monitoring_capp.car
diff --git a/.../msf4j-analytics/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitored.java b/.../msf4j-analytics/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitored.java
@@ -30,4 +30,7 @@
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.TYPE, ElementType.METHOD })
 public @interface HTTPMonitored {
+
+    boolean tracing() default false;
+
 }
diff --git a/...cs/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitoringDataPublisher.java b/...cs/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitoringDataPublisher.java
@@ -155,8 +155,14 @@ static synchronized void destroy() {
     }
 
     static void publishEvent(HTTPMonitoringEvent httpMonitoringEvent) {
-        Object[] meta =
-                new Object[] { httpMonitoringEvent.getTimestamp(), SERVER_HOST_ADDRESS, SERVER_HOSTNAME, MICROSERVICE };
+        Object[] meta = new Object[4];
+        meta[0] = httpMonitoringEvent.getTimestamp();
+        meta[1] = SERVER_HOST_ADDRESS;
+        meta[2] = SERVER_HOSTNAME;
+        meta[3] = MICROSERVICE;
+        Object[] correlation = new Object[2];
+        correlation[0] = httpMonitoringEvent.getActivityId();
+        correlation[1] = httpMonitoringEvent.getParentRequest();
         Object[] payload = new Object[11];
         payload[0] = httpMonitoringEvent.getServiceClass();
         payload[1] = httpMonitoringEvent.getServiceName();
@@ -169,7 +175,8 @@ static void publishEvent(HTTPMonitoringEvent httpMonitoringEvent) {
         payload[8] = httpMonitoringEvent.getReferrer();
         payload[9] = httpMonitoringEvent.getResponseHttpStatusCode();
         payload[10] = httpMonitoringEvent.getResponseTime();
-        Event event = new Event(HTTP_MONITORING_STREAM_ID, httpMonitoringEvent.getTimestamp(), meta, null, payload);
+        Event event = new Event(HTTP_MONITORING_STREAM_ID, httpMonitoringEvent.getTimestamp(), 
+                meta, correlation, payload);
         dataPublisher.publish(event);
     }
 

diff --git a/...-analytics/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitoringEvent.java b/...-analytics/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitoringEvent.java
@@ -35,6 +35,8 @@ public class HTTPMonitoringEvent {
     private String referrer;
     private long responseTime;
     private long requestSizeBytes;
+    private String activityId;
+    private String parentRequest;
 
     public long getTimestamp() {
         return timestamp;
@@ -156,4 +158,20 @@ public void setRequestSizeBytes(long requestSizeBytes) {
         this.requestSizeBytes = requestSizeBytes;
     }
 
+    public String getActivityId() {
+        return activityId;
+    }
+
+    public void setActivityId(String activityId) {
+        this.activityId = activityId;
+    }
+
+    public String getParentRequest() {
+        return parentRequest;
+    }
+
+    public void setParentRequest(String parentRequest) {
+        this.parentRequest = parentRequest;
+    }
+
 }
diff --git a/...tics/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitoringInterceptor.java b/...tics/src/main/java/org/wso2/msf4j/analytics/httpmonitoring/HTTPMonitoringInterceptor.java
@@ -28,6 +28,7 @@
 
 import java.lang.reflect.Method;
 import java.util.Map;
+import java.util.UUID;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.TimeUnit;
 import javax.ws.rs.Path;
@@ -62,15 +63,29 @@ public void run() {
         });
         return this;
     }
+
+    /**
+     * Returns the final annotation that is application to the given method. For example,
+     * the {@link HTTPMonitored} annotation can be mentioned in class level, and also in 
+     * the target method, but the method only have tracing enabled. Then we should get the
+     * setting as tracing is disabled for that specific method.
+     */
+    private HTTPMonitored extractFinalAnnotation(Method method) {
+        HTTPMonitored httpMon = method.getAnnotation(HTTPMonitored.class);
+        if (httpMon == null) {
+            httpMon = method.getDeclaringClass().getAnnotation(HTTPMonitored.class);
+        }
+        return httpMon;
+    }
 
     @Override
     public boolean preCall(HttpRequest request, HttpResponder responder, ServiceMethodInfo serviceMethodInfo) {
         Method method = serviceMethodInfo.getMethod();
         Interceptor interceptor = map.get(method);
         if (interceptor == null) {
-            if (method.isAnnotationPresent(HTTPMonitored.class)
-                    || method.getDeclaringClass().isAnnotationPresent(HTTPMonitored.class)) {
-                interceptor = new HTTPInterceptor();
+            HTTPMonitored httpMon = this.extractFinalAnnotation(method);
+            if (httpMon != null) {
+                interceptor = new HTTPInterceptor(httpMon.tracing());
                 map.put(method, interceptor);
             }
         }
@@ -93,14 +108,50 @@ public void postCall(HttpRequest request, HttpResponseStatus status, ServiceMeth
 
     private class HTTPInterceptor implements Interceptor {
 
+        private static final String DEFAULT_TRACE_ID = "DEFAULT";
+
+        private static final String DEFAULT_PARENT_REQUEST = "DEFAULT";
+
         private static final String MONITORING_EVENT = "MONITORING_EVENT";
+
+        private static final String ACTIVITY_ID = "activity-id";
+
+        private static final String PARENT_REQUEST = "parent-request";
 
         private String serviceClass;
         private String serviceName;
         private String serviceMethod;
         private String servicePath;
+
+        private boolean tracing;
 
-        private HTTPInterceptor() {
+        private HTTPInterceptor(boolean tracing) {
+            this.tracing = tracing;
+        }
+
+        public boolean isTracing() {
+            return tracing;
+        }
+
+        private String generateTraceId() {
+            return UUID.randomUUID().toString();
+        }
+
+        private void handleTracing(HttpRequest request, HTTPMonitoringEvent httpMonitoringEvent) {
+            String traceId, parentRequest;
+            if (this.isTracing()) {
+                HttpHeaders headers = request.headers();
+                traceId = headers.get(ACTIVITY_ID);
+                if (traceId == null) {
+                    traceId = this.generateTraceId();
+                }
+                parentRequest = headers.get(PARENT_REQUEST);
+            } else {
+                traceId = DEFAULT_TRACE_ID;
+                parentRequest = DEFAULT_PARENT_REQUEST;
+            }
+            httpMonitoringEvent.setActivityId(traceId);
+            httpMonitoringEvent.setParentRequest(parentRequest);
         }
 
         @Override
@@ -135,6 +186,8 @@ public boolean preCall(HttpRequest request, HttpResponder responder, ServiceMeth
             }
             httpMonitoringEvent.setReferrer(httpHeaders.get(HttpHeaders.Names.REFERER));
 
+            this.handleTracing(request, httpMonitoringEvent);
+
             serviceMethodInfo.setAttribute(MONITORING_EVENT, httpMonitoringEvent);
 
             return true;

diff --git a/...j_http_monitoring_capp/http_event_store_1.0.0/org_wso2_msf4j_analytics_httpmonitoring.xml b/...j_http_monitoring_capp/http_event_store_1.0.0/org_wso2_msf4j_analytics_httpmonitoring.xml
@@ -44,6 +44,23 @@
             <EnableScoreParam>false</EnableScoreParam>
             <Type>STRING</Type>
         </ColumnDefinition>
+
+        <ColumnDefinition>
+            <Name>correlation_activity_id</Name>
+            <EnableIndexing>true</EnableIndexing>
+            <IsPrimaryKey>false</IsPrimaryKey>
+            <EnableScoreParam>false</EnableScoreParam>
+            <Type>FACET</Type>
+        </ColumnDefinition>
+
+        <ColumnDefinition>
+            <Name>correlation_parent_request</Name>
+            <EnableIndexing>true</EnableIndexing>
+            <IsPrimaryKey>false</IsPrimaryKey>
+            <EnableScoreParam>false</EnableScoreParam>
+            <Type>STRING</Type>
+        </ColumnDefinition>
+
         <ColumnDefinition>
             <Name>service_class</Name>
             <EnableIndexing>true</EnableIndexing>

diff --git a/...onitoring_capp/http_event_stream_1.0.0/org.wso2.msf4j.analytics.httpmonitoring_1.0.0.json b/...onitoring_capp/http_event_stream_1.0.0/org.wso2.msf4j.analytics.httpmonitoring_1.0.0.json
@@ -21,6 +21,16 @@
       "type": "STRING"
     }
   ],
+  "correlationData": [
+    {
+      "name": "activity_id",
+      "type": "STRING"
+    },
+    {
+      "name": "parent_request",
+      "type": "STRING"
+    }
+  ],
   "payloadData": [
     {
       "name": "service_class",

diff --git a/...pmon/metrics-httpmon-fatjar/src/main/java/org/wso2/msf4j/example/service/DemoService.java b/...pmon/metrics-httpmon-fatjar/src/main/java/org/wso2/msf4j/example/service/DemoService.java
@@ -30,7 +30,7 @@
  * Demonstrating the use of Metrics and HTTP Monitoring Annotations.
  */
 @Path("/demo")
-@HTTPMonitored
+@HTTPMonitored (tracing = true)
 public class DemoService {
 
     private final Random random = new Random();

diff --git a/...n/metrics-httpmon-fatjar/src/main/java/org/wso2/msf4j/example/service/StudentService.java b/...n/metrics-httpmon-fatjar/src/main/java/org/wso2/msf4j/example/service/StudentService.java
@@ -52,15 +52,15 @@ public StudentService() {
     @Path("/{nic}")
     @Produces("application/json")
     @Timed
-    @HTTPMonitored
+    @HTTPMonitored (tracing = true)
     public Student getStudent(@PathParam("nic") String nic) {
         return students.get(nic);
     }
 
     @POST
     @Consumes("application/json")
     @Metered
-    @HTTPMonitored
+    @HTTPMonitored (tracing = true)
     public void addStudent(Student student) {
         students.put(student.getNic(), student);
     }