Add FilterProviderConfig to pass information to FilterProvider. (Eg. service name) (#379)

* Add FilterProviderConfig to pass information to FilterProvider. (Eg. service name)

* Fix circular dependency using the initialize() function.

* Remove unneeded dependency

* Ran spotlessApply

* Fix test mock

Author: tyroneyu

filter-api/src/main/java/org/hypertrace/agent/filter/FilterRegistry.java

@@ -25,6 +25,7 @@
 import java.util.ServiceLoader;
 import org.hypertrace.agent.filter.api.Filter;
 import org.hypertrace.agent.filter.spi.FilterProvider;
+import org.hypertrace.agent.filter.spi.FilterProviderConfig;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -53,7 +54,8 @@ public static Filter getFilter() {
       synchronized (FilterRegistry.class) {
         if (filter == null) {
           try {
-            filter = load(Collections.emptyList());
+            FilterProviderConfig providerConfig = new FilterProviderConfig();
+            filter = load(providerConfig, Collections.emptyList());
           } catch (Throwable t) {
             logger.error("Throwable thrown while loading filter jars", t);
           }
@@ -67,26 +69,28 @@ public static Filter getFilter() {
    * Initializes the registry by loading the filters. This method should be called only once at
    * javaagent startup.
    *
+   * @param providerConfig config needed by the filter (Eg. service name)
    * @param jarPaths paths to filter jar files.
    */
-  public static void initialize(List<String> jarPaths) {
+  public static void initialize(FilterProviderConfig providerConfig, List<String> jarPaths) {
     try {
-      filter = load(jarPaths);
+      filter = load(providerConfig, jarPaths);
     } catch (Throwable t) {
       logger.error("Throwable thrown while loading filter jars", t);
     }
   }
 
-  private static Filter load(List<String> jarPaths) {
+  private static Filter load(FilterProviderConfig providerConfig, List<String> jarPaths) {
     ClassLoader cl = loadJars(jarPaths);
     ServiceLoader<FilterProvider> providers = ServiceLoader.load(FilterProvider.class, cl);
     List<Filter> filters = new ArrayList<>();
+
     for (FilterProvider provider : providers) {
       String disabled = getProperty(getProviderDisabledPropertyName(provider.getClass()));
       if ("true".equalsIgnoreCase(disabled)) {
         continue;
       }
-      Filter filter = provider.create();
+      Filter filter = provider.create(providerConfig);
       if (filter == null) {
         logger.warn(String.format("%s returned null filter.", provider.getClass().getSimpleName()));
       } else {

filter-api/src/main/java/org/hypertrace/agent/filter/spi/FilterProvider.java

@@ -31,5 +31,5 @@ public interface FilterProvider {
    *
    * @return a filter instance.
    */
-  Filter create();
+  Filter create(FilterProviderConfig config);
 }

filter-api/src/main/java/org/hypertrace/agent/filter/spi/FilterProviderConfig.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright The Hypertrace Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.hypertrace.agent.filter.spi;
+
+/** {@link FilterProviderConfig} for {@link FilterProvider}. */
+public class FilterProviderConfig {
+  public FilterProviderConfig() {}
+
+  private String serviceName = "";
+
+  public String getServiceName() {
+    return serviceName;
+  }
+
+  public void setServiceName(String serviceName) {
+    this.serviceName = serviceName;
+  }
+}

otel-extensions/src/main/java/org/hypertrace/agent/otel/extensions/FilterComponentInstaller.java

@@ -24,6 +24,7 @@
 import java.util.stream.Collectors;
 import org.hypertrace.agent.config.v1.Config.AgentConfig;
 import org.hypertrace.agent.filter.FilterRegistry;
+import org.hypertrace.agent.filter.spi.FilterProviderConfig;
 import org.hypertrace.agent.otel.extensions.config.HypertraceConfig;
 
 @AutoService(AgentListener.class)
@@ -32,12 +33,15 @@ public class FilterComponentInstaller implements AgentListener {
   @Override
   public void beforeAgent(
       Config config, AutoConfiguredOpenTelemetrySdk autoConfiguredOpenTelemetrySdk) {
+    FilterProviderConfig providerConfig = new FilterProviderConfig();
     AgentConfig agentConfig = HypertraceConfig.get();
+    String serviceName = agentConfig.getServiceName().getValue();
+    providerConfig.setServiceName(serviceName);
     List<String> jarPaths =
         agentConfig.getJavaagent().getFilterJarPathsList().stream()
             .map(r -> r.getValue())
             .collect(Collectors.toList());
     // resolves filter via service loader resolution
-    FilterRegistry.initialize(jarPaths);
+    FilterRegistry.initialize(providerConfig, jarPaths);
   }
 }

testing-common/src/testFixtures/java/org/hypertrace/agent/testing/mockfilter/MockFilterProvider.java

@@ -19,12 +19,13 @@
 import com.google.auto.service.AutoService;
 import org.hypertrace.agent.filter.api.Filter;
 import org.hypertrace.agent.filter.spi.FilterProvider;
+import org.hypertrace.agent.filter.spi.FilterProviderConfig;
 
 @AutoService(FilterProvider.class)
 public class MockFilterProvider implements FilterProvider {
 
   @Override
-  public Filter create() {
+  public Filter create(FilterProviderConfig config) {
     return new MockFilter();
   }
 }