feat: Add support for SOFARPC framework #15589

fangxiu-wf · 2025-12-10T03:42:21Z

This PR adds instrumentation support for SOFARPC framework, including:

Javaagent instrumentation module
Library autoconfigure module
Testing utilities and test cases
Support for SOFARPC 5.4.0+

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0 through 5.12.0+ Fixes open-telemetry#15496

linux-foundation-easycla · 2025-12-10T03:42:29Z

The committers listed above are authorized under a signed CLA.

✅ login: fangxiu-wf / name: fangxiu-wf (5d2c68a)

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

...main/java/io/opentelemetry/javaagent/instrumentation/sofa/rpc/OpenTelemetryClientFilter.java

...n/java/io/opentelemetry/javaagent/instrumentation/sofa/rpc/SofaRpcInstrumentationModule.java

...io/opentelemetry/instrumentation/sofa/rpc/internal/SofaRpcClientNetworkAttributesGetter.java

...nfigure/src/main/java/io/opentelemetry/instrumentation/sofa/rpc/SofaRpcAttributesGetter.java

...ain/java/io/opentelemetry/instrumentation/sofa/rpc/SofaRpcNetworkServerAttributesGetter.java

...nfigure/src/main/java/io/opentelemetry/instrumentation/sofa/rpc/SofaRpcTelemetryBuilder.java

Copilot

Pull request overview

This PR adds comprehensive instrumentation support for the SOFARPC framework, enabling distributed tracing for RPC calls. The implementation includes both javaagent-based auto-instrumentation and library-based manual instrumentation approaches, with full support for synchronous, asynchronous, and generic invocations.

Key changes:

Adds javaagent instrumentation module with automatic filter injection via SPI
Adds library autoconfigure module with manual instrumentation API
Implements comprehensive test coverage including chain tracing, error handling, async calls, and local call detection
Supports SOFARPC versions 5.4.0 through 5.12.0+

Reviewed changes

Copilot reviewed 36 out of 36 changed files in this pull request and generated 11 comments.

Show a summary per file

File	Description
settings.gradle.kts	Adds three new subprojects for SOFARPC instrumentation (javaagent, library-autoconfigure, testing)
instrumentation/sofa-rpc/metadata.yaml	Defines instrumentation metadata including supported versions, semantic conventions, and configuration options
instrumentation/sofa-rpc/testing/build.gradle.kts	Configures test dependencies and runtime classpath with SOFARPC 5.4.0 and compatible logging dependencies
instrumentation/sofa-rpc/testing/src/main/java/.../api/*	Defines test service interfaces (HelloService, MiddleService, ErrorService) for testing RPC scenarios
instrumentation/sofa-rpc/testing/src/main/java/.../impl/*	Implements test services including error handling, chaining, and timeout scenarios
instrumentation/sofa-rpc/testing/src/main/java/.../AbstractSofaRpcTest.java	Provides base test class for synchronous, asynchronous, and error handling test scenarios
instrumentation/sofa-rpc/testing/src/main/java/.../AbstractSofaRpcTraceChainTest.java	Tests trace propagation through chained RPC calls and local call filtering
instrumentation/sofa-rpc/library-autoconfigure/src/main/java/.../*	Core library instrumentation including telemetry builder, filters, attribute extractors, and context propagation
instrumentation/sofa-rpc/library-autoconfigure/src/test/java/.../*	Library instrumentation tests extending abstract test classes
instrumentation/sofa-rpc/library-autoconfigure/build.gradle.kts	Configures library dependencies with SOFARPC 5.4.0 and AutoValue for code generation
instrumentation/sofa-rpc/library-autoconfigure/src/main/resources/META-INF/services/*	SPI configuration for auto-registering OpenTelemetry filters with SOFARPC
instrumentation/sofa-rpc/javaagent/src/main/java/.../*	Javaagent instrumentation module with resource injection and filter delegation
instrumentation/sofa-rpc/javaagent/src/testSofaRpc/java/.../*	Javaagent-specific tests with peer service attribute support
instrumentation/sofa-rpc/javaagent/build.gradle.kts	Configures javaagent build with muzzle checks for version 5.0.0+ and test suites
instrumentation/sofa-rpc/javaagent/src/main/resources/*	SPI configuration for javaagent filter registration

...ure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/SofaRpcTelemetryBuilder.java

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java

...ary-autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofa/rpc/TracingFilter.java

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java

instrumentation/sofa-rpc-5.4/metadata.yaml

...c/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTraceChainTest.java

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java

...testing/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTest.java

...fa-rpc/testing/src/main/java/io/opentelemetry/instrumentation/sofa/rpc/api/ErrorService.java

...testing/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTest.java

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0 through 5.12.0+ Fixes open-telemetry#15496

…va/io/opentelemetry/instrumentation/sofarpc/v5_4/SofaRpcTelemetryBuilder.java Co-authored-by: Copilot <[email protected]>

Co-authored-by: Copilot <[email protected]>

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

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

instrumentation/sofa-rpc-5.4/metadata.yaml

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0 through 5.12.0+ Fixes open-telemetry#15496

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java

docs/supported-libraries.md

settings.gradle.kts

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

jaydeluca · 2025-12-19T10:55:44Z

docs/supported-libraries.md

 | [RxJava](https://github.com/ReactiveX/RxJava)                                                                                               | 1.0+                               | [opentelemetry-rxjava-1.0](../instrumentation/rxjava/rxjava-1.0/library),<br>[opentelemetry-rxjava-2.0](../instrumentation/rxjava/rxjava-2.0/library),<br>[opentelemetry-rxjava-3.0](../instrumentation/rxjava/rxjava-3.0/library),<br>[opentelemetry-rxjava-3.1.1](../instrumentation/rxjava/rxjava-3.1.1/library)                                                                     | Context propagation                                                                                                                               |
 | [Scala ForkJoinPool](https://www.scala-lang.org/api/2.12.0/scala/concurrent/forkjoin/package$$ForkJoinPool$.html)                           | 2.8+                               | N/A                                                                                                                                                                                                                                                                                                                                                                                     | Context propagation                                                                                                                               |
 | [Servlet](https://javaee.github.io/javaee-spec/javadocs/javax/servlet/package-summary.html)                                                 | 2.2+                               | [opentelemetry-servlet-3.0](../instrumentation/servlet/servlet-3.0/library)                                                                                                                                                                                                                                                                                                             | [HTTP Server Spans], [HTTP Server Metrics]                                                                                                        |
+| [SOFARPC](https://github.com/sofastack/sofa-rpc/)                                                                                           | 5.4.0+                             | [opentelemetry-sofa-rpc-5.4](../instrumentation/sofa-rpc-5.4/library-autoconfigure)                                                                                                                                                                                                                                                                                                     | [RPC Client Spans], [RPC Server Spans]                                                                                                            |


Suggested change

| [SOFARPC](https://github.com/sofastack/sofa-rpc/) | 5.4.0+ | [opentelemetry-sofa-rpc-5.4](../instrumentation/sofa-rpc-5.4/library-autoconfigure) | [RPC Client Spans], [RPC Server Spans] |

| [SOFARPC](https://github.com/sofastack/sofa-rpc/) | 5.4+ | [opentelemetry-sofa-rpc-5.4](../instrumentation/sofa-rpc-5.4/library-autoconfigure) | [RPC Client Spans], [RPC Client Metrics], [RPC Server Spans], [RPC Server Metrics] |

jaydeluca · 2025-12-19T10:57:55Z

.fossa.yml

+      target: ':instrumentation:sofa-rpc-5.4:javaagent'
+    - type: gradle
+      path: ./
+      target: ':instrumentation:sofa-rpc-5.4:library-autoconfigure'


the name autoconfigure here doesn't follow the normal pattern. Seems like it should just be library ? I see that this is also the case in the dubbo module, which is maybe where you copied from, but I'm not sure it's correct there either

library-autoconfigure is used by library instrumentations that are automatically enabled when the library instrumentation jar is added to the project as opposed to library instrumentations where user has to write code to enable the instrumentation. Typically the library-autoconfigure use some sort of spi that is automatically picked up by the instrumented framework. Often it makes sense for instrumentation to provide both library and library-autoconfigure modules (for example see aws2.2 instrumentation) since library-autoconfigure instrumentations can't often be configured.

jaydeluca · 2025-12-19T11:00:22Z

...va/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcInstrumentationModule.java

+  }
+
+  // A type instrumentation is needed to trigger resource injection.
+  public static class ResourceInjectingTypeInstrumentation implements TypeInstrumentation {


any reason not to put this in a separate file? we don't typically include instrumentations in the InstrumentationModule itself

jaydeluca · 2025-12-19T11:09:38Z

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java

+      String errorMsg = response.getErrorMsg();
+      if (errorMsg != null) {
+        return new SofaRpcException(
+            com.alipay.sofa.rpc.core.exception.RpcErrorType.SERVER_UNDECLARED_ERROR, errorMsg);


is having the FQCN useful in this case or could we import?

Suggested change

com.alipay.sofa.rpc.core.exception.RpcErrorType.SERVER_UNDECLARED_ERROR, errorMsg);

RpcErrorType.SERVER_UNDECLARED_ERROR, errorMsg);

jaydeluca · 2025-12-19T11:15:07Z

...testing/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTest.java

+  @BeforeAll
+  static void setUp() {}
+
+  @AfterAll
+  static void tearDown() {}


Suggested change

@BeforeAll

static void setUp() {}

@AfterAll

static void tearDown() {}

jaydeluca · 2025-12-19T11:18:29Z

...testing/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTest.java

+    return consumer;
+  }
+
+  ConsumerConfig<GenericService> configureGenericClient(int port) {


this seems like it is unused?

jaydeluca · 2025-12-19T11:21:30Z

...testing/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTest.java

+                                "io.opentelemetry.instrumentation.sofarpc.v5_4.api.HelloService/hello")
+                            .hasKind(SpanKind.SERVER)
+                            .hasParent(trace.getSpan(1))
+                            .hasAttributesSatisfying(


A handful of the server spans in this test don't use the exactly flavor of this assertion, is that intentional?

Suggested change

.hasAttributesSatisfying(

.hasAttributesSatisfyingExactly(

jaydeluca · 2025-12-19T11:23:56Z

...c/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTraceChainTest.java

+  @BeforeAll
+  static void setUp() {}
+
+  @AfterAll
+  static void tearDown() {}


Suggested change

@BeforeAll

static void setUp() {}

@AfterAll

static void tearDown() {}

jaydeluca · 2025-12-19T11:24:59Z

...c/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/AbstractSofaRpcTraceChainTest.java

+                                "io.opentelemetry.instrumentation.sofarpc.v5_4.api.MiddleService/hello")
+                            .hasKind(SpanKind.SERVER)
+                            .hasParent(trace.getSpan(1))
+                            .hasAttributesSatisfying(


Same question as other test, is there a reason we can't use the strict version?

Suggested change

.hasAttributesSatisfying(

.hasAttributesSatisfyingExactly(

jaydeluca · 2025-12-19T11:41:43Z

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java

+      return;
+    }
+    Throwable error = exception != null ? exception : extractException(response);
+    instrumenter.end(context, SofaRpcRequest.create(request), response, error);


in some of our other similar instrumentations, we clear the virtual field after we grab it to avoid memory leaks. See jaxrs, and asynchttpclient and kafka as examples

Suggested change

instrumenter.end(context, SofaRpcRequest.create(request), response, error);

instrumenter.end(context, SofaRpcRequest.create(request), response, error);

ASYNC_CONTEXT.set(request, null); // Clear to prevent memory leak

Add support for SOFARPC framework

79ddb57

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0 through 5.12.0+ Fixes open-telemetry#15496

steverao reviewed Dec 10, 2025

View reviewed changes

instrumentation/sofa-rpc/javaagent/build.gradle.kts Outdated Show resolved Hide resolved

...main/java/io/opentelemetry/javaagent/instrumentation/sofa/rpc/OpenTelemetryClientFilter.java Outdated Show resolved Hide resolved

steverao reviewed Dec 10, 2025

View reviewed changes

...n/java/io/opentelemetry/javaagent/instrumentation/sofa/rpc/SofaRpcInstrumentationModule.java Outdated Show resolved Hide resolved

...n/java/io/opentelemetry/javaagent/instrumentation/sofa/rpc/SofaRpcInstrumentationModule.java Outdated Show resolved Hide resolved

steverao reviewed Dec 10, 2025

View reviewed changes

steverao requested a review from Copilot December 11, 2025 01:58

Copilot started reviewing on behalf of steverao December 11, 2025 01:59 View session

Copilot AI reviewed Dec 11, 2025

View reviewed changes

fangxiu-wf and others added 3 commits December 11, 2025 17:19

Add support for SOFARPC framework

4f13bcb

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0 through 5.12.0+ Fixes open-telemetry#15496

Update instrumentation/sofa-rpc-5.4/library-autoconfigure/src/main/ja…

2edfd9c

…va/io/opentelemetry/instrumentation/sofarpc/v5_4/SofaRpcTelemetryBuilder.java Co-authored-by: Copilot <[email protected]>

Update instrumentation/sofa-rpc-5.4/metadata.yaml

2e3ea76

Co-authored-by: Copilot <[email protected]>

steverao reviewed Dec 12, 2025

View reviewed changes

instrumentation/sofa-rpc-5.4/javaagent/build.gradle.kts Show resolved Hide resolved

steverao reviewed Dec 12, 2025

View reviewed changes

instrumentation/sofa-rpc-5.4/testing/build.gradle.kts Show resolved Hide resolved

instrumentation/sofa-rpc-5.4/metadata.yaml Outdated Show resolved Hide resolved

fangxiu-wf added 4 commits December 12, 2025 15:12

Add support for SOFARPC framework

6858a2f

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0 through 5.12.0+ Fixes open-telemetry#15496

Add support for SOFARPC framework

0ca5e01

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

Add support for SOFARPC framework

e58a555

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

Add support for SOFARPC framework

c65186c

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

steverao reviewed Dec 15, 2025

View reviewed changes

...autoconfigure/src/main/java/io/opentelemetry/instrumentation/sofarpc/v5_4/TracingFilter.java Outdated Show resolved Hide resolved

docs/supported-libraries.md Outdated Show resolved Hide resolved

settings.gradle.kts Outdated Show resolved Hide resolved

fangxiu-wf added 6 commits December 15, 2025 14:30

Add support for SOFARPC framework

a17da61

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

Merge branch 'main' into SOFARPC

ee9dfb8

Add support for SOFARPC framework

1158f8b

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

Add support for SOFARPC framework

b8ef5ba

This PR adds instrumentation support for SOFARPC framework, including: - Javaagent instrumentation module - Library autoconfigure module - Testing utilities and test cases - Support for SOFARPC 5.4.0+ Fixes open-telemetry#15496

Merge branch 'main' into SOFARPC

fc5973e

Merge branch 'main' into SOFARPC

5d2c68a

fangxiu-wf marked this pull request as ready for review December 17, 2025 12:16

fangxiu-wf requested a review from a team as a code owner December 17, 2025 12:16

jaydeluca reviewed Dec 19, 2025

View reviewed changes

	\| [SOFARPC](https://github.com/sofastack/sofa-rpc/) \| 5.4.0+ \| [opentelemetry-sofa-rpc-5.4](../instrumentation/sofa-rpc-5.4/library-autoconfigure) \| [RPC Client Spans], [RPC Server Spans] \|
	\| [SOFARPC](https://github.com/sofastack/sofa-rpc/) \| 5.4+ \| [opentelemetry-sofa-rpc-5.4](../instrumentation/sofa-rpc-5.4/library-autoconfigure) \| [RPC Client Spans], [RPC Client Metrics], [RPC Server Spans], [RPC Server Metrics] \|

	com.alipay.sofa.rpc.core.exception.RpcErrorType.SERVER_UNDECLARED_ERROR, errorMsg);
	RpcErrorType.SERVER_UNDECLARED_ERROR, errorMsg);

	instrumenter.end(context, SofaRpcRequest.create(request), response, error);
	instrumenter.end(context, SofaRpcRequest.create(request), response, error);
	ASYNC_CONTEXT.set(request, null); // Clear to prevent memory leak

feat: Add support for SOFARPC framework #15589

Are you sure you want to change the base?

feat: Add support for SOFARPC framework #15589

Uh oh!

Conversation

fangxiu-wf commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

linux-foundation-easycla bot commented Dec 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fangxiu-wf commented Dec 10, 2025 •

edited

Loading

linux-foundation-easycla bot commented Dec 10, 2025 •

edited

Loading