Skip to content
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

End grpc server span in onComplete instead of close #11170

Merged
merged 2 commits into from
Apr 30, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
import io.grpc.ServerBuilder;
import io.grpc.Status;
import io.grpc.stub.StreamObserver;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanKind;
import io.opentelemetry.api.trace.Tracer;
import io.opentelemetry.instrumentation.testing.junit.InstrumentationExtension;
import io.opentelemetry.instrumentation.testing.util.ThrowingRunnable;
import io.opentelemetry.sdk.testing.assertj.EventDataAssert;
Expand All @@ -33,11 +35,13 @@
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;
import java.util.concurrent.atomic.AtomicReference;
import java.util.function.Consumer;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.Test;
import org.junitpioneer.jupiter.cartesian.CartesianTest;

public abstract class AbstractGrpcStreamingTest {
Expand Down Expand Up @@ -264,6 +268,92 @@ public void onCompleted() {
(long) Status.Code.OK.value()))))));
}

@Test
void grpcServerSpanEndsAfterChildSpan() throws Exception {
Tracer tracer = testing().getOpenTelemetry().getTracer("test");
AtomicBoolean serverSpanRecording = new AtomicBoolean();
CountDownLatch latch = new CountDownLatch(2);

BindableService greeter =
new GreeterGrpc.GreeterImplBase() {
@Override
public StreamObserver<Helloworld.Response> conversation(
StreamObserver<Helloworld.Response> observer) {
return new StreamObserver<Helloworld.Response>() {
Span span;

@Override
public void onNext(Helloworld.Response value) {
span = tracer.spanBuilder("child").startSpan();
observer.onNext(value);
}

@Override
public void onError(Throwable t) {
observer.onError(t);
span.end();
}

@Override
public void onCompleted() {
observer.onCompleted();
serverSpanRecording.set(Span.current().isRecording());
span.end();
latch.countDown();
}
};
}
};

Server server = configureServer(ServerBuilder.forPort(0).addService(greeter)).build().start();
ManagedChannel channel = createChannel(server);
closer.add(() -> channel.shutdownNow().awaitTermination(10, TimeUnit.SECONDS));
closer.add(() -> server.shutdownNow().awaitTermination());

GreeterGrpc.GreeterStub client = GreeterGrpc.newStub(channel).withWaitForReady();

StreamObserver<Helloworld.Response> observer2 =
client.conversation(
new StreamObserver<Helloworld.Response>() {
@Override
public void onNext(Helloworld.Response value) {}

@Override
public void onError(Throwable t) {}

@Override
public void onCompleted() {
latch.countDown();
}
});

Helloworld.Response message = Helloworld.Response.newBuilder().setMessage("message").build();
observer2.onNext(message);
observer2.onCompleted();

latch.await(10, TimeUnit.SECONDS);

// server span should end after child span
zeitlinger marked this conversation as resolved.
Show resolved Hide resolved
assertThat(serverSpanRecording).isTrue();

testing()
.waitAndAssertTraces(
trace ->
trace.hasSpansSatisfyingExactly(
span ->
span.hasName("example.Greeter/Conversation")
.hasKind(SpanKind.CLIENT)
.hasNoParent(),
span ->
span.hasName("example.Greeter/Conversation")
.hasKind(SpanKind.SERVER)
.hasParent(trace.getSpan(0)),
span ->
span.hasName("child")
.hasKind(SpanKind.INTERNAL)
.hasParent(trace.getSpan(1))));
}

private ManagedChannel createChannel(Server server) throws Exception {
ManagedChannelBuilder<?> channelBuilder =
configureClient(ManagedChannelBuilder.forAddress("localhost", server.getPort()));
Expand Down
Loading