From 928b6cc1e5d48d8eccc0081d407e4655b3abdc2b Mon Sep 17 00:00:00 2001
From: Bogdan Drutu <bogdandrutu@gmail.com>
Date: Wed, 23 Jan 2019 14:33:04 -0800
Subject: [PATCH] Update deps and OC instrumentation.

---
 src/adservice/build.gradle                    |  10 +-
 .../src/main/java/hipstershop/AdService.java  |  70 +++++-------
 .../java/hipstershop/AdServiceClient.java     | 106 +++++++++---------
 3 files changed, 87 insertions(+), 99 deletions(-)

diff --git a/src/adservice/build.gradle b/src/adservice/build.gradle
index 7450826..5266919 100644
--- a/src/adservice/build.gradle
+++ b/src/adservice/build.gradle
@@ -23,10 +23,10 @@ repositories {
 }
 
 group = "adservice"
-version = "0.1.0-SNAPSHOT" // CURRENT_OPENCENSUS_VERSION
+version = "0.1.0-SNAPSHOT"
 
-def opencensusVersion = "0.17.0" // LATEST_OPENCENSUS_RELEASE_VERSION
-def grpcVersion = "1.15.0" // CURRENT_GRPC_VERSION
+def opencensusVersion = "0.18.0"
+def grpcVersion = "1.17.0"
 def jacksonVersion = "2.9.6"
 
 tasks.withType(JavaCompile) {
@@ -43,7 +43,9 @@ dependencies {
     if (speed) {
         compile fileTree(dir: offlineCompile, include: '*.jar')
     } else {
-        compile "com.google.api.grpc:proto-google-common-protos:1.11.0",
+        compile "com.google.api.grpc:proto-google-common-protos:1.12.0",
+                "io.opencensus:opencensus-api:${opencensusVersion}",
+                "io.opencensus:opencensus-contrib-grpc-util:${opencensusVersion}",
                 "io.opencensus:opencensus-exporter-trace-jaeger:${opencensusVersion}",
                 "io.opencensus:opencensus-exporter-stats-stackdriver:${opencensusVersion}",
                 "io.opencensus:opencensus-exporter-trace-stackdriver:${opencensusVersion}",
diff --git a/src/adservice/src/main/java/hipstershop/AdService.java b/src/adservice/src/main/java/hipstershop/AdService.java
index 7320764..941ab39 100644
--- a/src/adservice/src/main/java/hipstershop/AdService.java
+++ b/src/adservice/src/main/java/hipstershop/AdService.java
@@ -29,20 +29,16 @@ import io.grpc.health.v1.HealthCheckResponse.ServingStatus;
 import io.grpc.stub.StreamObserver;
 import io.grpc.services.*;
 import io.opencensus.common.Duration;
-import io.opencensus.common.Scope;
 import io.opencensus.contrib.grpc.metrics.RpcViews;
 import io.opencensus.exporter.trace.jaeger.JaegerTraceExporter;
-import io.opencensus.exporter.trace.logging.LoggingTraceExporter;
 import io.opencensus.exporter.stats.stackdriver.StackdriverStatsConfiguration;
 import io.opencensus.exporter.stats.stackdriver.StackdriverStatsExporter;
 import io.opencensus.exporter.trace.stackdriver.StackdriverTraceConfiguration;
 import io.opencensus.exporter.trace.stackdriver.StackdriverTraceExporter;
 import io.opencensus.trace.AttributeValue;
 import io.opencensus.trace.Span;
-import io.opencensus.trace.SpanBuilder;
 import io.opencensus.trace.Tracer;
 import io.opencensus.trace.Tracing;
-import io.opencensus.trace.samplers.Samplers;
 import java.io.IOException;
 import java.util.Collection;
 import java.util.ArrayList;
@@ -53,16 +49,17 @@ import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.LogManager;
 
-public class AdService {
-  private static final Logger logger = LogManager.getLogger(AdService.class);
+public final class AdService {
 
+  private static final Logger logger = LogManager.getLogger(AdService.class);
   private static final Tracer tracer = Tracing.getTracer();
 
-  private int MAX_ADS_TO_SERVE = 2;
+  private static int MAX_ADS_TO_SERVE = 2;
   private Server server;
   private HealthStatusManager healthMgr;
 
-  static final AdService service = new AdService();
+  private static final AdService service = new AdService();
+
   private void start() throws IOException {
     int port = Integer.parseInt(System.getenv("PORT"));
     healthMgr = new HealthStatusManager();
@@ -91,26 +88,20 @@ public class AdService {
     }
   }
 
-  static class AdServiceImpl extends hipstershop.AdServiceGrpc.AdServiceImplBase {
+  private static class AdServiceImpl extends hipstershop.AdServiceGrpc.AdServiceImplBase {
 
     /**
      * Retrieves ads based on context provided in the request {@code AdRequest}.
      *
      * @param req the request containing context.
-     * @param responseObserver the stream observer which gets notified with the value of
-     *     {@code AdResponse}
+     * @param responseObserver the stream observer which gets notified with the value of {@code
+     * AdResponse}
      */
     @Override
     public void getAds(AdRequest req, StreamObserver<AdResponse> responseObserver) {
       AdService service = AdService.getInstance();
-      Span parentSpan = tracer.getCurrentSpan();
-      SpanBuilder spanBuilder =
-          tracer
-              .spanBuilderWithExplicitParent("Retrieve Ads", parentSpan)
-              .setRecordEvents(true)
-              .setSampler(Samplers.alwaysSample());
-      try (Scope scope = spanBuilder.startScopedSpan()) {
-        Span span = tracer.getCurrentSpan();
+      Span span = tracer.getCurrentSpan();
+      try {
         span.putAttribute("method", AttributeValue.stringAttributeValue("getAds"));
         List<Ad> allAds = new ArrayList<>();
         logger.info("received ad request (context_words=" + req.getContextKeysList() + ")");
@@ -140,40 +131,42 @@ public class AdService {
         responseObserver.onCompleted();
       } catch (StatusRuntimeException e) {
         logger.log(Level.WARN, "GetAds Failed", e.getStatus());
-        return;
+        responseObserver.onError(e);
       }
     }
   }
 
-  static final ImmutableListMultimap<String, Ad> adsMap = createAdsMap();
+  private static final ImmutableListMultimap<String, Ad> adsMap = createAdsMap();
 
-  Collection<Ad> getAdsByCategory(String category) {
+  private Collection<Ad> getAdsByCategory(String category) {
     return adsMap.get(category);
   }
 
   private static final Random random = new Random();
 
-  public List<Ad> getRandomAds() {
+  private List<Ad> getRandomAds() {
     List<Ad> ads = new ArrayList<>(MAX_ADS_TO_SERVE);
     Collection<Ad> allAds = adsMap.values();
-    for (int i=0; i<MAX_ADS_TO_SERVE; i++) {
+    for (int i = 0; i < MAX_ADS_TO_SERVE; i++) {
       ads.add(Iterables.get(allAds, random.nextInt(allAds.size())));
     }
     return ads;
   }
 
-  public static AdService getInstance() {
+  private static AdService getInstance() {
     return service;
   }
 
-  /** Await termination on the main thread since the grpc library uses daemon threads. */
+  /**
+   * Await termination on the main thread since the grpc library uses daemon threads.
+   */
   private void blockUntilShutdown() throws InterruptedException {
     if (server != null) {
       server.awaitTermination();
     }
   }
 
-  static ImmutableListMultimap<String, Ad> createAdsMap() {
+  private static ImmutableListMultimap<String, Ad> createAdsMap() {
     Ad camera = Ad.newBuilder().setRedirectUrl("/product/2ZYFJ3GM2N")
         .setText("Film camera for sale. 50% off.").build();
     Ad lens = Ad.newBuilder().setRedirectUrl("/product/66VCHSJNUP")
@@ -197,7 +190,7 @@ public class AdService {
         .build();
   }
 
-  public static void initStackdriver() {
+  private static void initStackdriver() {
     logger.info("Initialize StackDriver");
 
     long sleepTime = 10; /* seconds */
@@ -205,7 +198,7 @@ public class AdService {
     boolean statsExporterRegistered = false;
     boolean traceExporterRegistered = false;
 
-    for (int i=0; i<maxAttempts; i++) {
+    for (int i = 0; i < maxAttempts; i++) {
       try {
         if (!traceExporterRegistered) {
           StackdriverTraceExporter.createAndRegister(
@@ -220,7 +213,7 @@ public class AdService {
           statsExporterRegistered = true;
         }
       } catch (Exception e) {
-        if (i==(maxAttempts-1)) {
+        if (i == (maxAttempts - 1)) {
           logger.log(Level.WARN, "Failed to register Stackdriver Exporter." +
               " Tracing and Stats data will not reported to Stackdriver. Error message: " + e
               .toString());
@@ -237,7 +230,7 @@ public class AdService {
     logger.info("StackDriver initialization complete.");
   }
 
-  static void initJaeger() {
+  private static void initJaeger() {
     String jaegerAddr = System.getenv("JAEGER_SERVICE_ADDR");
     if (jaegerAddr != null && !jaegerAddr.isEmpty()) {
       String jaegerUrl = String.format("http://%s/api/traces", jaegerAddr);
@@ -249,18 +242,15 @@ public class AdService {
     }
   }
 
-  /** Main launches the server from the command line. */
+  /**
+   * Main launches the server from the command line.
+   */
   public static void main(String[] args) throws IOException, InterruptedException {
-    // Add final keyword to pass checkStyle.
-
     // Registers all RPC views.
-    RpcViews.registerAllViews();
+    RpcViews.registerAllGrpcViews();
 
-    // Registers logging trace exporter.
-    LoggingTraceExporter.register();
-
-    new Thread( new Runnable() {
-      public void run(){
+    new Thread(new Runnable() {
+      public void run() {
         initStackdriver();
       }
     }).start();
diff --git a/src/adservice/src/main/java/hipstershop/AdServiceClient.java b/src/adservice/src/main/java/hipstershop/AdServiceClient.java
index a269a4c..7d3924e 100644
--- a/src/adservice/src/main/java/hipstershop/AdServiceClient.java
+++ b/src/adservice/src/main/java/hipstershop/AdServiceClient.java
@@ -26,34 +26,36 @@ import io.grpc.StatusRuntimeException;
 import io.opencensus.common.Duration;
 import io.opencensus.common.Scope;
 import io.opencensus.contrib.grpc.metrics.RpcViews;
-import io.opencensus.exporter.trace.logging.LoggingTraceExporter;
+import io.opencensus.contrib.grpc.util.StatusConverter;
 import io.opencensus.exporter.stats.stackdriver.StackdriverStatsConfiguration;
 import io.opencensus.exporter.stats.stackdriver.StackdriverStatsExporter;
 import io.opencensus.exporter.trace.stackdriver.StackdriverTraceConfiguration;
 import io.opencensus.exporter.trace.stackdriver.StackdriverTraceExporter;
-import io.opencensus.trace.SpanBuilder;
-import io.opencensus.trace.Status.CanonicalCode;
+import io.opencensus.trace.Span;
 import io.opencensus.trace.Tracer;
 import io.opencensus.trace.Tracing;
 import io.opencensus.trace.samplers.Samplers;
-import java.io.IOException;
 import java.util.concurrent.TimeUnit;
 import javax.annotation.Nullable;
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.Logger;
 import org.apache.logging.log4j.LogManager;
 
-/** A simple client that requests ads from the Ads Service. */
+/**
+ * A simple client that requests ads from the Ads Service.
+ */
 public class AdServiceClient {
-  private static final Logger logger = LogManager.getLogger(AdServiceClient.class);
 
+  private static final Logger logger = LogManager.getLogger(AdServiceClient.class);
   private static final Tracer tracer = Tracing.getTracer();
 
   private final ManagedChannel channel;
   private final hipstershop.AdServiceGrpc.AdServiceBlockingStub blockingStub;
 
-  /** Construct client connecting to Ad Service at {@code host:port}. */
-  public AdServiceClient(String host, int port) {
+  /**
+   * Construct client connecting to Ad Service at {@code host:port}.
+   */
+  private AdServiceClient(String host, int port) {
     this(
         ManagedChannelBuilder.forAddress(host, port)
             // Channels are secure by default (via SSL/TLS). For the example we disable TLS to avoid
@@ -62,44 +64,48 @@ public class AdServiceClient {
             .build());
   }
 
-  /** Construct client for accessing RouteGuide server using the existing channel. */
-  AdServiceClient(ManagedChannel channel) {
+  /**
+   * Construct client for accessing RouteGuide server using the existing channel.
+   */
+  private AdServiceClient(ManagedChannel channel) {
     this.channel = channel;
     blockingStub = hipstershop.AdServiceGrpc.newBlockingStub(channel);
   }
 
-  public void shutdown() throws InterruptedException {
+  private void shutdown() throws InterruptedException {
     channel.shutdown().awaitTermination(5, TimeUnit.SECONDS);
   }
 
-  /** Get Ads from Server. */
+  /**
+   * Get Ads from Server.
+   */
   public void getAds(String contextKey) {
     logger.info("Get Ads with context " + contextKey + " ...");
     AdRequest request = AdRequest.newBuilder().addContextKeys(contextKey).build();
     AdResponse response;
 
-    SpanBuilder spanBuilder =
-        tracer.spanBuilder("AdsClient").setRecordEvents(true).setSampler(Samplers.alwaysSample());
-    try (Scope scope = spanBuilder.startScopedSpan()) {
+    Span span =
+        tracer.spanBuilder("AdsClient").setRecordEvents(true).setSampler(Samplers.alwaysSample())
+            .startSpan();
+    try (Scope scope = tracer.withSpan(span)) {
       tracer.getCurrentSpan().addAnnotation("Getting Ads");
       response = blockingStub.getAds(request);
       tracer.getCurrentSpan().addAnnotation("Received response from Ads Service.");
     } catch (StatusRuntimeException e) {
       tracer
           .getCurrentSpan()
-          .setStatus(
-              CanonicalCode.valueOf(e.getStatus().getCode().name())
-                  .toStatus()
-                  .withDescription(e.getMessage()));
-      logger.log(Level.WARN, "RPC failed: {0}", e.getStatus());
+          .setStatus(StatusConverter.fromGrpcStatus(e.getStatus()));
+      logger.log(Level.WARN, "RPC failed: " + e.getStatus());
       return;
+    } finally {
+      span.end();
     }
-    for(Ad ads: response.getAdsList()) {
+    for (Ad ads : response.getAdsList()) {
       logger.info("Ads: " + ads.getText());
     }
   }
 
-  static int getPortOrDefaultFromArgs(String[] args, int index, int defaultPort) {
+  private static int getPortOrDefaultFromArgs(String[] args, int index, int defaultPort) {
     int portNumber = defaultPort;
     if (index < args.length) {
       try {
@@ -113,7 +119,7 @@ public class AdServiceClient {
   }
 
 
-  static String getStringOrDefaultFromArgs(
+  private static String getStringOrDefaultFromArgs(
       String[] args, int index, @Nullable String defaultString) {
     String s = defaultString;
     if (index < args.length) {
@@ -126,47 +132,37 @@ public class AdServiceClient {
    * Ads Service Client main. If provided, the first element of {@code args} is the context key to
    * get the ads from the Ads Service
    */
-  public static void main(String[] args) throws IOException, InterruptedException {
+  public static void main(String[] args) throws InterruptedException {
     // Add final keyword to pass checkStyle.
     final String contextKeys = getStringOrDefaultFromArgs(args, 0, "camera");
     final String host = getStringOrDefaultFromArgs(args, 1, "localhost");
     final int serverPort = getPortOrDefaultFromArgs(args, 2, 9555);
-    final String cloudProjectId = getStringOrDefaultFromArgs(args, 3, null);
-    //final int zPagePort = getPortOrDefaultFromArgs(args, 4, 3001);
 
     // Registers all RPC views.
-    RpcViews.registerAllViews();
-
-
-    // Registers logging trace exporter.
-    LoggingTraceExporter.register();
+    RpcViews.registerAllGrpcViews();
 
     // Registers Stackdriver exporters.
-    if (cloudProjectId != null) {
-      long sleepTime = 10; /* seconds */
-      int maxAttempts = 3;
+    long sleepTime = 10; /* seconds */
+    int maxAttempts = 3;
 
-      for (int i=0; i<maxAttempts; i++) {
-        try {
-          StackdriverTraceExporter.createAndRegister(
-              StackdriverTraceConfiguration.builder().setProjectId(cloudProjectId).build());
-          StackdriverStatsExporter.createAndRegister(
-              StackdriverStatsConfiguration.builder()
-                  .setProjectId(cloudProjectId)
-                  .setExportInterval(Duration.create(15, 0))
-                  .build());
-        } catch (Exception e) {
-          if (i==(maxAttempts-1)) {
-            logger.log(Level.WARN, "Failed to register Stackdriver Exporter." +
-                " Tracing and Stats data will not reported to Stackdriver. Error message: " + e
-                .toString());
-          } else {
-            logger.info("Attempt to register Stackdriver Exporter in " + sleepTime + " seconds");
-            try {
-              Thread.sleep(TimeUnit.SECONDS.toMillis(sleepTime));
-            } catch (Exception se) {
-              logger.log(Level.WARN, "Exception while sleeping" + e.toString());
-            }
+    for (int i = 0; i < maxAttempts; i++) {
+      try {
+        StackdriverTraceExporter.createAndRegister(StackdriverTraceConfiguration.builder().build());
+        StackdriverStatsExporter.createAndRegister(
+            StackdriverStatsConfiguration.builder()
+                .setExportInterval(Duration.create(15, 0))
+                .build());
+      } catch (Exception e) {
+        if (i == (maxAttempts - 1)) {
+          logger.log(Level.WARN, "Failed to register Stackdriver Exporter." +
+              " Tracing and Stats data will not reported to Stackdriver. Error message: " + e
+              .toString());
+        } else {
+          logger.info("Attempt to register Stackdriver Exporter in " + sleepTime + " seconds");
+          try {
+            Thread.sleep(TimeUnit.SECONDS.toMillis(sleepTime));
+          } catch (Exception se) {
+            logger.log(Level.WARN, "Exception while sleeping" + e.toString());
           }
         }
       }