Adds option to disable Stackdriver Export (#293)

.gitignore

@@ -8,4 +8,6 @@ pkg/
 .vs/
 .idea
 .skaffold-*.yaml
-.kubernetes-manifests-*/
+.kubernetes-manifests-*/
+.project
+.eclipse.buildship.core.prefs

kubernetes-manifests/adservice.yaml

@@ -34,6 +34,10 @@ spec:
         env:
         - name: PORT
           value: "9555"
+        # - name: DISABLE_STATS
+        #   value: "1"
+        # - name: DISABLE_TRACING
+        #   value: "1"
         #- name: JAEGER_SERVICE_ADDR
         #  value: "jaeger-collector:14268"
         resources:

kubernetes-manifests/checkoutservice.yaml

@@ -51,6 +51,12 @@ spec:
             value: "currencyservice:7000"
           - name: CART_SERVICE_ADDR
             value: "cartservice:7070"
+          # - name: DISABLE_STATS
+          #   value: "1"
+          # - name: DISABLE_TRACING
+          #   value: "1"
+          # - name: DISABLE_PROFILER
+          #   value: "1"
           # - name: JAEGER_SERVICE_ADDR
           #   value: "jaeger-collector:14268"
           resources:

kubernetes-manifests/currencyservice.yaml

@@ -35,6 +35,12 @@ spec:
         env:
         - name: PORT
           value: "7000"
+        # - name: DISABLE_TRACING
+        #   value: "1"
+        # - name: DISABLE_PROFILER
+        #   value: "1"
+        # - name: DISABLE_DEBUGGER
+        #   value: "1"
         readinessProbe:
           exec:
             command: ["/bin/grpc_health_probe", "-addr=:7000"]

kubernetes-manifests/emailservice.yaml

@@ -34,8 +34,10 @@ spec:
         env:
         - name: PORT
           value: "8080"
-        - name: ENABLE_PROFILER
-          value: "0"
+        # - name: DISABLE_TRACING
+        #   value: "1"
+        - name: DISABLE_PROFILER
+          value: "1"
         readinessProbe:
           periodSeconds: 5
           exec:

kubernetes-manifests/frontend.yaml

@@ -65,6 +65,10 @@ spec:
             value: "checkoutservice:5050"
           - name: AD_SERVICE_ADDR
             value: "adservice:9555"
+          # - name: DISABLE_TRACING
+          #   value: "1"
+          # - name: DISABLE_PROFILER
+          #   value: "1"
           # - name: JAEGER_SERVICE_ADDR
           #   value: "jaeger-collector:14268"
           resources:

kubernetes-manifests/productcatalogservice.yaml

@@ -34,15 +34,20 @@ spec:
         env:
         - name: PORT
           value: "3550"
+        # - name: DISABLE_STATS
+        #   value: "1"
+        # - name: DISABLE_TRACING
+        #   value: "1"
+        # - name: DISABLE_PROFILER
+        #   value: "1"
+        # - name: JAEGER_SERVICE_ADDR
+        #   value: "jaeger-collector:14268"
         readinessProbe:
           exec:
             command: ["/bin/grpc_health_probe", "-addr=:3550"]
         livenessProbe:
           exec:
             command: ["/bin/grpc_health_probe", "-addr=:3550"]
-#        env:
-#          - name: JAEGER_SERVICE_ADDR
-#            value: "jaeger-collector:14268"
         resources:
           requests:
             cpu: 100m

kubernetes-manifests/recommendationservice.yaml

@@ -44,8 +44,12 @@ spec:
           value: "8080"
         - name: PRODUCT_CATALOG_SERVICE_ADDR
           value: "productcatalogservice:3550"
-        - name: ENABLE_PROFILER
-          value: "0"
+        # - name: DISABLE_TRACING
+        #   value: "1"
+        # - name: DISABLE_PROFILER
+        #   value: "1"
+        # - name: DISABLE_DEBUGGER
+        #   value: "1"
         resources:
           requests:
             cpu: 100m

kubernetes-manifests/shippingservice.yaml

@@ -33,6 +33,14 @@ spec:
         env:
         - name: PORT
           value: "50051"
+        # - name: DISABLE_STATS
+        #   value: "1"
+        # - name: DISABLE_TRACING
+        #   value: "1"
+        # - name: DISABLE_PROFILER
+        #   value: "1"
+        # - name: JAEGER_SERVICE_ADDR
+        #   value: "jaeger-collector:14268"
         readinessProbe:
           periodSeconds: 5
           exec:
@@ -40,9 +48,6 @@ spec:
         livenessProbe:
           exec:
             command: ["/bin/grpc_health_probe", "-addr=:50051"]
-#        env:
-#          - name: JAEGER_SERVICE_ADDR
-#            value: "jaeger-collector:14268"
         resources:
           requests:
             cpu: 100m

src/adservice/src/main/java/hipstershop/AdService.java

@@ -213,21 +213,18 @@ public final class AdService {
         .build();
   }
 
-  private static void initStackdriver() {
-    logger.info("Initialize Stackdriver");
+  private static void initStats() {
+    if (System.getenv("DISABLE_STATS") != null) {
+      logger.info("Stats disabled.");
+      return;
+    }
+    logger.info("Stats enabled");
 
     long sleepTime = 10; /* seconds */
     int maxAttempts = 5;
     boolean statsExporterRegistered = false;
-    boolean traceExporterRegistered = false;
-
     for (int i = 0; i < maxAttempts; i++) {
       try {
-        if (!traceExporterRegistered) {
-          StackdriverTraceExporter.createAndRegister(
-              StackdriverTraceConfiguration.builder().build());
-          traceExporterRegistered = true;
-        }
         if (!statsExporterRegistered) {
           StackdriverStatsExporter.createAndRegister(
               StackdriverStatsConfiguration.builder()
@@ -240,7 +237,7 @@ public final class AdService {
           logger.log(
               Level.WARN,
               "Failed to register Stackdriver Exporter."
-                  + " Tracing and Stats data will not reported to Stackdriver. Error message: "
+                  + " Stats data will not reported to Stackdriver. Error message: "
                   + e.toString());
         } else {
           logger.info("Attempt to register Stackdriver Exporter in " + sleepTime + " seconds ");
@@ -252,9 +249,50 @@ public final class AdService {
         }
       }
     }
-    logger.info("Stackdriver initialization complete.");
+    logger.info("Stats enabled - Stackdriver Exporter initialized.");
   }
 
+  private static void initTracing() {
+    if (System.getenv("DISABLE_TRACING") != null) {
+      logger.info("Tracing disabled.");
+      return;
+    }
+    logger.info("Tracing enabled");
+
+    long sleepTime = 10; /* seconds */
+    int maxAttempts = 5;
+    boolean traceExporterRegistered = false;
+
+    for (int i = 0; i < maxAttempts; i++) {
+      try {
+        if (!traceExporterRegistered) {
+          StackdriverTraceExporter.createAndRegister(
+              StackdriverTraceConfiguration.builder().build());
+          traceExporterRegistered = true;
+        }
+      } catch (Exception e) {
+        if (i == (maxAttempts - 1)) {
+          logger.log(
+              Level.WARN,
+              "Failed to register Stackdriver Exporter."
+                  + " Tracing 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" + se.toString());
+          }
+        }
+      }
+    }
+    logger.info("Tracing enabled - Stackdriver exporter initialized.");
+  }
+
+
+
+
   private static void initJaeger() {
     String jaegerAddr = System.getenv("JAEGER_SERVICE_ADDR");
     if (jaegerAddr != null && !jaegerAddr.isEmpty()) {
@@ -282,7 +320,8 @@ public final class AdService {
     new Thread(
             new Runnable() {
               public void run() {
-                initStackdriver();
+                initStats();
+                initTracing();
               }
             })
         .start();

src/checkoutservice/main.go

@@ -69,8 +69,19 @@ type checkoutService struct {
 }
 
 func main() {
-	go initTracing()
-	go initProfiling("checkoutservice", "1.0.0")
+	if os.Getenv("DISABLE_TRACING") == "" {
+		log.Info("Tracing enabled.")
+		go initTracing()
+	} else {
+		log.Info("Tracing disabled.")
+	}
+
+	if os.Getenv("DISABLE_PROFILER") == "" {
+		log.Info("Profiling enabled.")
+		go initProfiling("checkoutservice", "1.0.0")
+	} else {
+		log.Info("Profiling disabled.")
+	}
 
 	port := listenPort
 	if os.Getenv("PORT") != "" {
@@ -91,7 +102,15 @@ func main() {
 	if err != nil {
 		log.Fatal(err)
 	}
-	srv := grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
+
+	var srv *grpc.Server
+	if os.Getenv("DISABLE_STATS") == "" {
+		log.Info("Stats enabled.")
+		srv = grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
+	} else {
+		log.Info("Stats disabled.")
+		srv = grpc.NewServer()
+	}
 	pb.RegisterCheckoutServiceServer(srv, svc)
 	healthpb.RegisterHealthServer(srv, svc)
 	log.Infof("starting to listen on tcp: %q", lis.Addr().String())

src/currencyservice/server.js

@@ -14,19 +14,40 @@
  * limitations under the License.
  */
 
-require('@google-cloud/profiler').start({
-  serviceContext: {
-    service: 'currencyservice',
-    version: '1.0.0'
-  }
-});
-require('@google-cloud/trace-agent').start();
-require('@google-cloud/debug-agent').start({
-  serviceContext: {
-    service: 'currencyservice',
-    version: 'VERSION'
-  }
-});
+if(process.env.DISABLE_PROFILER) {
+  console.log("Profiler disabled.")
+}
+else {
+  console.log("Profiler enabled.")
+  require('@google-cloud/profiler').start({
+    serviceContext: {
+      service: 'currencyservice',
+      version: '1.0.0'
+    }
+  });
+}
+
+
+if(process.env.DISABLE_TRACING) {
+  console.log("Tracing disabled.")
+}
+else {
+  console.log("Tracing enabled.")
+  require('@google-cloud/trace-agent').start();
+}
+
+if(process.env.DISABLE_DEBUGGER) {
+  console.log("Debugger disabled.")
+}
+else {
+  console.log("Debugger enabled.")
+  require('@google-cloud/debug-agent').start({
+    serviceContext: {
+      service: 'currencyservice',
+      version: 'VERSION'
+    }
+  });
+}
 
 const path = require('path');
 const grpc = require('grpc');

src/emailservice/email_server.py

@@ -29,20 +29,16 @@ from grpc_health.v1 import health_pb2
 from grpc_health.v1 import health_pb2_grpc
 
 from opencensus.trace.exporters import stackdriver_exporter
+from opencensus.trace.exporters import print_exporter
 from opencensus.trace.ext.grpc import server_interceptor
+from opencensus.common.transports.async_ import AsyncTransport
 from opencensus.trace.samplers import always_on
 
 # import googleclouddebugger
 import googlecloudprofiler
 
-try:
-    sampler = always_on.AlwaysOnSampler()
-    exporter = stackdriver_exporter.StackdriverExporter(
-        project_id=os.environ.get('GCP_PROJECT_ID'),
-        transport=AsyncTransport)
-    tracer_interceptor = server_interceptor.OpenCensusServerInterceptor(sampler, exporter)
-except:
-    tracer_interceptor = server_interceptor.OpenCensusServerInterceptor()
+from logger import getJSONLogger
+logger = getJSONLogger('emailservice-server')
 
 # try:
 #     googleclouddebugger.enable(
@@ -52,9 +48,6 @@ except:
 # except:
 #     pass
 
-from logger import getJSONLogger
-logger = getJSONLogger('emailservice-server')
-
 # Loads confirmation email template from file
 env = Environment(
     loader=FileSystemLoader('templates'),
@@ -171,16 +164,33 @@ def initStackdriverProfiling():
         logger.warning("Could not initialize Stackdriver Profiler after retrying, giving up")
   return
 
+
 if __name__ == '__main__':
   logger.info('starting the email service in dummy mode.')
+
+  # Profiler
   try:
-    enable_profiler = os.environ["ENABLE_PROFILER"]
-    if enable_profiler != "1":
+    if "DISABLE_PROFILER" in os.environ:
       raise KeyError()
     else:
+      logger.info("Profiler enabled.")
       initStackdriverProfiling()
   except KeyError:
-      logger.info("Skipping Stackdriver Profiler Python agent initialization. Set environment variable ENABLE_PROFILER=1 to enable.")
+      logger.info("Profiler disabled.")
 
+  # Tracing
+  try:
+    if "DISABLE_TRACING" in os.environ:
+      raise KeyError()
+    else:
+      logger.info("Tracing enabled.")
+      sampler = always_on.AlwaysOnSampler()
+      exporter = stackdriver_exporter.StackdriverExporter(
+        project_id=os.environ.get('GCP_PROJECT_ID'),
+        transport=AsyncTransport)
+      tracer_interceptor = server_interceptor.OpenCensusServerInterceptor(sampler, exporter)
+  except KeyError:
+      logger.info("Tracing disabled.")
+      tracer_interceptor = server_interceptor.OpenCensusServerInterceptor()
 
   start(dummy_mode = True)

src/frontend/main.go

@@ -94,8 +94,19 @@ func main() {
 	}
 	log.Out = os.Stdout
 
-	go initProfiling(log, "frontend", "1.0.0")
-	go initTracing(log)
+	if os.Getenv("DISABLE_TRACING") == "" {
+		log.Info("Tracing enabled.")
+		go initTracing(log)
+	} else {
+		log.Info("Tracing disabled.")
+	}
+
+	if os.Getenv("DISABLE_PROFILER") == "" {
+		log.Info("Profiling enabled.")
+		go initProfiling(log, "frontend", "1.0.0")
+	} else {
+		log.Info("Profiling disabled.")
+	}
 
 	srvPort := port
 	if os.Getenv("PORT") != "" {

src/productcatalogservice/server.go

@@ -74,8 +74,20 @@ func init() {
 }
 
 func main() {
-	go initTracing()
-	go initProfiling("productcatalogservice", "1.0.0")
+	if os.Getenv("DISABLE_TRACING") == "" {
+		log.Info("Tracing enabled.")
+		go initTracing()
+	} else {
+		log.Info("Tracing disabled.")
+	}
+
+	if os.Getenv("DISABLE_PROFILER") == "" {
+		log.Info("Profiling enabled.")
+		go initProfiling("productcatalogservice", "1.0.0")
+	} else {
+		log.Info("Profiling disabled.")
+	}
+
 	flag.Parse()
 
 	// set injected latency
@@ -119,8 +131,17 @@ func run(port string) string {
 	if err != nil {
 		log.Fatal(err)
 	}
-	srv := grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
+	var srv *grpc.Server
+	if os.Getenv("DISABLE_STATS") == "" {
+		log.Info("Stats enabled.")
+		srv = grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
+	} else {
+		log.Info("Stats disabled.")
+		srv = grpc.NewServer()
+	}
+
 	svc := &productCatalog{}
+
 	pb.RegisterProductCatalogServiceServer(srv, svc)
 	healthpb.RegisterHealthServer(srv, svc)
 	go srv.Serve(l)

src/recommendationservice/recommendation_server.py

@@ -26,6 +26,7 @@ import grpc
 from opencensus.trace.exporters import print_exporter
 from opencensus.trace.exporters import stackdriver_exporter
 from opencensus.trace.ext.grpc import server_interceptor
+from opencensus.common.transports.async_ import AsyncTransport
 from opencensus.trace.samplers import always_on
 
 import demo_pb2
@@ -89,32 +90,45 @@ if __name__ == "__main__":
     logger.info("initializing recommendationservice")
 
     try:
-      enable_profiler = os.environ["ENABLE_PROFILER"]
-      if enable_profiler != "1":
+      if "DISABLE_PROFILER" in os.environ:
         raise KeyError()
       else:
+        logger.info("Profiler enabled.")
         initStackdriverProfiling()
     except KeyError:
-      logger.info("Skipping Stackdriver Profiler Python agent initialization. Set environment variable ENABLE_PROFILER=1 to enable.")
+        logger.info("Profiler disabled.")
 
     try:
+      if "DISABLE_TRACING" in os.environ:
+        raise KeyError()
+      else:
+        logger.info("Tracing enabled.")
         sampler = always_on.AlwaysOnSampler()
         exporter = stackdriver_exporter.StackdriverExporter(
-            project_id=os.environ.get('GCP_PROJECT_ID'),
-            transport=AsyncTransport)
+          project_id=os.environ.get('GCP_PROJECT_ID'),
+          transport=AsyncTransport)
         tracer_interceptor = server_interceptor.OpenCensusServerInterceptor(sampler, exporter)
-    except:
+    except KeyError:
+        logger.info("Tracing disabled.")
         tracer_interceptor = server_interceptor.OpenCensusServerInterceptor()
 
+
     try:
-        googleclouddebugger.enable(
-            module='recommendationserver',
-            version='1.0.0'
-        )
-    except Exception, err:
-        logger.error("could not enable debugger")
-        logger.error(traceback.print_exc())
-        pass
+      if "DISABLE_DEBUGGER" in os.environ:
+        raise KeyError()
+      else:
+        logger.info("Debugger enabled.")
+        try:
+          googleclouddebugger.enable(
+              module='recommendationserver',
+              version='1.0.0'
+          )
+        except Exception, err:
+            logger.error("Could not enable debugger")
+            logger.error(traceback.print_exc())
+            pass
+    except KeyError:
+        logger.info("Debugger disabled.")
 
     port = os.environ.get('PORT', "8080")
     catalog_addr = os.environ.get('PRODUCT_CATALOG_SERVICE_ADDR', '')

src/shippingservice/main.go

@@ -58,8 +58,19 @@ func init() {
 }
 
 func main() {
-	go initTracing()
-	go initProfiling("shippingservice", "1.0.0")
+	if os.Getenv("DISABLE_TRACING") == "" {
+		log.Info("Tracing enabled.")
+		go initTracing()
+	} else {
+		log.Info("Tracing disabled.")
+	}
+
+	if os.Getenv("DISABLE_PROFILER") == "" {
+		log.Info("Profiling enabled.")
+		go initProfiling("shippingservice", "1.0.0")
+	} else {
+		log.Info("Profiling disabled.")
+	}
 
 	port := defaultPort
 	if value, ok := os.LookupEnv("PORT"); ok {
@@ -71,7 +82,15 @@ func main() {
 	if err != nil {
 		log.Fatalf("failed to listen: %v", err)
 	}
-	srv := grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
+
+	var srv *grpc.Server
+	if os.Getenv("DISABLE_STATS") == "" {
+		log.Info("Stats enabled.")
+		srv = grpc.NewServer(grpc.StatsHandler(&ocgrpc.ServerHandler{}))
+	} else {
+		log.Info("Stats disabled.")
+		srv = grpc.NewServer()
+	}
 	svc := &server{}
 	pb.RegisterShippingServiceServer(srv, svc)
 	healthpb.RegisterHealthServer(srv, svc)