Add jaeger and logs in the CustomEndpointController (#2)

Author: edaena

api/pom.xml

@@ -22,6 +22,7 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
 		<java.version>1.8</java.version>
+	    <jaeger.version>0.32.0</jaeger.version>
 	</properties>
 
 	<dependencies>
@@ -77,6 +78,12 @@
 			<version>2.0.0</version>
 		</dependency>
 
+		<dependency>
+            <groupId>io.jaegertracing</groupId>
+            <artifactId>jaeger-client</artifactId>
+            <version>${jaeger.version}</version>
+		</dependency>
+
 	</dependencies>
 
 	<repositories>

api/src/main/java/com/microsoft/cse/reference/spring/dal/JaegerTracerHelper.java

@@ -0,0 +1,25 @@
+package com.microsoft.cse.reference.spring.dal;
+
+import io.jaegertracing.Configuration;
+import io.jaegertracing.Configuration.ReporterConfiguration;
+import io.jaegertracing.Configuration.SamplerConfiguration;
+import io.jaegertracing.internal.JaegerTracer;
+
+
+/**
+ * Helper functions for tracing and logs
+ */
+public class JaegerTracerHelper {
+
+    /**
+     * Initializes a Jaeger tracer
+     * @param service the name of the service
+     * @return the Jaeger tracer
+     */
+    public static JaegerTracer initTracer(String service) {
+        SamplerConfiguration samplerConfig = SamplerConfiguration.fromEnv().withType("const").withParam(1);
+        ReporterConfiguration reporterConfig = ReporterConfiguration.fromEnv().withLogSpans(true);
+        Configuration config = new Configuration(service).withSampler(samplerConfig).withReporter(reporterConfig);
+        return config.getTracer();
+    }
+}

api/src/main/java/com/microsoft/cse/reference/spring/dal/controllers/CustomEndpointController.java

@@ -1,5 +1,6 @@
 package com.microsoft.cse.reference.spring.dal.controllers;
 
+import com.microsoft.cse.reference.spring.dal.JaegerTracerHelper;
 import com.microsoft.cse.reference.spring.dal.converters.IntegerToBoolean;
 import com.microsoft.cse.reference.spring.dal.converters.EmptyStringToNull;
 import com.microsoft.cse.reference.spring.dal.models.PrincipalWithName;
@@ -15,6 +16,11 @@
 import static java.util.Arrays.asList;
 import static org.springframework.data.mongodb.core.aggregation.Aggregation.*;
 
+import io.opentracing.Span;
+import io.opentracing.Tracer;
+
+import com.google.common.collect.ImmutableMap;
+
 /**
  *
  * Create a custom controller so that when a user hits a URL that's not formatted like the search endpoint
@@ -25,9 +31,11 @@ public class CustomEndpointController {
     private IntegerToBoolean integerToBoolean = new IntegerToBoolean();
     private EmptyStringToNull emptyStringToNull = new EmptyStringToNull();
     private MongoTemplate mongoTemplate;
+    private final Tracer tracer;
 
     public CustomEndpointController(MongoTemplate mongoTemplate) {
         this.mongoTemplate = mongoTemplate;
+        this.tracer = JaegerTracerHelper.initTracer("custom-endpoint-controller");
     }
 
     /**
@@ -57,6 +65,9 @@ public CustomEndpointController(MongoTemplate mongoTemplate) {
      */
     @RequestMapping(method = RequestMethod.GET, value = "/people/{nconst}/titles")
     public List<Title> getAllTitles(@PathVariable String nconst) {
+        Span span = tracer.buildSpan("get-person-titles").start();
+        span.log(ImmutableMap.of("event", "query-person-titles", "value", nconst));
+
         MatchOperation filterByNconst = match(Criteria.where("nconst").is(nconst));
 
         LookupOperation titleLookup = LookupOperation.newLookup()
@@ -73,6 +84,8 @@ public List<Title> getAllTitles(@PathVariable String nconst) {
 
         AggregationResults<Document> aggregationResults = mongoTemplate.aggregate(aggregation, "principals_mapping", Document.class);
 
+        span.finish();
+
         return documentToTitleList(aggregationResults);
     }
 
@@ -86,6 +99,9 @@ public List<Title> getAllTitles(@PathVariable String nconst) {
      */
     @RequestMapping(method = RequestMethod.GET, value = "/titles/{tconst}/people")
     public List<PrincipalWithName> getAllPeople(@PathVariable String tconst) {
+        Span span = tracer.buildSpan("get-people-from-title").start();
+        span.log(ImmutableMap.of("event", "query-people-from-title", "value", tconst));
+
         MatchOperation filterByNconst = match(Criteria.where("tconst").is(tconst));
         LookupOperation nameLookup = LookupOperation.newLookup()
                 .from("names")
@@ -106,6 +122,8 @@ public List<PrincipalWithName> getAllPeople(@PathVariable String tconst) {
             p.person.remove("_id");
         }
 
+        span.finish();
+
         return mappedResults;
     }