kazusa
/
skywalking-java
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Enhance gRPC server side async support. (#741) 

Change context and parent entry span propagation mechanism from gRPC ThreadLocal context to SkyWalking native dynamic field as new propagation mechanism, to better support async scenarios.
This commit is contained in:
吴晟 Wu Sheng 2024-12-27 09:42:34 +08:00 committed by GitHub
parent b4ad5b1960
commit 1431cad945
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 37 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.md
View File

@ -23,6 +23,8 @@ Release Notes.
* [doc] Add Spring Gateway Plugin document * [doc] Add Spring Gateway Plugin document
* [doc] Add 4 menu items guiding users to find important notices for Spring Annotation Plugin, Custom Trace Ignoring * [doc] Add 4 menu items guiding users to find important notices for Spring Annotation Plugin, Custom Trace Ignoring
Plugin, Kotlin Coroutine Plugin, and Spring Gateway Plugin Plugin, Kotlin Coroutine Plugin, and Spring Gateway Plugin
* Change context and parent entry span propagation mechanism from gRPC ThreadLocal context to SkyWalking native dynamic
field as new propagation mechanism, to better support async scenarios.
All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/222?closed=1) All issues and pull requests are [here](https://github.com/apache/skywalking/milestone/222?closed=1)

13
apm-sniffer/apm-sdk-plugin/grpc-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/grpc/v1/server/ServerInterceptor.java
View File

@ -36,9 +36,6 @@ import static org.apache.skywalking.apm.plugin.grpc.v1.OperationNameFormatUtil.f
public class ServerInterceptor implements io.grpc.ServerInterceptor { public class ServerInterceptor implements io.grpc.ServerInterceptor {
static final Context.Key<ContextSnapshot> CONTEXT_SNAPSHOT_KEY = Context.key("skywalking-grpc-context-snapshot");
static final Context.Key<AbstractSpan> ACTIVE_SPAN_KEY = Context.key("skywalking-grpc-active-span");
@Override @Override
public <REQUEST, RESPONSE> ServerCall.Listener<REQUEST> interceptCall(ServerCall<REQUEST, RESPONSE> call, public <REQUEST, RESPONSE> ServerCall.Listener<REQUEST> interceptCall(ServerCall<REQUEST, RESPONSE> call,
Metadata headers, ServerCallHandler<REQUEST, RESPONSE> handler) { Metadata headers, ServerCallHandler<REQUEST, RESPONSE> handler) {
@ -59,15 +56,17 @@ public class ServerInterceptor implements io.grpc.ServerInterceptor {
ContextSnapshot contextSnapshot = ContextManager.capture(); ContextSnapshot contextSnapshot = ContextManager.capture();
AbstractSpan asyncSpan = span.prepareForAsync(); AbstractSpan asyncSpan = span.prepareForAsync();
Context context = Context.current().withValues(CONTEXT_SNAPSHOT_KEY, contextSnapshot, ACTIVE_SPAN_KEY, asyncSpan); //Context context = Context.current().withValues(CONTEXT_SNAPSHOT_KEY, contextSnapshot, ACTIVE_SPAN_KEY, asyncSpan);
ServerCall.Listener<REQUEST> listener = Contexts.interceptCall( ServerCall.Listener<REQUEST> listener = Contexts.interceptCall(
context, Context.current(),
new TracingServerCall<>(call), new TracingServerCall<>(call, contextSnapshot, asyncSpan),
headers, headers,
(serverCall, metadata) -> new TracingServerCallListener<>( (serverCall, metadata) -> new TracingServerCallListener<>(
handler.startCall(serverCall, metadata), handler.startCall(serverCall, metadata),
serverCall.getMethodDescriptor() serverCall.getMethodDescriptor(),
contextSnapshot,
asyncSpan
) )
); );
ContextManager.stopSpan(asyncSpan); ContextManager.stopSpan(asyncSpan);

26
apm-sniffer/apm-sdk-plugin/grpc-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/grpc/v1/server/TracingServerCall.java
View File

@ -18,38 +18,46 @@
package org.apache.skywalking.apm.plugin.grpc.v1.server; package org.apache.skywalking.apm.plugin.grpc.v1.server;
import static org.apache.skywalking.apm.plugin.grpc.v1.Constants.RESPONSE_ON_CLOSE_OPERATION_NAME;
import static org.apache.skywalking.apm.plugin.grpc.v1.Constants.RESPONSE_ON_MESSAGE_OPERATION_NAME;
import static org.apache.skywalking.apm.plugin.grpc.v1.Constants.SERVER;
import io.grpc.ForwardingServerCall; import io.grpc.ForwardingServerCall;
import io.grpc.Metadata; import io.grpc.Metadata;
import io.grpc.ServerCall; import io.grpc.ServerCall;
import io.grpc.Status; import io.grpc.Status;
import org.apache.skywalking.apm.agent.core.context.ContextManager; import org.apache.skywalking.apm.agent.core.context.ContextManager;
import org.apache.skywalking.apm.agent.core.context.ContextSnapshot;
import org.apache.skywalking.apm.agent.core.context.tag.Tags; import org.apache.skywalking.apm.agent.core.context.tag.Tags;
import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan; import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan;
import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer; import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine; import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
import org.apache.skywalking.apm.plugin.grpc.v1.OperationNameFormatUtil; import org.apache.skywalking.apm.plugin.grpc.v1.OperationNameFormatUtil;
import static org.apache.skywalking.apm.plugin.grpc.v1.Constants.RESPONSE_ON_CLOSE_OPERATION_NAME;
import static org.apache.skywalking.apm.plugin.grpc.v1.Constants.RESPONSE_ON_MESSAGE_OPERATION_NAME;
import static org.apache.skywalking.apm.plugin.grpc.v1.Constants.SERVER;
public class TracingServerCall<REQUEST, RESPONSE> extends ForwardingServerCall.SimpleForwardingServerCall<REQUEST, RESPONSE> { public class TracingServerCall<REQUEST, RESPONSE> extends ForwardingServerCall.SimpleForwardingServerCall<REQUEST, RESPONSE> {
private final String operationPrefix; private final String operationPrefix;
private final ContextSnapshot contextSnapshot;
private final AbstractSpan parentEntrySpan;
protected TracingServerCall(ServerCall<REQUEST, RESPONSE> delegate) { protected TracingServerCall(ServerCall<REQUEST, RESPONSE> delegate,
final ContextSnapshot contextSnapshot,
final AbstractSpan parentEntrySpan) {
super(delegate); super(delegate);
this.operationPrefix = OperationNameFormatUtil.formatOperationName(delegate.getMethodDescriptor()) + SERVER; this.operationPrefix = OperationNameFormatUtil.formatOperationName(delegate.getMethodDescriptor()) + SERVER;
this.contextSnapshot = contextSnapshot;
this.parentEntrySpan = parentEntrySpan;
} }
@Override @Override
public void sendMessage(RESPONSE message) { public void sendMessage(RESPONSE message) {
// We just create the request on message span for server stream calls. // We just create the request on message span for server stream calls.
if (!getMethodDescriptor().getType().serverSendsOneMessage()) { if (!getMethodDescriptor().getType().serverSendsOneMessage()) {
final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + RESPONSE_ON_MESSAGE_OPERATION_NAME); final AbstractSpan span = ContextManager.createLocalSpan(
operationPrefix + RESPONSE_ON_MESSAGE_OPERATION_NAME);
span.setComponent(ComponentsDefine.GRPC); span.setComponent(ComponentsDefine.GRPC);
span.setLayer(SpanLayer.RPC_FRAMEWORK); span.setLayer(SpanLayer.RPC_FRAMEWORK);
ContextManager.continued(ServerInterceptor.CONTEXT_SNAPSHOT_KEY.get()); ContextManager.continued(contextSnapshot);
try { try {
super.sendMessage(message); super.sendMessage(message);
} catch (Throwable t) { } catch (Throwable t) {
@ -68,7 +76,7 @@ public class TracingServerCall<REQUEST, RESPONSE> extends ForwardingServerCall.S
final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + RESPONSE_ON_CLOSE_OPERATION_NAME); final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + RESPONSE_ON_CLOSE_OPERATION_NAME);
span.setComponent(ComponentsDefine.GRPC); span.setComponent(ComponentsDefine.GRPC);
span.setLayer(SpanLayer.RPC_FRAMEWORK); span.setLayer(SpanLayer.RPC_FRAMEWORK);
ContextManager.continued(ServerInterceptor.CONTEXT_SNAPSHOT_KEY.get()); ContextManager.continued(contextSnapshot);
switch (status.getCode()) { switch (status.getCode()) {
case OK: case OK:
break; break;
@ -94,7 +102,7 @@ public class TracingServerCall<REQUEST, RESPONSE> extends ForwardingServerCall.S
break; break;
} }
Tags.RPC_RESPONSE_STATUS_CODE.set(span, status.getCode().name()); Tags.RPC_RESPONSE_STATUS_CODE.set(span, status.getCode().name());
ServerInterceptor.ACTIVE_SPAN_KEY.get().asyncFinish(); parentEntrySpan.asyncFinish();
try { try {
super.close(status, trailers); super.close(status, trailers);

17
apm-sniffer/apm-sdk-plugin/grpc-1.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/grpc/v1/server/TracingServerCallListener.java
View File

@ -22,6 +22,7 @@ import io.grpc.ForwardingServerCallListener;
import io.grpc.MethodDescriptor; import io.grpc.MethodDescriptor;
import io.grpc.ServerCall; import io.grpc.ServerCall;
import org.apache.skywalking.apm.agent.core.context.ContextManager; import org.apache.skywalking.apm.agent.core.context.ContextManager;
import org.apache.skywalking.apm.agent.core.context.ContextSnapshot;
import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan; import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan;
import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer; import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer;
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine; import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
@ -34,11 +35,17 @@ import org.apache.skywalking.apm.plugin.grpc.v1.OperationNameFormatUtil;
public class TracingServerCallListener<REQUEST> extends ForwardingServerCallListener.SimpleForwardingServerCallListener<REQUEST> { public class TracingServerCallListener<REQUEST> extends ForwardingServerCallListener.SimpleForwardingServerCallListener<REQUEST> {
private final MethodDescriptor.MethodType methodType; private final MethodDescriptor.MethodType methodType;
private final String operationPrefix; private final String operationPrefix;
private final ContextSnapshot contextSnapshot;
private final AbstractSpan parentEntrySpan;
protected TracingServerCallListener(ServerCall.Listener<REQUEST> delegate, MethodDescriptor<REQUEST, ?> descriptor) { protected TracingServerCallListener(ServerCall.Listener<REQUEST> delegate, MethodDescriptor<REQUEST, ?> descriptor,
final ContextSnapshot contextSnapshot,
final AbstractSpan parentEntrySpan) {
super(delegate); super(delegate);
this.methodType = descriptor.getType(); this.methodType = descriptor.getType();
this.operationPrefix = OperationNameFormatUtil.formatOperationName(descriptor) + SERVER; this.operationPrefix = OperationNameFormatUtil.formatOperationName(descriptor) + SERVER;
this.contextSnapshot = contextSnapshot;
this.parentEntrySpan = parentEntrySpan;
} }
@Override @Override
@ -48,7 +55,7 @@ public class TracingServerCallListener<REQUEST> extends ForwardingServerCallList
final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + REQUEST_ON_MESSAGE_OPERATION_NAME); final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + REQUEST_ON_MESSAGE_OPERATION_NAME);
span.setComponent(ComponentsDefine.GRPC); span.setComponent(ComponentsDefine.GRPC);
span.setLayer(SpanLayer.RPC_FRAMEWORK); span.setLayer(SpanLayer.RPC_FRAMEWORK);
ContextManager.continued(ServerInterceptor.CONTEXT_SNAPSHOT_KEY.get()); ContextManager.continued(contextSnapshot);
try { try {
super.onMessage(message); super.onMessage(message);
} catch (Throwable t) { } catch (Throwable t) {
@ -67,7 +74,7 @@ public class TracingServerCallListener<REQUEST> extends ForwardingServerCallList
final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + REQUEST_ON_CANCEL_OPERATION_NAME); final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + REQUEST_ON_CANCEL_OPERATION_NAME);
span.setComponent(ComponentsDefine.GRPC); span.setComponent(ComponentsDefine.GRPC);
span.setLayer(SpanLayer.RPC_FRAMEWORK); span.setLayer(SpanLayer.RPC_FRAMEWORK);
ContextManager.continued(ServerInterceptor.CONTEXT_SNAPSHOT_KEY.get()); ContextManager.continued(contextSnapshot);
try { try {
super.onCancel(); super.onCancel();
} catch (Throwable t) { } catch (Throwable t) {
@ -75,7 +82,7 @@ public class TracingServerCallListener<REQUEST> extends ForwardingServerCallList
throw t; throw t;
} finally { } finally {
ContextManager.stopSpan(); ContextManager.stopSpan();
ServerInterceptor.ACTIVE_SPAN_KEY.get().asyncFinish(); parentEntrySpan.asyncFinish();
} }
} }
@ -84,7 +91,7 @@ public class TracingServerCallListener<REQUEST> extends ForwardingServerCallList
final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + REQUEST_ON_HALF_CLOSE_OPERATION_NAME); final AbstractSpan span = ContextManager.createLocalSpan(operationPrefix + REQUEST_ON_HALF_CLOSE_OPERATION_NAME);
span.setComponent(ComponentsDefine.GRPC); span.setComponent(ComponentsDefine.GRPC);
span.setLayer(SpanLayer.RPC_FRAMEWORK); span.setLayer(SpanLayer.RPC_FRAMEWORK);
ContextManager.continued(ServerInterceptor.CONTEXT_SNAPSHOT_KEY.get()); ContextManager.continued(contextSnapshot);
try { try {
super.onHalfClose(); super.onHalfClose();
} catch (Throwable t) { } catch (Throwable t) {