Merge pull request #350 from megaease/spring_boot

feat: release 2.3.0

Author: zhao-kun

.github/workflows/build.yml

@@ -32,7 +32,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ ubuntu-latest, windows-latest ]
-        java-version: [ 8, 11, 16 ]
+        java-version: [ 8, 11, 16, 17 ]
         java-distribution: [ adopt, adopt-openj9 ]
 
     # Steps represent a sequence of tasks that will be executed as part of the job
@@ -53,4 +53,4 @@ jobs:
 
       # Runs a single command using the runners shell
       - name: Build with Maven
-        run: mvn clean package 
+        run: mvn clean package

build/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <artifactId>easeagent</artifactId>
         <groupId>com.megaease.easeagent</groupId>
-        <version>2.2.9</version>
+        <version>2.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -38,23 +38,6 @@
             <artifactId>javax.servlet-api</artifactId>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.springframework.boot</groupId>
-            <artifactId>spring-boot-starter-web</artifactId>
-            <version>${version.spring-boot}</version>
-            <scope>provided</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.cloud</groupId>
-            <artifactId>spring-cloud-starter-openfeign</artifactId>
-            <scope>provided</scope>
-        </dependency>
-        <dependency>
-            <groupId>org.springframework.cloud</groupId>
-            <artifactId>spring-cloud-starter-gateway</artifactId>
-            <scope>provided</scope>
-        </dependency>
-
         <dependency>
             <groupId>com.megaease.easeagent</groupId>
             <artifactId>metrics</artifactId>
@@ -209,6 +192,7 @@
                             <Premain-Class>com.megaease.easeagent.Main</Premain-Class>
                             <Bootstrap-Class>com.megaease.easeagent.StartBootstrap</Bootstrap-Class>
                             <Logging-Property>log4j.configurationFile</Logging-Property>
+                            <Easeagent-Version>${version}</Easeagent-Version>
                         </manifestEntries>
                     </archive>
                     <archiverConfig>

build/src/main/resources/agent.properties

@@ -8,6 +8,7 @@ easeagent.server.enabled=true
 easeagent.server.port=9900
 # Enable health/readiness
 easeagent.health.readiness.enabled=true
+plugin.integrability.global.healthReady.enabled=true
 # forwarded headers page
 # Pass-through headers from the root process all the way to the end
 # format: easeagent.progress.forwarded.headers={headerName}
@@ -36,6 +37,7 @@ observability.tracings.tag.response.headers.eg.1=X-EG-Retryer
 observability.tracings.tag.response.headers.eg.2=X-EG-Rate-Limiter
 observability.tracings.tag.response.headers.eg.3=X-EG-Time-Limiter
 # -------------------- plugin global config ---------------------
+plugin.observability.global.init.enabled=true
 plugin.observability.global.tracing.enabled=true
 plugin.observability.global.metric.enabled=true
 plugin.observability.global.metric.interval=30
@@ -198,7 +200,7 @@ plugin.observability.redis.metric.url=/platform-metrics
 # plugin.observability.springGateway.metric.appendType=kafka
 #
 # -------------------- request ---------------------
-## httpclient tracing：httpclient and httpclient5
+## httpclient tracing\uFF1Ahttpclient and httpclient5
 # plugin.observability.httpclient.tracing.enabled=true
 ## okHttp tracing
 # plugin.observability.okHttp.tracing.enabled=true
@@ -352,3 +354,6 @@ reporter.tracing.output.messageTimeout=1000
 ## final output url: http://127.0.0.10:9090/metric
 #reporter.metric.sender.url=/metrics
 
+## support spring boot 3.5.3: jdk17+3.5.3
+#runtime.code.version.points.jdk=jdk17
+#runtime.code.version.points.spring-boot=3.x.x

config/pom.xml

@@ -22,7 +22,7 @@
     <parent>
         <artifactId>easeagent</artifactId>
         <groupId>com.megaease.easeagent</groupId>
-        <version>2.2.9</version>
+        <version>2.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

config/src/main/java/com/megaease/easeagent/config/ConfigUtils.java

@@ -32,7 +32,8 @@
 import static com.megaease.easeagent.plugin.api.config.ConfigConst.*;
 
 public class ConfigUtils {
-    private ConfigUtils() {}
+    private ConfigUtils() {
+    }
 
     public static <R> void bindProp(String name, Config configs, BiFunction<Config, String, R> func, Consumer<R> consumer, R def) {
         Runnable process = () -> {
@@ -134,12 +135,16 @@ public static String buildPluginProperty(String domain, String namespace, String
         return String.format(PLUGIN_FORMAT, domain, namespace, id, property);
     }
 
+    public static String buildCodeVersionKey(String key) {
+        return RUNTIME_CODE_VERSION_POINTS_PREFIX + key;
+    }
+
     /**
      * extract config item with a fromPrefix to and convert the prefix to 'toPrefix' for configuration Compatibility
      *
-     * @param cfg config source map
+     * @param cfg        config source map
      * @param fromPrefix from
-     * @param toPrefix to
+     * @param toPrefix   to
      * @return Extracted and converted KV map
      */
     public static Map<String, String> extractAndConvertPrefix(Map<String, String> cfg, String fromPrefix, String toPrefix) {
@@ -162,8 +167,9 @@ public static Map<String, String> extractAndConvertPrefix(Map<String, String> cf
 
     /**
      * Extract config items from config by prefix
-     * @param config  config
-     * @param prefix  prefix
+     *
+     * @param config config
+     * @param prefix prefix
      * @return Extracted KV
      */
     public static Map<String, String> extractByPrefix(Config config, String prefix) {

context/pom.xml

@@ -22,7 +22,7 @@
     <parent>
         <artifactId>easeagent</artifactId>
         <groupId>com.megaease.easeagent</groupId>
-        <version>2.2.9</version>
+        <version>2.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

core/pom.xml

@@ -21,7 +21,7 @@
     <parent>
         <artifactId>easeagent</artifactId>
         <groupId>com.megaease.easeagent</groupId>
-        <version>2.2.9</version>
+        <version>2.3.0</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 
@@ -105,12 +105,6 @@
             <artifactId>reactor-core</artifactId>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.springframework</groupId>
-            <artifactId>spring-web</artifactId>
-            <version>${version.spring}</version>
-            <scope>test</scope>
-        </dependency>
         <dependency>
             <groupId>net.bytebuddy</groupId>
             <artifactId>byte-buddy-agent</artifactId>

core/src/main/java/com/megaease/easeagent/core/Bootstrap.java

@@ -200,7 +200,7 @@ public static AgentBuilder getAgentBuilder(Configs config, boolean test) {
             .with(AgentBuilder.LocationStrategy.ForClassLoader.STRONG
                 .withFallbackTo(ClassFileLocator.ForClassLoader.ofSystemLoader()));
         AgentBuilder.Ignored ignore = builder.ignore(isSynthetic())
-            .or(nameStartsWith("sun."))
+            .or(nameStartsWith("sun.").and(not(nameStartsWith("sun.net.www.protocol.http")) ))
             .or(nameStartsWith("com.sun."))
             .or(nameStartsWith("brave."))
             .or(nameStartsWith("zipkin2."))

core/src/main/java/com/megaease/easeagent/core/plugin/PluginLoader.java

@@ -17,20 +17,24 @@
 
 package com.megaease.easeagent.core.plugin;
 
+import com.megaease.easeagent.config.ConfigUtils;
 import com.megaease.easeagent.config.Configs;
 import com.megaease.easeagent.core.plugin.matcher.ClassTransformation;
 import com.megaease.easeagent.core.plugin.matcher.MethodTransformation;
 import com.megaease.easeagent.core.plugin.registry.PluginRegistry;
 import com.megaease.easeagent.core.plugin.transformer.CompoundPluginTransformer;
 import com.megaease.easeagent.core.plugin.transformer.DynamicFieldTransformer;
 import com.megaease.easeagent.core.plugin.transformer.ForAdviceTransformer;
+import com.megaease.easeagent.core.plugin.transformer.TypeFieldTransformer;
 import com.megaease.easeagent.log4j2.Logger;
 import com.megaease.easeagent.log4j2.LoggerFactory;
 import com.megaease.easeagent.plugin.AgentPlugin;
-import com.megaease.easeagent.plugin.interceptor.InterceptorProvider;
+import com.megaease.easeagent.plugin.CodeVersion;
 import com.megaease.easeagent.plugin.Ordered;
 import com.megaease.easeagent.plugin.Points;
 import com.megaease.easeagent.plugin.field.AgentDynamicFieldAccessor;
+import com.megaease.easeagent.plugin.interceptor.InterceptorProvider;
+import com.megaease.easeagent.plugin.utils.common.StringUtils;
 import net.bytebuddy.agent.builder.AgentBuilder;
 
 import java.util.*;
@@ -46,19 +50,27 @@ private PluginLoader() {
 
     public static AgentBuilder load(AgentBuilder ab, Configs conf) {
         pluginLoad();
+        pointsLoad(conf);
         providerLoad();
-        Set<ClassTransformation> sortedTransformations = pointsLoad();
+        Set<ClassTransformation> sortedTransformations = classTransformationLoad();
 
         for (ClassTransformation transformation : sortedTransformations) {
             ab = ab.type(transformation.getClassMatcher(), transformation.getClassloaderMatcher())
-                .transform(compound(transformation.isHasDynamicField(), transformation.getMethodTransformations()));
+                .transform(compound(transformation.isHasDynamicField(), transformation.getMethodTransformations(), transformation.getTypeFieldAccessor()));
         }
         return ab;
     }
 
     public static void providerLoad() {
         for (InterceptorProvider provider : BaseLoader.load(InterceptorProvider.class)) {
-            log.debug("loading provider:{}", provider.getClass().getName());
+            String pointsClassName = PluginRegistry.getPointsClassName(provider.getAdviceTo());
+            Points points = PluginRegistry.getPoints(pointsClassName);
+            if (points == null) {
+                log.debug("Unload provider:{}, can not found Points<{}>", provider.getClass().getName(), pointsClassName);
+                continue;
+            } else {
+                log.debug("Loading provider:{}", provider.getClass().getName());
+            }
 
             try {
                 log.debug("provider for:{} at {}",
@@ -73,14 +85,14 @@ public static void providerLoad() {
         }
     }
 
-    public static Set<ClassTransformation> pointsLoad() {
-        List<Points> points = BaseLoader.load(Points.class);
+    public static Set<ClassTransformation> classTransformationLoad() {
+        Collection<Points> points = PluginRegistry.getPoints();
         return points.stream().map(point -> {
                 try {
-                    return PluginRegistry.register(point);
+                    return PluginRegistry.registerClassTransformation(point);
                 } catch (Exception e) {
                     log.error(
-                        "Unable to load points in [class {}]",
+                        "Unable to load classTransformation in [class {}]",
                         point.getClass().getName(),
                         e);
                     return null;
@@ -111,12 +123,54 @@ public static void pluginLoad() {
         }
     }
 
+    public static void pointsLoad(Configs conf) {
+        for (Points points : BaseLoader.load(Points.class)) {
+            if (!isCodeVersion(points, conf)) {
+                continue;
+            } else {
+                log.info("Loading points [class Points<{}>]", points.getClass().getName());
+            }
+
+            try {
+                PluginRegistry.register(points);
+            } catch (Exception | LinkageError e) {
+                log.error(
+                    "Unable to load extension [class {}]",
+                    points.getClass().getName(),
+                    e);
+            }
+        }
+    }
+
+    public static boolean isCodeVersion(Points points, Configs conf) {
+        CodeVersion codeVersion = points.codeVersions();
+        if (codeVersion.isEmpty()) {
+            return true;
+        }
+        String versionKey = ConfigUtils.buildCodeVersionKey(codeVersion.getKey());
+        Set<String> versions = new HashSet<>(conf.getStringList(versionKey));
+        if (versions.isEmpty()) {
+            versions = Points.DEFAULT_VERSIONS;
+        }
+        Set<String> pointVersions = codeVersion.getVersions();
+        for (String version : versions) {
+            if (pointVersions.contains(version)) {
+                return true;
+            }
+        }
+        log.info("Unload points [class Points<{}>], the config [{}={}] is not in Points.codeVersions()=[{}:{}]",
+            points.getClass().getCanonicalName(), versionKey, String.join(",", versions),
+            codeVersion.getKey(), String.join(",", codeVersion.getVersions()));
+        return false;
+    }
+
+
     /**
      * @param methodTransformations method matchers under a special classMatcher
      * @return transform
      */
     public static AgentBuilder.Transformer compound(boolean hasDynamicField,
-                                                    Iterable<MethodTransformation> methodTransformations) {
+                                                    Iterable<MethodTransformation> methodTransformations, String typeFieldAccessor) {
         List<AgentBuilder.Transformer> agentTransformers = StreamSupport
             .stream(methodTransformations.spliterator(), false)
             .map(ForAdviceTransformer::new)
@@ -126,6 +180,10 @@ public static AgentBuilder.Transformer compound(boolean hasDynamicField,
             agentTransformers.add(new DynamicFieldTransformer(AgentDynamicFieldAccessor.DYNAMIC_FIELD_NAME));
         }
 
+        if (StringUtils.hasText(typeFieldAccessor)) {
+            agentTransformers.add(new TypeFieldTransformer(typeFieldAccessor));
+        }
+
         return new CompoundPluginTransformer(agentTransformers);
     }
 }

core/src/main/java/com/megaease/easeagent/core/plugin/matcher/ClassTransformation.java

@@ -32,14 +32,16 @@ public class ClassTransformation implements Ordered {
     private int order;
     private Junction<TypeDescription> classMatcher;
     private ElementMatcher<ClassLoader> classloaderMatcher;
-    private Set<MethodTransformation>  methodTransformations;
+    private Set<MethodTransformation> methodTransformations;
     private boolean hasDynamicField;
+    private String typeFieldAccessor;
 
     public ClassTransformation(int order,
                                ElementMatcher<ClassLoader> classloaderMatcher,
                                Junction<TypeDescription> classMatcher,
                                Set<MethodTransformation> methodTransformations,
-                               boolean hasDynamicField) {
+                               boolean hasDynamicField,
+                               String typeFieldAccessor) {
         this.order = order;
         if (classloaderMatcher == null) {
             this.classloaderMatcher = any();
@@ -49,6 +51,7 @@ public ClassTransformation(int order,
         this.classMatcher = classMatcher;
         this.methodTransformations = methodTransformations;
         this.hasDynamicField = hasDynamicField;
+        this.typeFieldAccessor = typeFieldAccessor;
     }
 
     public static Builder builder() {
@@ -67,6 +70,8 @@ public static class Builder {
         private Set<MethodTransformation> methodTransformations;
         private boolean hasDynamicField;
 
+        private String typeFieldAccessor;
+
         Builder() {
         }
 
@@ -95,9 +100,14 @@ public Builder hasDynamicField(boolean hasDynamicField) {
             return this;
         }
 
+        public Builder typeFieldAccessor(String typeFieldAccessor) {
+            this.typeFieldAccessor = typeFieldAccessor;
+            return this;
+        }
+
         public ClassTransformation build() {
             return new ClassTransformation(order, classloaderMatcher, classMatcher,
-                methodTransformations, hasDynamicField);
+                methodTransformations, hasDynamicField, typeFieldAccessor);
         }
 
         public String toString() {