census: use no arg methods for ClientInterceptors and StreamFactories

Author: AgraVator

census/src/main/java/io/grpc/census/GrpcCensus.java

@@ -21,13 +21,18 @@
 import io.grpc.ClientInterceptor;
 import io.grpc.ServerBuilder;
 import io.grpc.ServerStreamTracer;
-import io.opencensus.stats.StatsRecorder;
-import io.opencensus.tags.Tagger;
-import io.opencensus.tags.propagation.TagContextBinarySerializer;
 import io.opencensus.trace.Tracing;
 
+/**
+ *  The entrypoint for OpenCensus instrumentation functionality in gRPC.
+ *
+ *  <p>GrpcCensus uses {@link io.opencensus.api.OpenCensus} APIs for instrumentation.
+ *
+ */
 public final class GrpcCensus {
 
+  private GrpcCensus() {}
+
   private static final Supplier<Stopwatch> STOPWATCH_SUPPLIER = new Supplier<Stopwatch>() {
     @Override
     public Stopwatch get() {
@@ -38,40 +43,15 @@ public Stopwatch get() {
   /**
    * Returns a {@link ClientInterceptor} with default stats implementation.
    */
-  public static ClientInterceptor newClientStatsInterceptor(
-      boolean recordStartedRpcs,
-      boolean recordFinishedRpcs,
-      boolean recordRealTimeMetrics,
-      boolean recordRetryMetrics) {
+  public static ClientInterceptor newClientStatsInterceptor() {
     CensusStatsModule censusStats =
         new CensusStatsModule(
             STOPWATCH_SUPPLIER,
-            true, /* propagateTags */
-            recordStartedRpcs,
-            recordFinishedRpcs,
-            recordRealTimeMetrics,
-            recordRetryMetrics);
-    return censusStats.getClientInterceptor();
-  }
-
-  /**
-   * Returns a {@link ClientInterceptor} with custom stats implementation.
-   */
-  public static ClientInterceptor newClientStatsInterceptor(
-      Tagger tagger,
-      TagContextBinarySerializer tagCtxSerializer,
-      StatsRecorder statsRecorder,
-      Supplier<Stopwatch> stopwatchSupplier,
-      boolean propagateTags,
-      boolean recordStartedRpcs,
-      boolean recordFinishedRpcs,
-      boolean recordRealTimeMetrics,
-      boolean recordRetryMetrics) {
-    CensusStatsModule censusStats =
-        new CensusStatsModule(
-            tagger, tagCtxSerializer, statsRecorder, stopwatchSupplier,
-            propagateTags, recordStartedRpcs, recordFinishedRpcs, recordRealTimeMetrics,
-            recordRetryMetrics);
+            true,
+            true,
+            true,
+            false,
+            true);
     return censusStats.getClientInterceptor();
   }
 
@@ -89,44 +69,22 @@ public static ClientInterceptor newClientTracingInterceptor() {
   /**
    * Returns a {@link ServerStreamTracer.Factory} with default stats implementation.
    */
-  public static ServerStreamTracer.Factory getServerStreamTracerFactory(
-      boolean recordStartedRpcs,
-      boolean recordFinishedRpcs,
-      boolean recordRealTimeMetrics) {
+  private static ServerStreamTracer.Factory newServerStatsStreamTracerFactory() {
     CensusStatsModule censusStats =
         new CensusStatsModule(
             STOPWATCH_SUPPLIER,
-            true, /* propagateTags */
-            recordStartedRpcs,
-            recordFinishedRpcs,
-            recordRealTimeMetrics,
-            false);
-    return censusStats.getServerTracerFactory();
-  }
-
-  /**
-   * Returns a {@link ServerStreamTracer.Factory} with custom stats implementation.
-   */
-  public static ServerStreamTracer.Factory getServerStreamTracerFactory(
-      Tagger tagger,
-      TagContextBinarySerializer tagCtxSerializer,
-      StatsRecorder statsRecorder,
-      Supplier<Stopwatch> stopwatchSupplier,
-      boolean propagateTags,
-      boolean recordStartedRpcs,
-      boolean recordFinishedRpcs,
-      boolean recordRealTimeMetrics) {
-    CensusStatsModule censusStats =
-        new CensusStatsModule(
-            tagger, tagCtxSerializer, statsRecorder, stopwatchSupplier,
-            propagateTags, recordStartedRpcs, recordFinishedRpcs, recordRealTimeMetrics, false);
+            true,
+            true,
+            true,
+            false,
+            true);
     return censusStats.getServerTracerFactory();
   }
 
   /**
    * Returns a {@link ServerStreamTracer.Factory} with default tracing implementation.
    */
-  public static ServerStreamTracer.Factory getServerStreamTracerFactory() {
+  private static ServerStreamTracer.Factory newServerTracingStreamTracerFactory() {
     CensusTracingModule censusTracing =
         new CensusTracingModule(
             Tracing.getTracer(),
@@ -135,14 +93,21 @@ public static ServerStreamTracer.Factory getServerStreamTracerFactory() {
   }
 
   /**
-   * Configures the given {@link ServerBuilder} with the provided serverStreamTracerFactory.
+   * Configures the given {@link ServerBuilder} with serverStreamTracerFactory for stats.
+   *
+   * @param serverBuilder             the server builder to configure
+   */
+  public static void configureServerBuilderWithStatsTracer(ServerBuilder<?> serverBuilder) {
+    serverBuilder.addStreamTracerFactory(newServerStatsStreamTracerFactory());
+  }
+
+  /**
+   * Configures the given {@link ServerBuilder} with serverStreamTracerFactory for tracing.
    *
    * @param serverBuilder             the server builder to configure
-   * @param serverStreamTracerFactory the server stream tracer factory to configure
    */
-  public static void configureServerBuilder(ServerBuilder<?> serverBuilder,
-                                            ServerStreamTracer.Factory serverStreamTracerFactory) {
-    serverBuilder.addStreamTracerFactory(serverStreamTracerFactory);
+  public static void configureServerBuilderWithTracingTracer(ServerBuilder<?> serverBuilder) {
+    serverBuilder.addStreamTracerFactory(newServerTracingStreamTracerFactory());
   }
 
 }

core/src/main/java/io/grpc/internal/ServerImplBuilder.java

@@ -99,7 +99,7 @@ public static ServerBuilder<?> forPort(int port) {
   ServerCallExecutorSupplier executorSupplier;
 
   /**
-   * An interface to provide to provide transport specific information for the server. This method
+   * An interface to provide transport specific information for the server. This method
    * is meant for Transport implementors and should not be used by normal users.
    */
   public interface ClientTransportServersBuilder {