-
Notifications
You must be signed in to change notification settings - Fork 965
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix observation scope handlings in grpc server instrumentation (#3836)
Prior to this change, when grpc server receives requests in parallel, wrong scopes might have been used. This change ensures the proper scope is used for dispatched callback methods. Fixes gh-3805
- Loading branch information
Showing
6 changed files
with
245 additions
and
34 deletions.
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
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
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
164 changes: 164 additions & 0 deletions
164
micrometer-core/src/test/java/io/micrometer/core/instrument/binder/grpc/GrpcAsyncTest.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,164 @@ | ||
| /* | ||
| * Copyright 2023 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package io.micrometer.core.instrument.binder.grpc; | ||
|
|
||
| import com.google.common.util.concurrent.ListenableFuture; | ||
| import io.grpc.ManagedChannel; | ||
| import io.grpc.Metadata; | ||
| import io.grpc.Server; | ||
| import io.grpc.inprocess.InProcessChannelBuilder; | ||
| import io.grpc.inprocess.InProcessServerBuilder; | ||
| import io.grpc.stub.MetadataUtils; | ||
| import io.grpc.stub.StreamObserver; | ||
| import io.grpc.testing.protobuf.SimpleRequest; | ||
| import io.grpc.testing.protobuf.SimpleResponse; | ||
| import io.grpc.testing.protobuf.SimpleServiceGrpc; | ||
| import io.grpc.testing.protobuf.SimpleServiceGrpc.SimpleServiceFutureStub; | ||
| import io.grpc.testing.protobuf.SimpleServiceGrpc.SimpleServiceImplBase; | ||
| import io.micrometer.observation.Observation.Context; | ||
| import io.micrometer.observation.ObservationHandler; | ||
| import io.micrometer.observation.ObservationRegistry; | ||
| import io.micrometer.observation.ObservationTextPublisher; | ||
| import org.junit.jupiter.api.AfterEach; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.HashMap; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.concurrent.Future; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.awaitility.Awaitility.await; | ||
|
|
||
| /** | ||
| * @author Tadaya Tsuyukubo | ||
| */ | ||
| class GrpcAsyncTest { | ||
|
|
||
| static final Metadata.Key<String> REQUEST_ID_KEY = Metadata.Key.of("request-id", Metadata.ASCII_STRING_MARSHALLER); | ||
|
|
||
| Server server; | ||
|
|
||
| ManagedChannel channel; | ||
|
|
||
| @BeforeEach | ||
| void setUp() throws Exception { | ||
| ObservationRegistry observationRegistry = ObservationRegistry.create(); | ||
| observationRegistry.observationConfig() | ||
| .observationHandler(new ObservationTextPublisher()) | ||
| .observationHandler(new StoreRequestIdInScopeObservationHandler()); | ||
|
|
||
| this.server = InProcessServerBuilder.forName("sample") | ||
| .addService(new MyService()) | ||
| .intercept(new ObservationGrpcServerInterceptor(observationRegistry)) | ||
| .build(); | ||
| this.server.start(); | ||
|
|
||
| this.channel = InProcessChannelBuilder.forName("sample") | ||
| .intercept(new ObservationGrpcClientInterceptor(observationRegistry)) | ||
| .build(); | ||
| } | ||
|
|
||
| @AfterEach | ||
| void cleanUp() { | ||
| if (this.channel != null) { | ||
| this.channel.shutdownNow(); | ||
| } | ||
| if (this.server != null) { | ||
| this.server.shutdownNow(); | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void simulate_trace_in_async_requests() { | ||
| // Send requests asynchronously with request-id in metadata. | ||
| // The request-id is stored in threadlocal in server when scope is opened. | ||
| // The main logic retrieves the request-id from threadlocal and include it as | ||
| // part of the response message. | ||
| // This simulates a tracer with span. | ||
| SimpleServiceFutureStub stub = SimpleServiceGrpc.newFutureStub(this.channel); | ||
| Map<ListenableFuture<SimpleResponse>, String> requestIds = new HashMap<>(); | ||
| List<ListenableFuture<SimpleResponse>> futures = new ArrayList<>(); | ||
| int max = 40; | ||
| for (int i = 0; i < max; i++) { | ||
| String message = "Hello-" + i; | ||
| SimpleRequest request = SimpleRequest.newBuilder().setRequestMessage(message).build(); | ||
|
|
||
| String requestId = "req-" + i; | ||
| Metadata metadata = new Metadata(); | ||
| metadata.put(REQUEST_ID_KEY, requestId); | ||
| ListenableFuture<SimpleResponse> future = stub | ||
| .withInterceptors(MetadataUtils.newAttachHeadersInterceptor(metadata)) | ||
| .unaryRpc(request); | ||
|
|
||
| requestIds.put(future, requestId); | ||
| futures.add(future); | ||
| } | ||
| await().until(() -> futures.stream().allMatch(Future::isDone)); | ||
| assertThat(futures).allSatisfy((future) -> { | ||
| // Make sure the request-id in the response message matches with the one sent | ||
| // to server. | ||
| String expectedRequestId = requestIds.get(future); | ||
| assertThat(future.get().getResponseMessage()).contains("request-id=" + expectedRequestId); | ||
| }); | ||
| } | ||
|
|
||
| static class StoreRequestIdInScopeObservationHandler implements ObservationHandler<GrpcServerObservationContext> { | ||
|
|
||
| @Override | ||
| public boolean supportsContext(Context context) { | ||
| return context instanceof GrpcServerObservationContext; | ||
| } | ||
|
|
||
| @Override | ||
| public void onScopeOpened(GrpcServerObservationContext context) { | ||
| String requestId = context.getCarrier().get(REQUEST_ID_KEY); | ||
| assertThat(requestId).isNotNull(); | ||
| MyService.requestIdHolder.set(requestId); | ||
| } | ||
|
|
||
| @Override | ||
| public void onScopeClosed(GrpcServerObservationContext context) { | ||
| MyService.requestIdHolder.remove(); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| static class MyService extends SimpleServiceImplBase { | ||
|
|
||
| static ThreadLocal<String> requestIdHolder = new ThreadLocal<>(); | ||
|
|
||
| @Override | ||
| public void unaryRpc(SimpleRequest request, StreamObserver<SimpleResponse> responseObserver) { | ||
| StringBuilder sb = new StringBuilder(); | ||
| sb.append("message="); | ||
| sb.append(request.getRequestMessage()); | ||
| sb.append(",request-id="); | ||
| sb.append(requestIdHolder.get()); | ||
| sb.append(",thread="); | ||
| sb.append(Thread.currentThread().getId()); | ||
|
|
||
| SimpleResponse response = SimpleResponse.newBuilder().setResponseMessage(sb.toString()).build(); | ||
| responseObserver.onNext(response); | ||
| responseObserver.onCompleted(); | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } |
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