Merge pull request #236 from solarwinds/cc/NH-82170

NH-82170: unroll `buildMatcher` method in `TraceContextInjector`
solarwinds · Jun 17, 2024 · 2b4d79e · 2b4d79e
2 parents b2e653b + 3cf32d0
commit 2b4d79e
Show file tree

Hide file tree

Showing 4 changed files with 48 additions and 27 deletions.
diff --git a/...main/java/com/solarwinds/opentelemetry/instrumentation/JdbcConnectionInstrumentation.java b/...main/java/com/solarwinds/opentelemetry/instrumentation/JdbcConnectionInstrumentation.java
@@ -16,7 +16,7 @@
 
 package com.solarwinds.opentelemetry.instrumentation;
 
-import static com.solarwinds.opentelemetry.instrumentation.TraceContextInjector.buildMatcher;
+import static com.solarwinds.opentelemetry.instrumentation.TraceContextInjector.isDbConfigured;
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
@@ -45,8 +45,23 @@ public ElementMatcher<ClassLoader> classLoaderOptimization() {
   public ElementMatcher<TypeDescription> typeMatcher() {
     Boolean sqlTagPrepared =
         ConfigManager.getConfigOptional(ConfigProperty.AGENT_SQL_TAG_PREPARED, false);
+
     if (sqlTagPrepared) {
-      ElementMatcher.Junction<TypeDescription> matcher = buildMatcher();
+      // Duplicating lines 51 - 62 across TypeInstrumentation impls due to runtime muzzle mismatch
+      // as a result of missing `net.bytebuddy.matcher.*` classes in consolidated method.
+      ElementMatcher.Junction<TypeDescription> matcher = null;
+      if (isDbConfigured(TraceContextInjector.Db.mysql)) {
+        matcher = nameStartsWith("com.mysql.cj.jdbc"); // only inject MySQL JDBC driver
+      }
+
+      if (isDbConfigured(TraceContextInjector.Db.postgresql)) {
+        if (matcher != null) {
+          matcher = matcher.or(nameStartsWith("org.postgresql"));
+        } else {
+          matcher = nameStartsWith("org.postgresql");
+        }
+      }
+
       if (matcher != null) {
         return matcher.and(implementsInterface(named("java.sql.Connection")));
       }

diff --git a/...va/com/solarwinds/opentelemetry/instrumentation/JdbcPreparedStatementInstrumentation.java b/...va/com/solarwinds/opentelemetry/instrumentation/JdbcPreparedStatementInstrumentation.java
@@ -16,7 +16,7 @@
 
 package com.solarwinds.opentelemetry.instrumentation;
 
-import static com.solarwinds.opentelemetry.instrumentation.TraceContextInjector.buildMatcher;
+import static com.solarwinds.opentelemetry.instrumentation.TraceContextInjector.isDbConfigured;
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
@@ -45,12 +45,26 @@ public ElementMatcher<ClassLoader> classLoaderOptimization() {
   public ElementMatcher<TypeDescription> typeMatcher() {
     Boolean sqlTagPrepared =
         ConfigManager.getConfigOptional(ConfigProperty.AGENT_SQL_TAG_PREPARED, false);
+
     if (sqlTagPrepared) {
-      ElementMatcher.Junction<TypeDescription> matcher = buildMatcher();
+      ElementMatcher.Junction<TypeDescription> matcher = null;
+      if (isDbConfigured(TraceContextInjector.Db.mysql)) {
+        matcher = nameStartsWith("com.mysql.cj.jdbc"); // only inject MySQL JDBC driver
+      }
+
+      if (isDbConfigured(TraceContextInjector.Db.postgresql)) {
+        if (matcher != null) {
+          matcher = matcher.or(nameStartsWith("org.postgresql"));
+        } else {
+          matcher = nameStartsWith("org.postgresql");
+        }
+      }
+
       if (matcher != null) {
         return matcher.and(implementsInterface(named("java.sql.PreparedStatement")));
       }
     }
+
     return none();
   }
 

diff --git a/.../main/java/com/solarwinds/opentelemetry/instrumentation/JdbcStatementInstrumentation.java b/.../main/java/com/solarwinds/opentelemetry/instrumentation/JdbcStatementInstrumentation.java
@@ -16,7 +16,7 @@
 
 package com.solarwinds.opentelemetry.instrumentation;
 
-import static com.solarwinds.opentelemetry.instrumentation.TraceContextInjector.buildMatcher;
+import static com.solarwinds.opentelemetry.instrumentation.TraceContextInjector.isDbConfigured;
 import static io.opentelemetry.javaagent.bootstrap.Java8BytecodeBridge.currentContext;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
 import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.implementsInterface;
@@ -49,8 +49,21 @@ public ElementMatcher<ClassLoader> classLoaderOptimization() {
   @Override
   public ElementMatcher<TypeDescription> typeMatcher() {
     Boolean sqlTag = ConfigManager.getConfigOptional(ConfigProperty.AGENT_SQL_TAG, false);
+
     if (sqlTag) {
-      ElementMatcher.Junction<TypeDescription> matcher = buildMatcher();
+      ElementMatcher.Junction<TypeDescription> matcher = null;
+      if (isDbConfigured(TraceContextInjector.Db.mysql)) {
+        matcher = nameStartsWith("com.mysql.cj.jdbc"); // only inject MySQL JDBC driver
+      }
+
+      if (isDbConfigured(TraceContextInjector.Db.postgresql)) {
+        if (matcher != null) {
+          matcher = matcher.or(nameStartsWith("org.postgresql"));
+        } else {
+          matcher = nameStartsWith("org.postgresql");
+        }
+      }
+
       if (matcher != null) {
         return matcher.and(implementsInterface(named("java.sql.Statement")));
       }

diff --git a/...jdbc/src/main/java/com/solarwinds/opentelemetry/instrumentation/TraceContextInjector.java b/...jdbc/src/main/java/com/solarwinds/opentelemetry/instrumentation/TraceContextInjector.java
@@ -16,17 +16,13 @@
 
 package com.solarwinds.opentelemetry.instrumentation;
 
-import static net.bytebuddy.matcher.ElementMatchers.nameStartsWith;
-
 import com.solarwinds.joboe.config.ConfigManager;
 import com.solarwinds.joboe.config.ConfigProperty;
 import io.opentelemetry.api.trace.Span;
 import io.opentelemetry.api.trace.SpanContext;
 import io.opentelemetry.context.Context;
 import java.util.HashSet;
 import java.util.Set;
-import net.bytebuddy.description.type.TypeDescription;
-import net.bytebuddy.matcher.ElementMatcher;
 
 public class TraceContextInjector {
 
@@ -63,23 +59,6 @@ public static boolean isDbConfigured(Db db) {
     return configuredDbs.contains(db.name());
   }
 
-  public static ElementMatcher.Junction<TypeDescription> buildMatcher() {
-    ElementMatcher.Junction<TypeDescription> matcher = null;
-    if (isDbConfigured(TraceContextInjector.Db.mysql)) {
-      matcher = nameStartsWith("com.mysql.cj.jdbc"); // only inject MySQL JDBC driver
-    }
-
-    if (isDbConfigured(TraceContextInjector.Db.postgresql)) {
-      if (matcher != null) {
-        matcher = matcher.or(nameStartsWith("org.postgresql"));
-      } else {
-        matcher = nameStartsWith("org.postgresql");
-      }
-    }
-
-    return matcher;
-  }
-
   public enum Db {
     mysql,
     postgresql