feat: Add support for SOFARPC framework

.fossa.yml

@@ -277,6 +277,12 @@ targets:
     - type: gradle
       path: ./
       target: ':instrumentation:scala-fork-join-2.8:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:sofa-rpc-5.4:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:sofa-rpc-5.4:library-autoconfigure'
     - type: gradle
       path: ./
       target: ':instrumentation:spark-2.3:javaagent'

instrumentation/sofa-rpc-5.4/javaagent/build.gradle.kts

@@ -0,0 +1,67 @@
+plugins {
+  id("otel.javaagent-instrumentation")
+}
+
+muzzle {
+  pass {
+    group.set("com.alipay.sofa")
+    module.set("sofa-rpc-all")
+    versions.set("[5.4.0,)")
+    assertInverse.set(true)
+  }
+}
+
+dependencies {
+  implementation(project(":instrumentation:sofa-rpc-5.4:library-autoconfigure"))
+
+  library("com.alipay.sofa:sofa-rpc-all:5.4.0")
+}
+
+val latestDepTest = findProperty("testLatestDeps") as Boolean
+
+testing {
+  suites {
+    // using a test suite to ensure that project(":instrumentation:sofa-rpc-5.4:library-autoconfigure")
+    // is not available on test runtime class path, otherwise instrumentation from library-autoconfigure
+    // module would be used instead of the javaagent instrumentation that we want to test
+    val testSofaRpc by registering(JvmTestSuite::class) {
+      dependencies {
+        implementation(project(":instrumentation:sofa-rpc-5.4:testing"))
+        if (latestDepTest) {
+          implementation("com.alipay.sofa:sofa-rpc-all:latest.release")
+        } else {
+          implementation("com.alipay.sofa:sofa-rpc-all:5.4.0")
+        }
+        runtimeOnly("ch.qos.logback:logback-classic:1.2.13")
+        runtimeOnly("ch.qos.logback:logback-core:1.2.13")
+        runtimeOnly("org.slf4j:slf4j-api:1.7.21")
+      }
+    }
+  }
+}
+
+tasks.withType<Test>().configureEach {
+  systemProperty("testLatestDeps", findProperty("testLatestDeps") as Boolean)
+  jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+  // to suppress non-fatal errors on jdk17
+  jvmArgs("--add-opens=java.base/java.math=ALL-UNNAMED")
+  // required on jdk17
+  jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
+
+  systemProperty("collectMetadata", findProperty("collectMetadata")?.toString() ?: "false")
+}
+
+tasks {
+  check {
+    dependsOn(testing.suites)
+  }
+}
+
+configurations.named("testSofaRpcRuntimeClasspath") {
+  resolutionStrategy {
+    // requires old logback (and therefore also old slf4j)
+    force("ch.qos.logback:logback-classic:1.2.13")
+    force("ch.qos.logback:logback-core:1.2.13")
+    force("org.slf4j:slf4j-api:1.7.21")
+  }
+}

instrumentation/sofa-rpc-5.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/OpenTelemetryClientFilter.java

@@ -0,0 +1,41 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4;
+
+import com.alipay.sofa.rpc.config.ConsumerConfig;
+import com.alipay.sofa.rpc.core.exception.SofaRpcException;
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import com.alipay.sofa.rpc.ext.Extension;
+import com.alipay.sofa.rpc.filter.AutoActive;
+import com.alipay.sofa.rpc.filter.Filter;
+import com.alipay.sofa.rpc.filter.FilterInvoker;
+
+@Extension(value = "openTelemetryClient", order = -25000)
+@AutoActive(consumerSide = true)
+public final class OpenTelemetryClientFilter extends Filter {
+
+  private final Filter delegate;
+
+  public OpenTelemetryClientFilter() {
+    delegate = SofaRpcSingletons.CLIENT_FILTER;
+  }
+
+  @Override
+  @SuppressWarnings("ThrowsUncheckedException")
+  public SofaResponse invoke(FilterInvoker invoker, SofaRequest request) throws SofaRpcException {
+    return delegate.invoke(invoker, request);
+  }
+
+  @Override
+  // Suppress rawtypes warning: SOFARPC Filter interface uses raw ConsumerConfig type
+  @SuppressWarnings({"rawtypes", "ThrowsUncheckedException"})
+  public void onAsyncResponse(
+      ConsumerConfig config, SofaRequest request, SofaResponse response, Throwable exception)
+      throws SofaRpcException {
+    delegate.onAsyncResponse(config, request, response, exception);
+  }
+}

instrumentation/sofa-rpc-5.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/OpenTelemetryServerFilter.java

@@ -0,0 +1,31 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4;
+
+import com.alipay.sofa.rpc.core.exception.SofaRpcException;
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import com.alipay.sofa.rpc.ext.Extension;
+import com.alipay.sofa.rpc.filter.AutoActive;
+import com.alipay.sofa.rpc.filter.Filter;
+import com.alipay.sofa.rpc.filter.FilterInvoker;
+
+@Extension(value = "openTelemetryServer", order = -25000)
+@AutoActive(providerSide = true)
+public final class OpenTelemetryServerFilter extends Filter {
+
+  private final Filter delegate;
+
+  public OpenTelemetryServerFilter() {
+    delegate = SofaRpcSingletons.SERVER_FILTER;
+  }
+
+  @Override
+  @SuppressWarnings("ThrowsUncheckedException")
+  public SofaResponse invoke(FilterInvoker invoker, SofaRequest request) throws SofaRpcException {
+    return delegate.invoke(invoker, request);
+  }
+}

instrumentation/sofa-rpc-5.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcInstrumentationModule.java

@@ -0,0 +1,72 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4;
+
+import static io.opentelemetry.javaagent.extension.matcher.AgentElementMatchers.hasClassesNamed;
+import static java.util.Collections.singletonList;
+import static net.bytebuddy.matcher.ElementMatchers.named;
+
+import com.google.auto.service.AutoService;
+import io.opentelemetry.javaagent.extension.instrumentation.HelperResourceBuilder;
+import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation;
+import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer;
+import io.opentelemetry.javaagent.extension.instrumentation.internal.ExperimentalInstrumentationModule;
+import io.opentelemetry.javaagent.extension.instrumentation.internal.injection.ClassInjector;
+import io.opentelemetry.javaagent.extension.instrumentation.internal.injection.InjectionMode;
+import java.util.List;
+import net.bytebuddy.description.type.TypeDescription;
+import net.bytebuddy.matcher.ElementMatcher;
+
+@AutoService(InstrumentationModule.class)
+public class SofaRpcInstrumentationModule extends InstrumentationModule
+    implements ExperimentalInstrumentationModule {
+  public SofaRpcInstrumentationModule() {
+    super("sofa-rpc", "sofa-rpc-5.4");
+  }
+
+  @Override
+  public void registerHelperResources(HelperResourceBuilder helperResourceBuilder) {
+    helperResourceBuilder.register(
+        "META-INF/services/com.alipay.sofa.rpc.filter.Filter",
+        "sofa-rpc-5.4/META-INF/com.alipay.sofa.rpc.filter.Filter");
+  }
+
+  @Override
+  public ElementMatcher.Junction<ClassLoader> classLoaderMatcher() {
+    return hasClassesNamed("com.alipay.sofa.rpc.filter.Filter");
+  }
+
+  @Override
+  public void injectClasses(ClassInjector injector) {
+    injector
+        .proxyBuilder(
+            "io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4.OpenTelemetryClientFilter")
+        .inject(InjectionMode.CLASS_ONLY);
+    injector
+        .proxyBuilder(
+            "io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4.OpenTelemetryServerFilter")
+        .inject(InjectionMode.CLASS_ONLY);
+  }
+
+  @Override
+  public List<TypeInstrumentation> typeInstrumentations() {
+    return singletonList(new ResourceInjectingTypeInstrumentation());
+  }
+
+  // A type instrumentation is needed to trigger resource injection.
+  public static class ResourceInjectingTypeInstrumentation implements TypeInstrumentation {
+    @Override
+    public ElementMatcher<TypeDescription> typeMatcher() {
+      return named("com.alipay.sofa.rpc.ext.ExtensionLoader");
+    }
+
+    @Override
+    public void transform(TypeTransformer transformer) {
+      // Nothing to transform, this type instrumentation is only used for injecting resources.
+    }
+  }
+}

instrumentation/sofa-rpc-5.4/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcSingletons.java

@@ -0,0 +1,32 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4;
+
+import com.alipay.sofa.rpc.filter.Filter;
+import io.opentelemetry.api.GlobalOpenTelemetry;
+import io.opentelemetry.instrumentation.api.incubator.semconv.net.PeerServiceAttributesExtractor;
+import io.opentelemetry.instrumentation.sofarpc.v5_4.SofaRpcTelemetry;
+import io.opentelemetry.instrumentation.sofarpc.v5_4.internal.SofaRpcClientNetworkAttributesGetter;
+import io.opentelemetry.javaagent.bootstrap.internal.AgentCommonConfig;
+
+public final class SofaRpcSingletons {
+  public static final Filter CLIENT_FILTER;
+  public static final Filter SERVER_FILTER;
+
+  static {
+    SofaRpcTelemetry telemetry =
+        SofaRpcTelemetry.builder(GlobalOpenTelemetry.get())
+            .addAttributesExtractor(
+                PeerServiceAttributesExtractor.create(
+                    new SofaRpcClientNetworkAttributesGetter(),
+                    AgentCommonConfig.get().getPeerServiceResolver()))
+            .build();
+    CLIENT_FILTER = telemetry.newClientFilter();
+    SERVER_FILTER = telemetry.newServerFilter();
+  }
+
+  private SofaRpcSingletons() {}
+}

instrumentation/sofa-rpc-5.4/javaagent/src/main/resources/sofa-rpc-5.4/META-INF/com.alipay.sofa.rpc.filter.Filter

@@ -0,0 +1,3 @@
+io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4.OpenTelemetryClientFilter
+io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4.OpenTelemetryServerFilter
+

instrumentation/sofa-rpc-5.4/javaagent/src/testSofaRpc/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcAgentTest.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4;
+
+import io.opentelemetry.instrumentation.sofarpc.v5_4.AbstractSofaRpcTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class SofaRpcAgentTest extends AbstractSofaRpcTest {
+
+  @RegisterExtension
+  static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+
+  @Override
+  protected boolean hasPeerService() {
+    return true;
+  }
+}

instrumentation/sofa-rpc-5.4/javaagent/src/testSofaRpc/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcAgentTraceChainTest.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4;
+
+import io.opentelemetry.instrumentation.sofarpc.v5_4.AbstractSofaRpcTraceChainTest;
+import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension;
+import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
+import org.junit.jupiter.api.extension.RegisterExtension;
+
+class SofaRpcAgentTraceChainTest extends AbstractSofaRpcTraceChainTest {
+
+  @RegisterExtension
+  static final InstrumentationExtension testing = AgentInstrumentationExtension.create();
+
+  @Override
+  protected InstrumentationExtension testing() {
+    return testing;
+  }
+
+  @Override
+  protected boolean hasPeerService() {
+    return true;
+  }
+}

instrumentation/sofa-rpc-5.4/library-autoconfigure/build.gradle.kts

@@ -0,0 +1,30 @@
+plugins {
+  id("otel.library-instrumentation")
+}
+
+dependencies {
+  compileOnly("com.google.auto.value:auto-value-annotations")
+  annotationProcessor("com.google.auto.value:auto-value")
+
+  // 5.4.0 is the recommended minimum version for production use
+  library("com.alipay.sofa:sofa-rpc-all:5.4.0")
+
+  testImplementation(project(":instrumentation:sofa-rpc-5.4:testing"))
+}
+
+configurations.testRuntimeClasspath {
+  resolutionStrategy {
+    // requires old logback (and therefore also old slf4j)
+    force("ch.qos.logback:logback-classic:1.2.13")
+    force("ch.qos.logback:logback-core:1.2.13")
+    force("org.slf4j:slf4j-api:1.7.21")
+  }
+}
+
+tasks.withType<Test>().configureEach {
+  jvmArgs("-XX:+IgnoreUnrecognizedVMOptions")
+  // to suppress non-fatal errors on jdk17
+  jvmArgs("--add-opens=java.base/java.math=ALL-UNNAMED")
+  // required on jdk17
+  jvmArgs("--add-opens=java.base/java.lang=ALL-UNNAMED")
+}

instrumentation/sofa-rpc-5.4/library-autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/OpenTelemetryClientFilter.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+package io.opentelemetry.instrumentation.sofarpc.v5_4;
+
+import com.alipay.sofa.rpc.config.ConsumerConfig;
+import com.alipay.sofa.rpc.core.exception.SofaRpcException;
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import com.alipay.sofa.rpc.ext.Extension;
+import com.alipay.sofa.rpc.filter.AutoActive;
+import com.alipay.sofa.rpc.filter.Filter;
+import com.alipay.sofa.rpc.filter.FilterInvoker;
+import io.opentelemetry.api.GlobalOpenTelemetry;
+
+@Extension(value = "openTelemetryClient", order = -25000)
+@AutoActive(consumerSide = true)
+public final class OpenTelemetryClientFilter extends Filter {
+
+  private final Filter delegate;
+
+  public OpenTelemetryClientFilter() {
+    delegate = SofaRpcTelemetry.create(GlobalOpenTelemetry.get()).newClientFilter();
+  }
+
+  @Override
+  @SuppressWarnings("ThrowsUncheckedException")
+  public SofaResponse invoke(FilterInvoker invoker, SofaRequest request) throws SofaRpcException {
+    return delegate.invoke(invoker, request);
+  }
+
+  @Override
+  // Suppress rawtypes warning: SOFARPC Filter interface uses raw ConsumerConfig type
+  @SuppressWarnings({"rawtypes", "ThrowsUncheckedException"})
+  public void onAsyncResponse(
+      ConsumerConfig config, SofaRequest request, SofaResponse response, Throwable exception)
+      throws SofaRpcException {
+    delegate.onAsyncResponse(config, request, response, exception);
+  }
+}