xds: Add client-side latency metrics for ext_proc HTTP filter

TAG=agy

Author: kannanjgithub

xds/src/main/java/io/grpc/xds/ExternalProcessorFilter.java

@@ -16,8 +16,6 @@
 
 package io.grpc.xds;
 
-import io.grpc.xds.Filter.FilterConfigParseContext;
-
 import static com.google.common.base.Preconditions.checkNotNull;
 import static java.util.concurrent.TimeUnit.NANOSECONDS;
 
@@ -47,6 +45,8 @@
 import io.grpc.internal.GrpcUtil;
 import io.grpc.xds.FaultConfig.FaultAbort;
 import io.grpc.xds.FaultConfig.FaultDelay;
+import io.grpc.xds.Filter.FilterConfigParseContext;
+import io.grpc.xds.Filter.FilterContext;
 import io.grpc.xds.ThreadSafeRandom.ThreadSafeRandomImpl;
 import java.util.Locale;
 import java.util.concurrent.Executor;
@@ -101,7 +101,7 @@ public boolean isClientFilter() {
     }
 
     @Override
-    public FaultFilter newInstance(String name) {
+    public FaultFilter newInstance(FilterContext context) {
       return INSTANCE;
     }
 

xds/src/main/java/io/grpc/xds/FaultFilter.java

@@ -21,6 +21,7 @@
 import com.google.common.base.MoreObjects;
 import com.google.protobuf.Message;
 import io.grpc.ClientInterceptor;
+import io.grpc.MetricRecorder;
 import io.grpc.ServerInterceptor;
 import io.grpc.xds.client.Bootstrapper.BootstrapInfo;
 import io.grpc.xds.client.Bootstrapper.ServerInfo;
@@ -91,7 +92,7 @@ default boolean isServerFilter() {
      *   <li>Filter name+typeUrl in FilterChain's HCM.http_filters.</li>
      * </ol>
      */
-    Filter newInstance(String name);
+    Filter newInstance(FilterContext context);
 
     /**
      * Parses the top-level filter config from raw proto message. The message may be either a {@link
@@ -152,6 +153,18 @@ abstract static class Builder {
     }
   }
 
+  /** Context containing naming and metrics reporting objects for a filter instance. */
+  @AutoValue
+  abstract static class FilterContext {
+    abstract String filterName();
+
+    abstract MetricRecorder metricsRecorder();
+
+    static FilterContext create(String filterName, MetricRecorder metricsRecorder) {
+      return new AutoValue_Filter_FilterContext(filterName, metricsRecorder);
+    }
+  }
+
   /** Filter config with instance name. */
   final class NamedFilterConfig {
     // filter instance name

xds/src/main/java/io/grpc/xds/Filter.java

@@ -16,8 +16,6 @@
 
 package io.grpc.xds;
 
-import io.grpc.xds.Filter.FilterConfigParseContext;
-
 import static com.google.common.base.Preconditions.checkNotNull;
 import static io.grpc.xds.XdsNameResolver.CLUSTER_SELECTION_KEY;
 import static io.grpc.xds.XdsNameResolver.XDS_CONFIG_CALL_OPTION_KEY;
@@ -43,6 +41,8 @@
 import io.grpc.Status;
 import io.grpc.StatusOr;
 import io.grpc.auth.MoreCallCredentials;
+import io.grpc.xds.Filter.FilterConfigParseContext;
+import io.grpc.xds.Filter.FilterContext;
 import io.grpc.xds.GcpAuthenticationFilter.AudienceMetadataParser.AudienceWrapper;
 import io.grpc.xds.MetadataRegistry.MetadataValueParser;
 import io.grpc.xds.XdsConfig.XdsClusterConfig;
@@ -83,8 +83,8 @@ public boolean isClientFilter() {
     }
 
     @Override
-    public GcpAuthenticationFilter newInstance(String name) {
-      return new GcpAuthenticationFilter(name, cacheSize);
+    public GcpAuthenticationFilter newInstance(FilterContext context) {
+      return new GcpAuthenticationFilter(context.filterName(), cacheSize);
     }
 
     @Override

xds/src/main/java/io/grpc/xds/GcpAuthenticationFilter.java

@@ -19,6 +19,7 @@
 import io.envoyproxy.envoy.extensions.filters.http.rbac.v3.RBAC;
 import io.grpc.Internal;
 import io.grpc.ServerInterceptor;
+import io.grpc.xds.Filter.FilterContext;
 
 /** This class exposes some functionality in RbacFilter to other packages. */
 @Internal
@@ -33,7 +34,8 @@ public static ServerInterceptor createInterceptor(RBAC rbac) {
       throw new IllegalArgumentException(
         String.format("Failed to parse Rbac policy: %s", filterConfig.errorDetail));
     }
-    return new RbacFilter.Provider().newInstance("internalRbacFilter")
+    return new RbacFilter.Provider().newInstance(
+        FilterContext.create("internalRbacFilter", new io.grpc.MetricRecorder() {}))
         .buildServerInterceptor(filterConfig.config, null);
   }
 }

xds/src/main/java/io/grpc/xds/InternalRbacFilter.java

@@ -16,8 +16,6 @@
 
 package io.grpc.xds;
 
-import io.grpc.xds.Filter.FilterConfigParseContext;
-
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.google.protobuf.Any;
@@ -35,6 +33,8 @@
 import io.grpc.ServerCallHandler;
 import io.grpc.ServerInterceptor;
 import io.grpc.Status;
+import io.grpc.xds.Filter.FilterConfigParseContext;
+import io.grpc.xds.Filter.FilterContext;
 import io.grpc.xds.internal.MatcherParser;
 import io.grpc.xds.internal.Matchers;
 import io.grpc.xds.internal.rbac.engine.GrpcAuthorizationEngine;
@@ -91,7 +91,7 @@ public boolean isServerFilter() {
     }
 
     @Override
-    public RbacFilter newInstance(String name) {
+    public RbacFilter newInstance(FilterContext context) {
       return INSTANCE;
     }
 

xds/src/main/java/io/grpc/xds/RbacFilter.java

@@ -16,9 +16,9 @@
 
 package io.grpc.xds;
 
-import io.grpc.xds.Filter.FilterConfigParseContext;
-
 import com.google.protobuf.Message;
+import io.grpc.xds.Filter.FilterConfigParseContext;
+import io.grpc.xds.Filter.FilterContext;
 
 /**
  * Router filter implementation. Currently this filter does not parse any field in the config.
@@ -58,7 +58,7 @@ public boolean isServerFilter() {
     }
 
     @Override
-    public RouterFilter newInstance(String name) {
+    public RouterFilter newInstance(FilterContext context) {
       return INSTANCE;
     }
 

xds/src/main/java/io/grpc/xds/RouterFilter.java

@@ -16,8 +16,6 @@
 
 package io.grpc.xds;
 
-import io.grpc.xds.Filter.FilterConfigParseContext;
-
 import static com.google.common.base.Preconditions.checkNotNull;
 import static io.grpc.xds.XdsClusterResource.validateCommonTlsContext;
 import static io.grpc.xds.XdsRouteConfigureResource.extractVirtualHosts;
@@ -620,7 +618,7 @@ static StructOrError<Filter.FilterConfig> parseHttpFilter(
               isForClient ? "client" : "server"));
     }
 
-    FilterConfigParseContext filterContext = FilterConfigParseContext.builder()
+    Filter.FilterConfigParseContext filterContext = Filter.FilterConfigParseContext.builder()
         .bootstrapInfo(args.getBootstrapInfo())
         .serverInfo(args.getServerInfo())
         .build();

xds/src/main/java/io/grpc/xds/XdsListenerResource.java

@@ -51,6 +51,7 @@
 import io.grpc.internal.ObjectPool;
 import io.grpc.xds.ClusterSpecifierPlugin.PluginConfig;
 import io.grpc.xds.Filter.FilterConfig;
+import io.grpc.xds.Filter.FilterContext;
 import io.grpc.xds.Filter.NamedFilterConfig;
 import io.grpc.xds.RouteLookupServiceClusterSpecifierPlugin.RlsPluginConfig;
 import io.grpc.xds.ThreadSafeRandom.ThreadSafeRandomImpl;
@@ -121,7 +122,6 @@ final class XdsNameResolver extends NameResolver {
   private final ThreadSafeRandom random;
   private final FilterRegistry filterRegistry;
   private final XxHash64 hashFunc = XxHash64.INSTANCE;
-  // Clusters (with reference counts) to which new/existing requests can be/are routed.
   // put()/remove() must be called in SyncContext, and get() can be called in any thread.
   private final ConcurrentMap<String, ClusterRefState> clusterRefs = new ConcurrentHashMap<>();
   private final ConfigSelector configSelector = new ConfigSelector();
@@ -138,6 +138,7 @@ final class XdsNameResolver extends NameResolver {
   private CallCounterProvider callCounterProvider;
   private ResolveState resolveState;
 
+
   /**
    * Constructs a new instance.
    *
@@ -742,7 +743,9 @@ private void updateActiveFilters(@Nullable List<NamedFilterConfig> filterConfigs
         Filter.Provider provider = filterRegistry.get(typeUrl);
         checkNotNull(provider, "provider %s", typeUrl);
         Filter filter = activeFilters.computeIfAbsent(
-            filterKey, k -> provider.newInstance(namedFilter.name));
+            filterKey, k -> provider.newInstance(
+                FilterContext.create(
+                    namedFilter.name, nameResolverArgs.getMetricRecorder())));
         checkNotNull(filter, "filter %s", filterKey);
         filtersToShutdown.remove(filterKey);
       }

xds/src/main/java/io/grpc/xds/XdsNameResolver.java

@@ -16,8 +16,6 @@
 
 package io.grpc.xds;
 
-import io.grpc.xds.Filter.FilterConfigParseContext;
-
 import static com.google.common.base.Preconditions.checkNotNull;
 
 import com.github.udpa.udpa.type.v1.TypedStruct;
@@ -214,7 +212,7 @@ private static StructOrError<VirtualHost> parseVirtualHost(
   static StructOrError<Map<String, FilterConfig>> parseOverrideFilterConfigs(
       Map<String, Any> rawFilterConfigMap, FilterRegistry filterRegistry,
       XdsResourceType.Args args) {
-    FilterConfigParseContext context = FilterConfigParseContext.builder()
+    Filter.FilterConfigParseContext context = Filter.FilterConfigParseContext.builder()
         .bootstrapInfo(args.getBootstrapInfo())
         .serverInfo(args.getServerInfo())
         .build();