-
Notifications
You must be signed in to change notification settings - Fork 1k
feat: Add support for SOFARPC framework #15589
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
fangxiu-wf
wants to merge
14
commits into
open-telemetry:main
Choose a base branch
from
fangxiu-wf:SOFARPC
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
79ddb57
Add support for SOFARPC framework
fangxiu-wf 4f13bcb
Add support for SOFARPC framework
fangxiu-wf 2edfd9c
Update instrumentation/sofa-rpc-5.4/library-autoconfigure/src/main/ja…
fangxiu-wf 2e3ea76
Update instrumentation/sofa-rpc-5.4/metadata.yaml
fangxiu-wf 6858a2f
Add support for SOFARPC framework
fangxiu-wf 0ca5e01
Add support for SOFARPC framework
fangxiu-wf e58a555
Add support for SOFARPC framework
fangxiu-wf c65186c
Add support for SOFARPC framework
fangxiu-wf a17da61
Add support for SOFARPC framework
fangxiu-wf ee9dfb8
Merge branch 'main' into SOFARPC
fangxiu-wf 1158f8b
Add support for SOFARPC framework
fangxiu-wf b8ef5ba
Add support for SOFARPC framework
fangxiu-wf fc5973e
Merge branch 'main' into SOFARPC
fangxiu-wf 5d2c68a
Merge branch 'main' into SOFARPC
fangxiu-wf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| 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) | ||
| } | ||
|
|
||
| if (findProperty("denyUnsafe") as Boolean) { | ||
| // SOFA RPC's tracer module uses Disruptor which requires sun.misc.Unsafe. | ||
| withType<Test>().configureEach { | ||
| enabled = false | ||
| } | ||
| } | ||
| } | ||
|
|
||
| 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") | ||
| } | ||
| } | ||
41 changes: 41 additions & 0 deletions
41
...va/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/OpenTelemetryClientFilter.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| } | ||
| } |
31 changes: 31 additions & 0 deletions
31
...va/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/OpenTelemetryServerFilter.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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); | ||
| } | ||
| } |
74 changes: 74 additions & 0 deletions
74
...io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcInstrumentationModule.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * 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") | ||
| // Class was added in 5.4.0 | ||
| .and(hasClassesNamed("com.alipay.sofa.rpc.transport.ClientHandler")); | ||
| } | ||
|
|
||
| @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. | ||
| } | ||
| } | ||
| } |
32 changes: 32 additions & 0 deletions
32
.../main/java/io/opentelemetry/javaagent/instrumentation/sofarpc/v5_4/SofaRpcSingletons.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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() {} | ||
| } |
3 changes: 3 additions & 0 deletions
3
...-5.4/javaagent/src/main/resources/sofa-rpc-5.4/META-INF/com.alipay.sofa.rpc.filter.Filter
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4.OpenTelemetryClientFilter | ||
| io.opentelemetry.javaagent.instrumentation.sofarpc.v5_4.OpenTelemetryServerFilter | ||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.