Optimize within pattern matching for Kanela modules [WIP]

.github/workflows/ci.yml

@@ -23,5 +23,5 @@ jobs:
         with:
           java-version: ${{ matrix.java }}
       - name: Test
-        run: ./gradlew wrapper --gradle-version=7.3.1 :agent:publishToMavenLocal && ./gradlew wrapper --gradle-version=7.3.1 assemble && ./travis-test.sh
+        run: ./gradlew :agent:publishToMavenLocal && ./gradlew assemble && ./travis-test.sh
 

.gitignore

@@ -90,7 +90,7 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 
-# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+# virtual machine crash logs, see https://www.java.com/en/download/help/error_hotspot.html
 hs_err_pid*
 
 /agent/src/main/scala/*.sc

CONTRIBUTING.md

@@ -30,6 +30,6 @@ please squash them into a single commit. Let the PR rain begin!
 
 
 [open an issue]: https://github.com/kamon-io/Kamon/issues/new
-[mailing list]: https://groups.google.com/forum/#!forum/kamon-user
+[mailing list]: https://groups.google.com/g/kamon-user
 [commit message conventions]: http://spray.io/project-info/contributing/
 [CLA]: https://docs.google.com/forms/d/1G_IDrBTFzOMwHvhxfKRBwNtpRelSa_MZ6jecH8lpTlc/viewform

README.md

@@ -6,5 +6,5 @@
 **Kanela** is a Java Agent written in Java 8+ and powered by [ByteBuddy] with some additionally [ASM] features to provide a simple way to instrument applications running on the JVM and allow introduce Kamon features such as context propagation and metrics.
 
 
-[ByteBuddy]:http://bytebuddy.net/#/
-[ASM]:http://asm.ow2.org/
+[ByteBuddy]:https://bytebuddy.net/#/
+[ASM]:https://asm.ow2.io/

agent-test/build.gradle

@@ -19,23 +19,21 @@ plugins {
     id 'java'
     id 'application'
     id 'scala'
-    id 'com.github.maiflai.scalatest' version '0.31'
+    id 'com.github.maiflai.scalatest' version '0.32'
 }
 
 mainClassName = 'app.kanela.JavaMainWithAgent'
 
 dependencies {
     implementation "org.scala-lang:scala-library:${scala_version}"
-    implementation 'org.slf4j:slf4j-api:1.7.25'
-    implementation 'ch.qos.logback:logback-core:1.2.3'
-    implementation 'ch.qos.logback:logback-classic:1.2.3'
+    implementation 'ch.qos.logback:logback-classic:1.2.11'
 
     implementation "io.kamon:kanela-agent:${agent_version}"
 
     provided(kamon_agent_dep)
 
-    testImplementation 'org.mockito:mockito-core:2.28.2'
-    testImplementation 'org.scalatest:scalatest_2.12:3.0.8'
+    testImplementation 'org.mockito:mockito-core:4.6.1'
+    testImplementation 'org.scalatest:scalatest_2.12:3.2.12'
     testRuntimeOnly 'org.pegdown:pegdown:1.6.0'
 }
 
@@ -106,5 +104,5 @@ gradle.taskGraph.whenReady { taskGraph ->
     KamonAgentTestRunning = result
 }
 
-test.reports.html.enabled = false
+test.reports.html.required = false
 

agent-test/src/main/resources/application.conf

@@ -1,14 +1,14 @@
 kanela {
-    modules {
-      example-module {
-        name = "Example Module"
-        stoppable = false
-        instrumentations = [
-          "app.kanela.instrumentation.MonitorInstrumentation",
-        ]
-        within = [ "app.kanela.cases.+" ]
-      }
+  modules {
+    example-module {
+      name = "Example Module"
+      stoppable = false
+      instrumentations = [
+        "app.kanela.instrumentation.MonitorInstrumentation",
+      ]
+      within = [ "app\\.kanela\\.cases\\..+" ]
     }
-    debug-mode = false
-    class-dumper.enabled = false
-}
+  }
+  debug-mode = false
+  class-dumper.enabled = false
+}

agent-test/src/test/resources/application.conf

@@ -10,8 +10,8 @@ kanela {
       instrumentations = [ ] // written by spec
 
       within = [
-        "app.kanela..*",
-        "java.net.*"
+        "app\\.kanela\\..*",
+        "java\\.net\\..*",
       ]
 
       bootstrap-injection {

agent-test/src/test/scala/app/kanela/specs/AttachInRuntimeSpec.scala

@@ -18,11 +18,12 @@ package app.kanela.specs
 
 import app.kanela.cases.simple.TestClass
 import kanela.agent.attacher.Attacher
-import org.scalatest.{BeforeAndAfterAll, FlatSpec, Matchers}
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
 
 import scala.collection.mutable.ListBuffer
 
-class AttachInRuntimeSpec extends FlatSpec with Matchers with BeforeAndAfterAll {
+class AttachInRuntimeSpec extends AnyFlatSpec with Matchers {
 
   "Kanela agent" should "be able to attach in runtime and instrument the loaded classes" in {
     val testClass = new TestClass()

agent-test/src/test/scala/app/kanela/specs/BootstrapInstrumentationSpec.scala

@@ -16,12 +16,13 @@
 
 package app.kanela.specs
 
-import java.net.{HttpURLConnection, URL}
-
 import kanela.agent.attacher.Attacher
-import org.scalatest.{BeforeAndAfterAll, FlatSpec, Matchers}
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
+
+import java.net.{HttpURLConnection, URL}
 
-class BootstrapInstrumentationSpec extends FlatSpec with Matchers with BeforeAndAfterAll {
+class BootstrapInstrumentationSpec extends AnyFlatSpec with Matchers {
   "The Bootstrap Injection feature" should
     "provide the necessary helper classes when we instrument the bootstrap class loader" in {
       Attacher.attach()

agent-test/src/test/scala/app/kanela/specs/BridgeInstrumentationSpec.scala

@@ -18,10 +18,10 @@ package app.kanela.specs
 
 import app.kanela.cases.bridge.PrivateClass
 import app.kanela.instrumentation.PrivateClassBridge
-import org.scalatest.{BeforeAndAfterAll, FlatSpec, Matchers}
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
 
-
-class BridgeInstrumentationSpec extends FlatSpec with Matchers with BeforeAndAfterAll {
+class BridgeInstrumentationSpec extends AnyFlatSpec with Matchers {
   "The Bridge" should
     "generate an accessor method for a private field or method" in {
         val privateClass = new PrivateClass()

agent-test/src/test/scala/app/kanela/specs/MultiMixinsInstrumentationSpec.scala

@@ -18,9 +18,10 @@ package app.kanela.specs
 
 import app.kanela.cases.multimixins.MixinAware.{MixinAware1, MixinAware2, MixinAware3}
 import app.kanela.cases.multimixins.WithMultiMixinsClass
-import org.scalatest.{BeforeAndAfterAll, FlatSpec, Matchers}
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
 
-class MultiMixinsInstrumentationSpec extends FlatSpec with Matchers with BeforeAndAfterAll {
+class MultiMixinsInstrumentationSpec extends AnyFlatSpec with Matchers {
 
   "Multiple Mixins over a single subType" should
     "introduce all types appropriately" in {

agent-test/src/test/scala/app/kanela/specs/SimpleInstrumentationSpec.scala

@@ -17,11 +17,12 @@
 package app.kanela.specs
 
 import app.kanela.cases.simple.{SpyAware, TestClass}
-import org.scalatest.{FlatSpec, Matchers}
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
 
 import scala.collection.mutable.ListBuffer
 
-class SimpleInstrumentationSpec extends FlatSpec with Matchers {
+class SimpleInstrumentationSpec extends AnyFlatSpec with Matchers {
 
   "An Advisor with OnMethodEnter and OnMethodExit" should "be able to instrument a specific method of a class" in {
     val testClass = new TestClass()

agent-test/src/test/scala/app/kanela/specs/StoppableInstrumentationSpec.scala

@@ -20,11 +20,12 @@ import app.kanela.cases.simple.TestClass
 import kanela.agent.attacher.Attacher
 import kanela.agent.broker.EventBroker
 import kanela.agent.reinstrument.Reinstrumenter.ReinstrumentationProtocol._
-import org.scalatest.{BeforeAndAfterAll, FlatSpec, Matchers}
+import org.scalatest.flatspec.AnyFlatSpec
+import org.scalatest.matchers.should.Matchers
 
 import scala.collection.mutable.ListBuffer
 
-class StoppableInstrumentationSpec extends FlatSpec with Matchers with BeforeAndAfterAll {
+class StoppableInstrumentationSpec extends AnyFlatSpec with Matchers {
 
   "A module stoppable" should "be able to retransform and reset instrumentation under critical state" in {
     val testClass = new TestClass()

agent/build.gradle

@@ -20,16 +20,16 @@ plugins {
     id 'scala'
     id 'maven-publish'
     id 'signing'
-    id 'com.github.maiflai.scalatest' version '0.31'
-    id 'com.github.johnrengelman.shadow' version '7.0.0'
+    id 'com.github.maiflai.scalatest' version '0.32'
+    id 'com.github.johnrengelman.shadow' version '7.1.2'
 }
 
 configurations {
     kamonInstrumentationBundle
 }
 
 dependencies {
-    implementation 'com.typesafe:config:1.3.4'
+    implementation 'com.typesafe:config:1.4.2'
     implementation 'com.blogspot.mydailyjava:weak-lock-free:0.18'
 
     implementation 'org.tinylog:tinylog:1.3.6'
@@ -38,8 +38,8 @@ dependencies {
 
     implementation files('libs/byte-buddy-1.11.18.jar')
 
-    testImplementation 'org.mockito:mockito-core:2.28.2'
-    testImplementation 'org.scalatest:scalatest_2.12:3.0.1'
+    testImplementation 'org.mockito:mockito-core:4.6.1'
+    testImplementation 'org.scalatest:scalatest_2.12:3.2.12'
     testImplementation "org.scala-lang:scala-library:${scala_version}"
     testImplementation 'org.pegdown:pegdown:1.6.0'
 }
@@ -48,8 +48,8 @@ def agentBootstrapClasses = 'kanela/agent/bootstrap/**'
 
 task bootstrapJar(type: Jar) {
     // Output to 'bootstrap.jar'.
-    baseName = 'bootstrap'
-    version = null
+    archiveBaseName = 'bootstrap'
+    archiveVersion = null
 
     from sourceSets.main.output
     include agentBootstrapClasses
@@ -58,8 +58,8 @@ task bootstrapJar(type: Jar) {
 shadowJar.dependsOn bootstrapJar
 
 shadowJar {
-    baseName = 'kanela-agent'
-    classifier = null
+    archiveBaseName = 'kanela-agent'
+    archiveClassifier = null
 
     mergeServiceFiles {
        path = 'META-INF/services/org.pmw.tinylog.*'
@@ -88,14 +88,14 @@ shadowJar {
     }
 
     dependencies {
-        exclude('org.projectlombok:lombok:1.18.20')
+        exclude('org.projectlombok:lombok:1.18.24')
     }
 
     doLast {
         def agentBootstrapJar = 'kanela/agent/bootstrap.jar'
 
         // Bundle bootstrap.jar.
-        ant.jar(update: 'true', destfile: shadowJar.archivePath) {
+        ant.jar(update: 'true', destfile: shadowJar.archiveFile.get()) {
             mappedresources {
                 fileset(file: bootstrapJar.archivePath)
                 globmapper(from: '*', to: agentBootstrapJar)
@@ -123,7 +123,7 @@ def pomConfig = {
     licenses {
         license {
             name "The Apache Software License, Version 2.0"
-            url "http://www.apache.org/licenses/LICENSE-2.0.txt"
+            url "https://www.apache.org/licenses/LICENSE-2.0.txt"
         }
     }
     developers {
@@ -164,7 +164,7 @@ publishing {
                 def root = asNode()
                 root.appendNode('description', 'The Kamon Instrumentation Agent')
                 root.appendNode('name', 'Kanela')
-                root.appendNode('url', 'http://kamon.io')
+                root.appendNode('url', 'https://kamon.io/')
                 root.children().last() + pomConfig
             }
         }
@@ -211,4 +211,4 @@ classes {
     dependsOn createBuildInfoFile
 }
 
-test.reports.html.enabled = false
+test.reports.html.required = false

agent/src/main/java/kanela/agent/InstrumentationLoader.java

@@ -35,13 +35,13 @@ public class InstrumentationLoader {
      * Load from the current classpath all defined instrumentations {@link InstrumentationBuilder}.
      *
      * @param instrumentation {@link Instrumentation}
-     * @param ctxClassloader {@link ClassLoader}
-     * @param configuration {@link KanelaConfiguration}
+     * @param ctxClassloader  {@link ClassLoader}
+     * @param configuration   {@link KanelaConfiguration}
      * @return a list of {@link KanelaFileTransformer}
      */
     public static List<KanelaFileTransformer> load(Instrumentation instrumentation, ClassLoader ctxClassloader, KanelaConfiguration configuration) {
         return configuration.getAgentModules().map((moduleConfiguration) -> {
-            Logger.info(() -> format("Loading {0} ",  moduleConfiguration.getName()));
+            Logger.info(() -> format("Loading {0}", moduleConfiguration.getName()));
             return moduleConfiguration.getInstrumentations()
                     .flatMap(instrumentationClassName -> loadInstrumentation(instrumentationClassName, ctxClassloader))
                     .filter(kanelaInstrumentation -> kanelaInstrumentation.isEnabled(moduleConfiguration))
@@ -55,7 +55,7 @@ public static List<KanelaFileTransformer> load(Instrumentation instrumentation,
     private static Option<InstrumentationBuilder> loadInstrumentation(String instrumentationClassName, ClassLoader classLoader) {
         return Try.of(() -> {
             Logger.info(() -> format(" ==> Loading {0} ", instrumentationClassName));
-            return (InstrumentationBuilder) Class.forName(instrumentationClassName, true, classLoader).newInstance();
+            return (InstrumentationBuilder) Class.forName(instrumentationClassName, true, classLoader).getConstructors()[0].newInstance();
         }).onFailure((cause) -> Logger.warn(() -> format("Error trying to load Instrumentation: {0} with error: {1}", instrumentationClassName, cause))
         ).toOption();
     }

agent/src/main/java/kanela/agent/api/instrumentation/InstrumentationDescription.java

@@ -104,12 +104,12 @@ public Builder withInterceptorFor(ElementMatcher.Junction<MethodDescription> met
             return this;
         }
 
-        public Builder withTransformation(Function4<DynamicType.Builder, TypeDescription, ClassLoader, JavaModule, DynamicType.Builder> f) {
+        public Builder withTransformation(Function4<DynamicType.Builder<?>, TypeDescription, ClassLoader, JavaModule, DynamicType.Builder<?>> f) {
             transformers.add(withTransformer(f));
             return this;
         }
 
-        private AgentBuilder.Transformer withTransformer(Function4<DynamicType.Builder, TypeDescription, ClassLoader, JavaModule, DynamicType.Builder> f) { return f::apply; }
+        private AgentBuilder.Transformer withTransformer(Function4<DynamicType.Builder<?>, TypeDescription, ClassLoader, JavaModule, DynamicType.Builder<?>> f) { return f::apply; }
 
         public InstrumentationDescription build() {
             return new InstrumentationDescription(this);

agent/src/main/java/kanela/agent/builder/KanelaAgentBuilder.java

@@ -24,6 +24,7 @@
 import kanela.agent.cache.PoolStrategyCache;
 import kanela.agent.resubmitter.PeriodicResubmitter;
 import kanela.agent.util.ListBuilder;
+import kanela.agent.util.PatternMatcher;
 import kanela.agent.util.conf.KanelaConfiguration;
 import kanela.agent.util.log.Logger;
 import lombok.Value;
@@ -36,6 +37,7 @@
 import net.bytebuddy.dynamic.scaffold.MethodGraph;
 import net.bytebuddy.dynamic.scaffold.TypeValidation;
 import net.bytebuddy.matcher.ElementMatcher;
+import net.bytebuddy.matcher.NameMatcher;
 
 import java.lang.instrument.Instrumentation;
 import java.util.ArrayList;
@@ -141,10 +143,20 @@ private AgentBuilder.Listener additionalListeners() {
     }
 
     private ElementMatcher.Junction<NamedElement> ignoreMatches() {
-        return not(nameMatches(moduleDescription.getWithinPackage()));
+        final String withinPackage = moduleDescription.getWithinPackage();
+        if (withinPackage.isEmpty()) {
+            return any();
+        } else {
+            return not(new NameMatcher<>(new PatternMatcher(withinPackage)));
+        }
     }
 
     private ElementMatcher.Junction<NamedElement> moduleExcludes() {
-        return nameMatches(moduleDescription.getExcludePackage());
+        final String moduleExcludes = moduleDescription.getExcludePackage();
+        if (moduleExcludes.isEmpty()) {
+            return none();
+        } else {
+            return new NameMatcher<>(new PatternMatcher(moduleExcludes));
+        }
     }
 }

agent/src/main/java/kanela/agent/util/PatternMatcher.java

@@ -0,0 +1,18 @@
+package kanela.agent.util;
+
+import net.bytebuddy.matcher.ElementMatcher;
+
+import java.util.regex.Pattern;
+
+public class PatternMatcher extends ElementMatcher.Junction.AbstractBase<String> {
+    private final Pattern regex;
+
+    public PatternMatcher(final String regex) {
+        this.regex = Pattern.compile(regex);
+    }
+
+    @Override
+    public boolean matches(final String target) {
+        return regex.matcher(target).matches();
+    }
+}