Add Sofa RPC instrumentation (Bolt, H2C, REST, Triple) (#11135)

# What Does This Do
Adds auto-instrumentation for [Sofa RPC](https://github.com/sofastack/sofa-rpc), a high-perfomance RPC framework. Produces `sofarpc.request` client and server spans with distributed trace propagation for all four supported transports: Bolt, H2C, REST and Triple(gRPC)

# Motivation
Sofa RPC is widely used in Ant Financial's ecosystem and it's not covered by any existing dd-trace-java integration. WIthout this instrumentaiton, traces break at the service boundary - downstream PRC calls are unlinked from traces

# Additional Notes
## Module structure
A single module `sofarpc-5.0` covers all protocols and all public version of sofa-rpc. The framework was open-sources at 5.0.0; no earlier versions exists in public repositories

## How server spans are coordinated
`ProviderProxyInvoker.invoke()` is a single entry point for all protocols on the server side - but it has noo info about the transport delivered the request. Transport specific instrumentations write the protocol name into ThreadLocal (`SofaRpcProtocolContext`) before `invoke()` is called.
`ProviderProxuInvokerInstrumentaiton` reads it to created the span and tag with the protocol. If the ThreadLocal is empty (uninstrumented transport), no span is created.

## Trace propagation by protocol
**Bolt** and **H2C** - context travels inside SofaRequest.requestProps (the framework's own key-value bag)
<img width="1425" height="212" alt="image" src="https://github.com/user-attachments/assets/bee9f416-7ed7-4342-88fa-65dffd695cce" />

**REST** - `SofaRequest.requestProps` is not serialized as HTTP headers by the REST transport. Context instead travels as standard HTTP headers, injected and extracted by HTTP layer (Apache HttpClient on the client side, Netty on the server side). The `RestServerHandlerInstumentation` sets the protocol context so that `ProviderProxyInvoketInstrumentation` activated and creates a `sofarpc.request[server] span that naturally attaches to the active `netty.request` span
<img width="1425" height="360" alt="image" src="https://github.com/user-attachments/assets/7e720a87-18a4-484e-a9ce-8c5db6ce59e2" />

**Triple** - uses gRPC unses the hood. The [grpc-1.5](https://github.com/DataDog/dd-trace-java/tree/master/dd-java-agent/instrumentation/grpc-1.5) instrumentation handles trace propagation via gRPC Metadata. The `TripleServerInstrumentation` sets `protocol="tri"` so that `ProviderProxyInvokerInstrumentaiton` creates a `sofarpc.request[server]` span with child of the active `grpc.server`span
<img width="1429" height="357" alt="image" src="https://github.com/user-attachments/assets/05d6a88a-c75a-4414-bbd1-b9d0580fa682" />

## Span attributes
Tag|Value
---|---
sofarpc.protocol|bolt / h2c / rest / tri
rpc.system|sofarpc
rpc.service|e.g. com.example.HelloServier:1.0
rpc.method|e.g. sayHello
span.kind|client / server
component|sofarpc-client / sofarpc-server
peer.service|derived from rpc.servier

Resource name format: `{rpc.service}/{rpc.method}` (e.g. `com.example.HelloService:1.0/sayHello`)

## Known limitations
- **REST server**: `SofaRequest.getTaargetServiceUniqueName()` returns null on the server side - the service name is not propagated thought the JAX-RS layer.
- H2C: `getTargetServiceUniquieName() does not include the version suffix (e.g. HelloService/sayHello). THis is Sofa RPC behaviour for the H2C transport

# Contributor Checklist

- Format the title according to [the contribution guidelines](https://github.com/DataDog/dd-trace-java/blob/master/CONTRIBUTING.md#title-format)
- Assign the `type:` and (`comp:` or `inst:`) labels in addition to [any other useful labels](https://github.com/DataDog/dd-trace-java/blob/master/CONTRIBUTING.md#labels)
- Avoid using `close`, `fix`, or [any linking keywords](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) when referencing an issue  
  Use `solves` instead, and assign the PR [milestone](https://github.com/DataDog/dd-trace-java/milestones) to the issue
- Update the [CODEOWNERS](https://github.com/DataDog/dd-trace-java/blob/master/.github/CODEOWNERS) file on source file addition, migration, or deletion
- Update [public documentation](https://docs.datadoghq.com/tracing/trace_collection/library_config/java/) with any new configuration flags or behaviors

Jira ticket: [PROJ-IDENT]

***Note:*** **Once your PR is ready to merge, add it to the merge queue by commenting `/merge`.** `/merge -c` cancels the queue request. `/merge -f --reason "reason"` skips all merge queue checks; please use this judiciously, as some checks do not run at the PR-level. For more information, see [this doc](https://datadoghq.atlassian.net/wiki/spaces/DEVX/pages/3121612126/MergeQueue).

<!--
# Opening vs Drafting a PR:
When opening a pull request, please open it as a draft to not auto assign reviewers before you feel the pull request is in a reviewable state.

# Linking a JIRA ticket:
Please link your JIRA ticket by adding its identifier between brackets (ex [PROJ-IDENT]) in the PR description, not the title.
This requirement only applies to Datadog employees.
-->


Co-authored-by: valentin.zakharov <valentin.zakharov@datadoghq.com>

Author: ValentinZakharov

.github/g2j-migrated-modules.txt

@@ -7,4 +7,5 @@
 
 buildSrc/call-site-instrumentation-plugin
 components/json
+dd-java-agent/instrumentation/sofarpc/sofarpc-5.0
 dd-trace-api

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/build.gradle

@@ -0,0 +1,35 @@
+muzzle {
+  pass {
+    group = "com.alipay.sofa"
+    module = "sofa-rpc-all"
+    versions = "[5.0.0,)"
+    assertInverse = true
+  }
+}
+
+apply from: "$rootDir/gradle/java.gradle"
+
+addTestSuiteForDir('latestDepTest', 'test')
+
+configurations.testRuntimeClasspath {
+  resolutionStrategy.force "com.google.guava:guava:32.1.3-jre"
+}
+
+dependencies {
+  compileOnly group: "com.alipay.sofa", name: "sofa-rpc-all", version: "5.6.0"
+
+  testImplementation group: "com.alipay.sofa", name: "sofa-rpc-all", version: "5.14.2"
+  // JAX-RS annotations required for the REST protocol test interface (@Path, @GET, etc.)
+  testImplementation group: "javax.ws.rs", name: "javax.ws.rs-api", version: "2.1.1"
+  // Required so that GrpcServerModule / GrpcClientModule are discovered via ServiceLoader
+  // in SofaRpcTripleWithGrpcForkedTest.
+  testImplementation project(':dd-java-agent:instrumentation:grpc-1.5')
+  testImplementation group: "io.grpc", name: "grpc-netty", version: "1.53.0"
+  testImplementation group: "io.grpc", name: "grpc-core", version: "1.53.0"
+  testImplementation group: "io.grpc", name: "grpc-stub", version: "1.53.0"
+  testImplementation group: "com.google.protobuf", name: "protobuf-java", version: "3.25.3"
+  testImplementation group: "com.alibaba", name: "fastjson", version: "1.2.83"
+  testImplementation group: "com.google.guava", name: "guava", version: "32.1.3-jre"
+
+  latestDepTestImplementation group: "com.alipay.sofa", name: "sofa-rpc-all", version: "+"
+}

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/gradle.lockfile

@@ -0,0 +1,74 @@
+package datadog.trace.instrumentation.sofarpc;
+
+import static datadog.context.propagation.Propagators.defaultPropagator;
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan;
+import static datadog.trace.instrumentation.sofarpc.SofaRpcClientDecorator.DECORATE;
+import static datadog.trace.instrumentation.sofarpc.SofaRpcClientDecorator.SOFA_RPC_CLIENT;
+import static datadog.trace.instrumentation.sofarpc.SofaRpcInjectAdapter.SETTER;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import com.alipay.sofa.rpc.client.AbstractCluster;
+import com.alipay.sofa.rpc.config.ConsumerConfig;
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import datadog.trace.agent.tooling.Instrumenter;
+import datadog.trace.bootstrap.instrumentation.api.AgentScope;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import net.bytebuddy.asm.Advice;
+
+public class AbstractClusterInstrumentation
+    implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
+
+  @Override
+  public String instrumentedType() {
+    return "com.alipay.sofa.rpc.client.AbstractCluster";
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        isMethod()
+            .and(named("invoke"))
+            .and(takesArguments(1))
+            .and(takesArgument(0, named("com.alipay.sofa.rpc.core.request.SofaRequest"))),
+        getClass().getName() + "$InvokeAdvice");
+  }
+
+  public static class InvokeAdvice {
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static AgentScope enter(
+        @Advice.This AbstractCluster self, @Advice.Argument(0) SofaRequest request) {
+      ConsumerConfig config = self.getConsumerConfig();
+      String protocol = config != null ? config.getProtocol() : null;
+      AgentSpan span = startSpan(SOFA_RPC_CLIENT);
+      DECORATE.afterStart(span);
+      DECORATE.onRequest(span, request);
+      if (protocol != null) {
+        span.setTag("sofarpc.protocol", protocol);
+      }
+      AgentScope scope = activateSpan(span);
+      defaultPropagator().inject(span, request, SETTER);
+      return scope;
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void exit(
+        @Advice.Enter AgentScope scope,
+        @Advice.Return SofaResponse response,
+        @Advice.Thrown Throwable throwable) {
+      if (scope == null) {
+        return;
+      }
+      AgentSpan span = scope.span();
+      DECORATE.onResponse(span, response);
+      DECORATE.onError(span, throwable);
+      DECORATE.beforeFinish(span);
+      scope.close();
+      span.finish();
+    }
+  }
+}

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/src/main/java/datadog/trace/instrumentation/sofarpc/AbstractClusterInstrumentation.java

@@ -0,0 +1,40 @@
+package datadog.trace.instrumentation.sofarpc;
+
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import datadog.trace.agent.tooling.Instrumenter;
+import net.bytebuddy.asm.Advice;
+
+public class BoltServerProcessorInstrumentation
+    implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
+
+  @Override
+  public String instrumentedType() {
+    return "com.alipay.sofa.rpc.server.bolt.BoltServerProcessor";
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        isMethod()
+            .and(named("handleRequest"))
+            .and(takesArguments(3))
+            .and(takesArgument(2, named("com.alipay.sofa.rpc.core.request.SofaRequest"))),
+        getClass().getName() + "$HandleRequestAdvice");
+  }
+
+  public static class HandleRequestAdvice {
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void enter() {
+      SofaRpcProtocolContext.set("bolt");
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void exit() {
+      SofaRpcProtocolContext.clear();
+    }
+  }
+}

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/src/main/java/datadog/trace/instrumentation/sofarpc/BoltServerProcessorInstrumentation.java

@@ -0,0 +1,35 @@
+package datadog.trace.instrumentation.sofarpc;
+
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.takesNoArguments;
+
+import datadog.trace.agent.tooling.Instrumenter;
+import net.bytebuddy.asm.Advice;
+
+public class H2cServerTaskInstrumentation
+    implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
+
+  @Override
+  public String instrumentedType() {
+    return "com.alipay.sofa.rpc.server.http.AbstractHttpServerTask";
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        isMethod().and(named("run")).and(takesNoArguments()), getClass().getName() + "$RunAdvice");
+  }
+
+  public static class RunAdvice {
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void enter() {
+      SofaRpcProtocolContext.set("h2c");
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void exit() {
+      SofaRpcProtocolContext.clear();
+    }
+  }
+}

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/src/main/java/datadog/trace/instrumentation/sofarpc/H2cServerTaskInstrumentation.java

@@ -0,0 +1,80 @@
+package datadog.trace.instrumentation.sofarpc;
+
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+import static datadog.trace.bootstrap.instrumentation.api.AgentPropagation.extractContextAndGetSpanContext;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.activateSpan;
+import static datadog.trace.bootstrap.instrumentation.api.AgentTracer.startSpan;
+import static datadog.trace.instrumentation.sofarpc.SofaRpcExtractAdapter.GETTER;
+import static datadog.trace.instrumentation.sofarpc.SofaRpcServerDecorator.DECORATE;
+import static datadog.trace.instrumentation.sofarpc.SofaRpcServerDecorator.SOFA_RPC_SERVER;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.takesArgument;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import datadog.trace.agent.tooling.Instrumenter;
+import datadog.trace.bootstrap.instrumentation.api.AgentScope;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpanContext;
+import net.bytebuddy.asm.Advice;
+
+public class ProviderProxyInvokerInstrumentation
+    implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
+
+  @Override
+  public String instrumentedType() {
+    return "com.alipay.sofa.rpc.server.ProviderProxyInvoker";
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        isMethod()
+            .and(named("invoke"))
+            .and(takesArguments(1))
+            .and(takesArgument(0, named("com.alipay.sofa.rpc.core.request.SofaRequest"))),
+        getClass().getName() + "$InvokeAdvice");
+  }
+
+  public static class InvokeAdvice {
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static AgentScope enter(@Advice.Argument(0) SofaRequest request) {
+      // Protocol is set in thread-local by transport-specific instrumentation before this call.
+      // If null, the transport is not instrumented — skip.
+      String protocol = SofaRpcProtocolContext.get();
+      if (protocol == null) {
+        return null;
+      }
+      // For Bolt and H2C the client injects trace context into SofaRequest.requestProps;
+      // extract it here. For Triple, parentContext will be null and startSpan() without an
+      // explicit parent naturally attaches to the active grpc.server span. For REST,
+      // parentContext will also be null and the active netty.request span becomes the parent.
+      AgentSpanContext parentContext = extractContextAndGetSpanContext(request, GETTER);
+      AgentSpan span =
+          parentContext != null
+              ? startSpan(SOFA_RPC_SERVER, parentContext)
+              : startSpan(SOFA_RPC_SERVER);
+      DECORATE.afterStart(span);
+      DECORATE.onRequest(span, request);
+      span.setTag("sofarpc.protocol", protocol);
+      return activateSpan(span);
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void exit(
+        @Advice.Enter AgentScope scope,
+        @Advice.Return SofaResponse response,
+        @Advice.Thrown Throwable throwable) {
+      if (scope == null) {
+        return;
+      }
+      AgentSpan span = scope.span();
+      DECORATE.onResponse(span, response);
+      DECORATE.onError(span, throwable);
+      DECORATE.beforeFinish(span);
+      scope.close();
+      span.finish();
+    }
+  }
+}

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/src/main/java/datadog/trace/instrumentation/sofarpc/ProviderProxyInvokerInstrumentation.java

@@ -0,0 +1,36 @@
+package datadog.trace.instrumentation.sofarpc;
+
+import static datadog.trace.agent.tooling.bytebuddy.matcher.NameMatchers.named;
+import static net.bytebuddy.matcher.ElementMatchers.isMethod;
+import static net.bytebuddy.matcher.ElementMatchers.takesArguments;
+
+import datadog.trace.agent.tooling.Instrumenter;
+import net.bytebuddy.asm.Advice;
+
+public class RestServerHandlerInstrumentation
+    implements Instrumenter.ForSingleType, Instrumenter.HasMethodAdvice {
+
+  @Override
+  public String instrumentedType() {
+    return "com.alipay.sofa.rpc.server.rest.SofaRestRequestHandler";
+  }
+
+  @Override
+  public void methodAdvice(MethodTransformer transformer) {
+    transformer.applyAdvice(
+        isMethod().and(named("channelRead0")).and(takesArguments(2)),
+        getClass().getName() + "$ChannelRead0Advice");
+  }
+
+  public static class ChannelRead0Advice {
+    @Advice.OnMethodEnter(suppress = Throwable.class)
+    public static void enter() {
+      SofaRpcProtocolContext.set("rest");
+    }
+
+    @Advice.OnMethodExit(onThrowable = Throwable.class, suppress = Throwable.class)
+    public static void exit() {
+      SofaRpcProtocolContext.clear();
+    }
+  }
+}

dd-java-agent/instrumentation/sofarpc/sofarpc-5.0/src/main/java/datadog/trace/instrumentation/sofarpc/RestServerHandlerInstrumentation.java

@@ -0,0 +1,67 @@
+package datadog.trace.instrumentation.sofarpc;
+
+import com.alipay.sofa.rpc.core.request.SofaRequest;
+import com.alipay.sofa.rpc.core.response.SofaResponse;
+import datadog.trace.api.naming.SpanNaming;
+import datadog.trace.bootstrap.instrumentation.api.AgentSpan;
+import datadog.trace.bootstrap.instrumentation.api.InternalSpanTypes;
+import datadog.trace.bootstrap.instrumentation.api.Tags;
+import datadog.trace.bootstrap.instrumentation.api.UTF8BytesString;
+import datadog.trace.bootstrap.instrumentation.decorator.ClientDecorator;
+
+public class SofaRpcClientDecorator extends ClientDecorator {
+
+  public static final CharSequence SOFA_RPC_CLIENT =
+      UTF8BytesString.create(
+          SpanNaming.instance().namingSchema().client().operationForProtocol("sofarpc"));
+
+  private static final CharSequence COMPONENT_NAME = UTF8BytesString.create("sofarpc-client");
+
+  public static final SofaRpcClientDecorator DECORATE = new SofaRpcClientDecorator();
+
+  @Override
+  protected String[] instrumentationNames() {
+    return new String[] {"sofarpc"};
+  }
+
+  @Override
+  protected CharSequence component() {
+    return COMPONENT_NAME;
+  }
+
+  @Override
+  protected CharSequence spanType() {
+    return InternalSpanTypes.RPC;
+  }
+
+  @Override
+  protected String service() {
+    return null;
+  }
+
+  public AgentSpan onRequest(AgentSpan span, SofaRequest request) {
+    span.setTag("rpc.system", "sofarpc");
+    if (request == null) {
+      return span;
+    }
+    String serviceName = request.getTargetServiceUniqueName();
+    String methodName = request.getMethodName();
+    span.setTag(Tags.RPC_SERVICE, serviceName);
+    span.setTag("rpc.method", methodName);
+    // peer.service is derived automatically by PeerServiceCalculator from rpc.service.
+    if (serviceName != null && methodName != null) {
+      span.setResourceName(serviceName + "/" + methodName);
+    } else if (methodName != null) {
+      span.setResourceName(methodName);
+    }
+    return span;
+  }
+
+  public AgentSpan onResponse(AgentSpan span, SofaResponse response) {
+    if (response != null && response.isError()) {
+      span.setError(true);
+      span.setTag("error.message", response.getErrorMsg());
+    }
+    return span;
+  }
+}