Move spring-security module enable check

Move the enable check to defaultEnable instead of typeInstrumentations, so that muzzle can properly detect helper classes.
open-telemetry · Oct 30, 2023 · fc91d93 · fc91d93
1 parent 37cd799
commit fc91d93
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 12 deletions.
diff --git a/...spring/security/config/v6_0/servlet/SpringSecurityConfigServletInstrumentationModule.java b/...spring/security/config/v6_0/servlet/SpringSecurityConfigServletInstrumentationModule.java
@@ -6,13 +6,13 @@
 package io.opentelemetry.javaagent.instrumentation.spring.security.config.v6_0.servlet;
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
-import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.util.List;
 import net.bytebuddy.matcher.ElementMatcher;
 
@@ -23,6 +23,18 @@ public SpringSecurityConfigServletInstrumentationModule() {
     super("spring-security-config-servlet", "spring-security-config-servlet-6.0");
   }
 
+  @Override
+  public boolean defaultEnabled(ConfigProperties config) {
+    /*
+     * Since the only thing this module currently does is capture enduser attributes,
+     * the module can be completely disabled if enduser attributes are disabled.
+     *
+     * If any functionality not related to enduser attributes is added to this module,
+     * then this check will need to move elsewhere to only guard the enduser attributes logic.
+     */
+    return CommonConfig.get().getEnduserConfig().isEnabled();
+  }
+
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
     return hasClassesNamed(
@@ -35,10 +47,6 @@ public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
 
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
-    if (CommonConfig.get().getEnduserConfig().isEnabled()) {
-      return singletonList(new HttpSecurityInstrumentation());
-    } else {
-      return emptyList();
-    }
+    return singletonList(new HttpSecurityInstrumentation());
   }
 }
diff --git a/...spring/security/config/v6_0/webflux/SpringSecurityConfigWebFluxInstrumentationModule.java b/...spring/security/config/v6_0/webflux/SpringSecurityConfigWebFluxInstrumentationModule.java
@@ -6,13 +6,13 @@
 package io.opentelemetry.javaagent.instrumentation.spring.security.config.v6_0.webflux;
 
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
-import static java.util.Collections.emptyList;
 import static java.util.Collections.singletonList;
 
 import com.google.auto.service.AutoService;
 import io.opentelemetry.javaagent.bootstrap.internal.CommonConfig;
 import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
 import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.sdk.autoconfigure.spi.ConfigProperties;
 import java.util.List;
 import net.bytebuddy.matcher.ElementMatcher;
 
@@ -24,17 +24,25 @@ public SpringSecurityConfigWebFluxInstrumentationModule() {
     super("spring-security-config-webflux", "spring-security-config-webflux-6.0");
   }
 
+  @Override
+  public boolean defaultEnabled(ConfigProperties config) {
+    /*
+     * Since the only thing this module currently does is capture enduser attributes,
+     * the module can be completely disabled if enduser attributes are disabled.
+     *
+     * If any functionality not related to enduser attributes is added to this module,
+     * then this check will need to move elsewhere to only guard the enduser attributes logic.
+     */
+    return CommonConfig.get().getEnduserConfig().isEnabled();
+  }
+
   @Override
   public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
     return hasClassesNamed("org.springframework.security.config.web.server.ServerHttpSecurity");
   }
 
   @Override
   public List<TypeInstrumentation> typeInstrumentations() {
-    if (CommonConfig.get().getEnduserConfig().isEnabled()) {
-      return singletonList(new ServerHttpSecurityInstrumentation());
-    } else {
-      return emptyList();
-    }
+    return singletonList(new ServerHttpSecurityInstrumentation());
   }
 }