-
Notifications
You must be signed in to change notification settings - Fork 791
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
Add instrumentation for armeria gRPC #11351
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
9e80f79
Add instrumentation for armeria gRPC
laurit 18f853a
fix formatting
laurit ab4da72
fix formatting
laurit efb810f
Update instrumentation/armeria-grpc-1.14/javaagent/src/test/java/io/o…
laurit 5f41c61
Update instrumentation/armeria-grpc-1.14/javaagent/src/test/java/io/o…
laurit 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 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
23 changes: 23 additions & 0 deletions
23
instrumentation/armeria-grpc-1.14/javaagent/build.gradle.kts
This file contains 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,23 @@ | ||
| plugins { | ||
| id("otel.javaagent-instrumentation") | ||
| } | ||
|
|
||
| muzzle { | ||
| pass { | ||
| group.set("com.linecorp.armeria") | ||
| module.set("armeria-grpc") | ||
| versions.set("[1.14.0,)") | ||
| assertInverse.set(true) | ||
| } | ||
| } | ||
|
|
||
| dependencies { | ||
| library("com.linecorp.armeria:armeria-grpc:1.14.0") | ||
| implementation(project(":instrumentation:grpc-1.6:library")) | ||
|
|
||
| testInstrumentation(project(":instrumentation:netty:netty-4.1:javaagent")) | ||
| testInstrumentation(project(":instrumentation:grpc-1.6:javaagent")) | ||
|
|
||
| testImplementation(project(":instrumentation:grpc-1.6:testing")) | ||
| testLibrary("com.linecorp.armeria:armeria-junit5:1.14.0") | ||
| } |
43 changes: 43 additions & 0 deletions
43
...javaagent/instrumentation/armeria/grpc/v1_14/ArmeriaGrpcClientBuilderInstrumentation.java
This file contains 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,43 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.armeria.grpc.v1_14; | ||
|
|
||
| import static net.bytebuddy.matcher.ElementMatchers.isMethod; | ||
| import static net.bytebuddy.matcher.ElementMatchers.isPublic; | ||
| import static net.bytebuddy.matcher.ElementMatchers.named; | ||
|
|
||
| import com.linecorp.armeria.client.grpc.GrpcClientBuilder; | ||
| import io.opentelemetry.api.GlobalOpenTelemetry; | ||
| import io.opentelemetry.instrumentation.grpc.v1_6.GrpcTelemetry; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
|
|
||
| public class ArmeriaGrpcClientBuilderInstrumentation implements TypeInstrumentation { | ||
|
|
||
| @Override | ||
| public ElementMatcher<TypeDescription> typeMatcher() { | ||
| return named("com.linecorp.armeria.client.grpc.GrpcClientBuilder"); | ||
| } | ||
|
|
||
| @Override | ||
| public void transform(TypeTransformer transformer) { | ||
| transformer.applyAdviceToMethod( | ||
| isMethod().and(isPublic()).and(named("build")), | ||
| ArmeriaGrpcClientBuilderInstrumentation.class.getName() + "$BuildAdvice"); | ||
| } | ||
|
|
||
| @SuppressWarnings("unused") | ||
| public static class BuildAdvice { | ||
|
|
||
| @Advice.OnMethodEnter | ||
| public static void onEnter(@Advice.This GrpcClientBuilder builder) { | ||
| builder.intercept(GrpcTelemetry.create(GlobalOpenTelemetry.get()).newClientInterceptor()); | ||
| } | ||
| } | ||
| } |
27 changes: 27 additions & 0 deletions
27
...emetry/javaagent/instrumentation/armeria/grpc/v1_14/ArmeriaGrpcInstrumentationModule.java
This file contains 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,27 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.armeria.grpc.v1_14; | ||
|
|
||
| import static java.util.Arrays.asList; | ||
|
|
||
| import com.google.auto.service.AutoService; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.InstrumentationModule; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation; | ||
| import java.util.List; | ||
|
|
||
| @AutoService(InstrumentationModule.class) | ||
| public class ArmeriaGrpcInstrumentationModule extends InstrumentationModule { | ||
| public ArmeriaGrpcInstrumentationModule() { | ||
| super("armeria", "armeria-1.14", "armeria-grpc-1.14"); | ||
| } | ||
|
|
||
| @Override | ||
| public List<TypeInstrumentation> typeInstrumentations() { | ||
| return asList( | ||
| new ArmeriaGrpcClientBuilderInstrumentation(), | ||
| new ArmeriaGrpcServiceBuilderInstrumentation()); | ||
| } | ||
| } |
42 changes: 42 additions & 0 deletions
42
...avaagent/instrumentation/armeria/grpc/v1_14/ArmeriaGrpcServiceBuilderInstrumentation.java
This file contains 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,42 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.armeria.grpc.v1_14; | ||
|
|
||
| import static net.bytebuddy.matcher.ElementMatchers.isMethod; | ||
| import static net.bytebuddy.matcher.ElementMatchers.isPublic; | ||
| import static net.bytebuddy.matcher.ElementMatchers.named; | ||
|
|
||
| import com.linecorp.armeria.server.grpc.GrpcServiceBuilder; | ||
| import io.opentelemetry.api.GlobalOpenTelemetry; | ||
| import io.opentelemetry.instrumentation.grpc.v1_6.GrpcTelemetry; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeInstrumentation; | ||
| import io.opentelemetry.javaagent.extension.instrumentation.TypeTransformer; | ||
| import net.bytebuddy.asm.Advice; | ||
| import net.bytebuddy.description.type.TypeDescription; | ||
| import net.bytebuddy.matcher.ElementMatcher; | ||
|
|
||
| public class ArmeriaGrpcServiceBuilderInstrumentation implements TypeInstrumentation { | ||
| @Override | ||
| public ElementMatcher<TypeDescription> typeMatcher() { | ||
| return named("com.linecorp.armeria.server.grpc.GrpcServiceBuilder"); | ||
| } | ||
|
|
||
| @Override | ||
| public void transform(TypeTransformer transformer) { | ||
| transformer.applyAdviceToMethod( | ||
| isMethod().and(isPublic()).and(named("build")), | ||
| ArmeriaGrpcServiceBuilderInstrumentation.class.getName() + "$BuildAdvice"); | ||
| } | ||
|
|
||
| @SuppressWarnings("unused") | ||
| public static class BuildAdvice { | ||
|
|
||
| @Advice.OnMethodEnter | ||
| public static void onEnter(@Advice.This GrpcServiceBuilder builder) { | ||
| builder.intercept(GrpcTelemetry.create(GlobalOpenTelemetry.get()).newServerInterceptor()); | ||
| } | ||
| } | ||
| } |
127 changes: 127 additions & 0 deletions
127
...t/java/io/opentelemetry/javaagent/instrumentation/armeria/grpc/v1_14/ArmeriaGrpcTest.java
This file contains 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,127 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package io.opentelemetry.javaagent.instrumentation.armeria.grpc.v1_14; | ||
|
|
||
| import static io.opentelemetry.sdk.testing.assertj.OpenTelemetryAssertions.equalTo; | ||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import com.linecorp.armeria.client.grpc.GrpcClients; | ||
| import com.linecorp.armeria.server.ServerBuilder; | ||
| import com.linecorp.armeria.server.grpc.GrpcService; | ||
| import com.linecorp.armeria.testing.junit5.server.ServerExtension; | ||
| import example.GreeterGrpc; | ||
| import example.Helloworld; | ||
| import io.grpc.Status; | ||
| import io.grpc.stub.StreamObserver; | ||
| import io.opentelemetry.api.trace.SpanKind; | ||
| import io.opentelemetry.instrumentation.testing.junit.AgentInstrumentationExtension; | ||
| import io.opentelemetry.semconv.ServerAttributes; | ||
| import io.opentelemetry.semconv.incubating.MessageIncubatingAttributes; | ||
| import io.opentelemetry.semconv.incubating.RpcIncubatingAttributes; | ||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
|
||
| class ArmeriaGrpcTest { | ||
|
|
||
| @RegisterExtension | ||
| static final AgentInstrumentationExtension testing = AgentInstrumentationExtension.create(); | ||
|
|
||
| @RegisterExtension | ||
| static ServerExtension server = | ||
laurit marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| new ServerExtension() { | ||
| @Override | ||
| protected void configure(ServerBuilder sb) throws Exception { | ||
| sb.service( | ||
| GrpcService.builder() | ||
| .addService( | ||
| new GreeterGrpc.GreeterImplBase() { | ||
| @Override | ||
| public void sayHello( | ||
| Helloworld.Request request, | ||
| StreamObserver<Helloworld.Response> responseObserver) { | ||
| responseObserver.onNext( | ||
| Helloworld.Response.newBuilder() | ||
| .setMessage("Hello " + request.getName()) | ||
| .build()); | ||
| responseObserver.onCompleted(); | ||
| } | ||
| }) | ||
| .build()); | ||
| } | ||
| }; | ||
|
|
||
| @Test | ||
| void grpcInstrumentation() { | ||
| GreeterGrpc.GreeterBlockingStub client = | ||
| GrpcClients.builder(server.httpUri()).build(GreeterGrpc.GreeterBlockingStub.class); | ||
|
|
||
| Helloworld.Response response = | ||
| testing.runWithSpan( | ||
| "parent", | ||
| () -> client.sayHello(Helloworld.Request.newBuilder().setName("test").build())); | ||
|
|
||
| assertThat(response.getMessage()).isEqualTo("Hello test"); | ||
|
|
||
| testing.waitAndAssertTraces( | ||
| trace -> | ||
| trace.hasSpansSatisfyingExactly( | ||
| span -> span.hasName("parent").hasKind(SpanKind.INTERNAL).hasNoParent(), | ||
| span -> | ||
| span.hasName("example.Greeter/SayHello") | ||
| .hasKind(SpanKind.CLIENT) | ||
| .hasParent(trace.getSpan(0)) | ||
| .hasAttributesSatisfyingExactly( | ||
| equalTo(RpcIncubatingAttributes.RPC_SYSTEM, "grpc"), | ||
| equalTo(RpcIncubatingAttributes.RPC_SERVICE, "example.Greeter"), | ||
| equalTo(RpcIncubatingAttributes.RPC_METHOD, "SayHello"), | ||
| equalTo( | ||
| RpcIncubatingAttributes.RPC_GRPC_STATUS_CODE, | ||
| (long) Status.Code.OK.value()), | ||
| equalTo(ServerAttributes.SERVER_ADDRESS, "127.0.0.1"), | ||
| equalTo(ServerAttributes.SERVER_PORT, (long) server.httpPort())) | ||
| .hasEventsSatisfyingExactly( | ||
| event -> | ||
| event | ||
| .hasName("message") | ||
| .hasAttributesSatisfyingExactly( | ||
| equalTo(MessageIncubatingAttributes.MESSAGE_TYPE, "SENT"), | ||
| equalTo(MessageIncubatingAttributes.MESSAGE_ID, 1L)), | ||
| event -> | ||
| event | ||
| .hasName("message") | ||
| .hasAttributesSatisfyingExactly( | ||
| equalTo( | ||
| MessageIncubatingAttributes.MESSAGE_TYPE, "RECEIVED"), | ||
| equalTo(MessageIncubatingAttributes.MESSAGE_ID, 2L))), | ||
| span -> | ||
| span.hasName("example.Greeter/SayHello") | ||
| .hasKind(SpanKind.SERVER) | ||
| .hasParent(trace.getSpan(1)) | ||
| .hasAttributesSatisfyingExactly( | ||
| equalTo(RpcIncubatingAttributes.RPC_SYSTEM, "grpc"), | ||
| equalTo(RpcIncubatingAttributes.RPC_SERVICE, "example.Greeter"), | ||
| equalTo(RpcIncubatingAttributes.RPC_METHOD, "SayHello"), | ||
| equalTo( | ||
| RpcIncubatingAttributes.RPC_GRPC_STATUS_CODE, | ||
| (long) Status.Code.OK.value()), | ||
| equalTo(ServerAttributes.SERVER_ADDRESS, "127.0.0.1"), | ||
| equalTo(ServerAttributes.SERVER_PORT, server.httpPort())) | ||
| .hasEventsSatisfyingExactly( | ||
| event -> | ||
| event | ||
| .hasName("message") | ||
| .hasAttributesSatisfyingExactly( | ||
| equalTo( | ||
| MessageIncubatingAttributes.MESSAGE_TYPE, "RECEIVED"), | ||
| equalTo(MessageIncubatingAttributes.MESSAGE_ID, 1L)), | ||
| event -> | ||
| event | ||
| .hasName("message") | ||
| .hasAttributesSatisfyingExactly( | ||
| equalTo(MessageIncubatingAttributes.MESSAGE_TYPE, "SENT"), | ||
| equalTo(MessageIncubatingAttributes.MESSAGE_ID, 2L))))); | ||
| } | ||
| } | ||
This file contains 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 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.