Skip to content

Commit cc7732f

Browse files
wuwen5wuwen5
committed
Enhance tracing in Redis reactive publisher interceptors with local span creation and context propagation
1 parent 42f947e commit cc7732f

4 files changed

Lines changed: 108 additions & 36 deletions

File tree

‎apm-sniffer/apm-sdk-plugin/lettuce-plugins/lettuce-5.x-6.4.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/lettuce/v5/RedisReactiveCreatePublisherMethodInterceptorV5.java‎

Lines changed: 25 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,12 @@
2020

2121
import org.apache.skywalking.apm.agent.core.context.ContextManager;
2222
import org.apache.skywalking.apm.agent.core.context.ContextSnapshot;
23+
import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan;
24+
import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer;
2325
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
2426
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.v2.InstanceMethodsAroundInterceptorV2;
2527
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.v2.MethodInvocationContext;
28+
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
2629
import reactor.core.publisher.Flux;
2730
import reactor.core.publisher.Mono;
2831
import reactor.util.context.Context;
@@ -53,31 +56,34 @@ public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allA
5356
if (!(ret instanceof Mono) && !(ret instanceof Flux)) {
5457
return ret;
5558
}
59+
final AbstractSpan localSpan = ContextManager.createLocalSpan("Lettuce/Reactive/" + method.getName());
60+
localSpan.setComponent(ComponentsDefine.LETTUCE);
61+
SpanLayer.asCache(localSpan);
5662

57-
final ContextSnapshot snapshot;
58-
if (ContextManager.isActive()) {
59-
snapshot = ContextManager.capture();
60-
} else {
61-
return ret;
62-
}
63+
try {
64+
final ContextSnapshot snapshot = ContextManager.capture();
6365

64-
Function<Context, Context> contextFunction = ctx -> {
65-
if (ctx.hasKey(SNAPSHOT_KEY)) {
66-
return ctx;
67-
}
68-
return ctx.put(SNAPSHOT_KEY, snapshot);
69-
};
66+
Function<Context, Context> contextFunction = ctx -> {
67+
if (ctx.hasKey(SNAPSHOT_KEY)) {
68+
return ctx;
69+
}
70+
return ctx.put(SNAPSHOT_KEY, snapshot);
71+
};
7072

71-
if (ret instanceof Mono) {
72-
Mono<?> original = (Mono<?>) ret;
73-
return original.subscriberContext(contextFunction);
74-
} else {
75-
Flux<?> original = (Flux<?>) ret;
76-
return original.subscriberContext(contextFunction);
73+
if (ret instanceof Mono) {
74+
Mono<?> original = (Mono<?>) ret;
75+
return original.subscriberContext(contextFunction);
76+
} else {
77+
Flux<?> original = (Flux<?>) ret;
78+
return original.subscriberContext(contextFunction);
79+
}
80+
} finally {
81+
ContextManager.stopSpan();
7782
}
7883
}
7984

8085
@Override
81-
public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[] argumentsTypes, Throwable t, MethodInvocationContext context) {
86+
public void handleMethodException(EnhancedInstance objInst, Method method, Object[] allArguments, Class<?>[]
87+
argumentsTypes, Throwable t, MethodInvocationContext context) {
8288
}
8389
}

‎apm-sniffer/apm-sdk-plugin/lettuce-plugins/lettuce-6.5.x-plugin/src/main/java/org/apache/skywalking/apm/plugin/lettuce/v65/RedisReactiveCreatePublisherMethodInterceptorV65.java‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,12 @@
2020

2121
import org.apache.skywalking.apm.agent.core.context.ContextManager;
2222
import org.apache.skywalking.apm.agent.core.context.ContextSnapshot;
23+
import org.apache.skywalking.apm.agent.core.context.trace.AbstractSpan;
24+
import org.apache.skywalking.apm.agent.core.context.trace.SpanLayer;
2325
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.EnhancedInstance;
2426
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.v2.InstanceMethodsAroundInterceptorV2;
2527
import org.apache.skywalking.apm.agent.core.plugin.interceptor.enhance.v2.MethodInvocationContext;
28+
import org.apache.skywalking.apm.network.trace.component.ComponentsDefine;
2629
import org.reactivestreams.Publisher;
2730
import reactor.core.publisher.Flux;
2831
import reactor.core.publisher.Mono;
@@ -53,14 +56,17 @@ public Object afterMethod(EnhancedInstance objInst, Method method, Object[] allA
5356
return ret;
5457
}
5558

56-
final ContextSnapshot snapshot;
57-
if (ContextManager.isActive()) {
58-
snapshot = ContextManager.capture();
59-
} else {
60-
return ret;
61-
}
59+
final AbstractSpan localSpan = ContextManager.createLocalSpan("Lettuce/Reactive/" + method.getName());
60+
localSpan.setComponent(ComponentsDefine.LETTUCE);
61+
SpanLayer.asCache(localSpan);
6262

63-
return wrapPublisher((Publisher<?>) ret, snapshot);
63+
try {
64+
final ContextSnapshot snapshot = ContextManager.capture();
65+
66+
return wrapPublisher((Publisher<?>) ret, snapshot);
67+
} finally {
68+
ContextManager.stopSpan();
69+
}
6470
}
6571

6672
private <T> Publisher<T> wrapPublisher(Publisher<T> original, ContextSnapshot snapshot) {

‎test/plugin/scenarios/lettuce-6.5.x-scenario/config/expectedData.yaml‎

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ segmentItems:
5959
spanType: Local
6060
refs:
6161
- { parentEndpoint: GET:/lettuce-6.5.x-scenario/case/lettuce-case, networkAddress: '', refType: CrossThread,
62-
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
62+
parentSpanId: 5, parentTraceSegmentId: not null, parentServiceInstance: not
6363
null, parentService: not null, traceId: not null }
6464
- segmentId: not null
6565
spans:
@@ -86,7 +86,7 @@ segmentItems:
8686
spanType: Local
8787
refs:
8888
- { parentEndpoint: GET:/lettuce-6.5.x-scenario/case/lettuce-case, networkAddress: '', refType: CrossThread,
89-
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
89+
parentSpanId: 6, parentTraceSegmentId: not null, parentServiceInstance: not
9090
null, parentService: not null, traceId: not null }
9191
- segmentId: not null
9292
spans:
@@ -138,14 +138,44 @@ segmentItems:
138138
- { key: cache.key, value: key1 }
139139
- { key: cache.cmd, value: SET }
140140
- { key: cache.op, value: write }
141-
- operationName: Lettuce/GET
142-
parentSpanId: 4
141+
- operationName: Lettuce/Reactive/createMono
142+
parentSpanId: 0
143+
spanId: 4
144+
spanLayer: Cache
145+
startTime: not null
146+
endTime: not null
147+
componentId: 57
148+
isError: false
149+
spanType: Local
150+
skipAnalysis: false
151+
- operationName: Lettuce/Reactive/createMono
152+
parentSpanId: 0
143153
spanId: 5
144154
spanLayer: Cache
145155
startTime: not null
146156
endTime: not null
147157
componentId: 57
148158
isError: false
159+
spanType: Local
160+
skipAnalysis: false
161+
- operationName: Lettuce/Reactive/createMono
162+
parentSpanId: 0
163+
spanId: 6
164+
spanLayer: Cache
165+
startTime: not null
166+
endTime: not null
167+
componentId: 57
168+
isError: false
169+
spanType: Local
170+
skipAnalysis: false
171+
- operationName: Lettuce/GET
172+
parentSpanId: 7
173+
spanId: 8
174+
spanLayer: Cache
175+
startTime: not null
176+
endTime: not null
177+
componentId: 57
178+
isError: false
149179
spanType: Exit
150180
peer: not null
151181
skipAnalysis: false
@@ -156,7 +186,7 @@ segmentItems:
156186
- { key: cache.op, value: read }
157187
- operationName: RedisReactive/local
158188
parentSpanId: 0
159-
spanId: 4
189+
spanId: 7
160190
isError: false
161191
spanType: Local
162192
- operationName: GET:/lettuce-6.5.x-scenario/case/lettuce-case

‎test/plugin/scenarios/lettuce-scenario/config/expectedData.yaml‎

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ segmentItems:
5959
spanType: Local
6060
refs:
6161
- { parentEndpoint: GET:/lettuce-scenario/case/lettuce-case, networkAddress: '', refType: CrossThread,
62-
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
62+
parentSpanId: 5, parentTraceSegmentId: not null, parentServiceInstance: not
6363
null, parentService: not null, traceId: not null }
6464
- segmentId: not null
6565
spans:
@@ -86,7 +86,7 @@ segmentItems:
8686
spanType: Local
8787
refs:
8888
- { parentEndpoint: GET:/lettuce-scenario/case/lettuce-case, networkAddress: '', refType: CrossThread,
89-
parentSpanId: 0, parentTraceSegmentId: not null, parentServiceInstance: not
89+
parentSpanId: 6, parentTraceSegmentId: not null, parentServiceInstance: not
9090
null, parentService: not null, traceId: not null }
9191
- segmentId: not null
9292
spans:
@@ -138,14 +138,44 @@ segmentItems:
138138
- { key: cache.key, value: key1 }
139139
- { key: cache.cmd, value: SET }
140140
- { key: cache.op, value: write }
141-
- operationName: Lettuce/GET
142-
parentSpanId: 4
141+
- operationName: Lettuce/Reactive/createMono
142+
parentSpanId: 0
143+
spanId: 4
144+
spanLayer: Cache
145+
startTime: not null
146+
endTime: not null
147+
componentId: 57
148+
isError: false
149+
spanType: Local
150+
skipAnalysis: false
151+
- operationName: Lettuce/Reactive/createMono
152+
parentSpanId: 0
143153
spanId: 5
144154
spanLayer: Cache
145155
startTime: not null
146156
endTime: not null
147157
componentId: 57
148158
isError: false
159+
spanType: Local
160+
skipAnalysis: false
161+
- operationName: Lettuce/Reactive/createMono
162+
parentSpanId: 0
163+
spanId: 6
164+
spanLayer: Cache
165+
startTime: not null
166+
endTime: not null
167+
componentId: 57
168+
isError: false
169+
spanType: Local
170+
skipAnalysis: false
171+
- operationName: Lettuce/GET
172+
parentSpanId: 7
173+
spanId: 8
174+
spanLayer: Cache
175+
startTime: not null
176+
endTime: not null
177+
componentId: 57
178+
isError: false
149179
spanType: Exit
150180
peer: not null
151181
skipAnalysis: false
@@ -156,7 +186,7 @@ segmentItems:
156186
- { key: cache.op, value: read }
157187
- operationName: RedisReactive/local
158188
parentSpanId: 0
159-
spanId: 4
189+
spanId: 7
160190
isError: false
161191
spanType: Local
162192
- operationName: GET:/lettuce-scenario/case/lettuce-case

0 commit comments

Comments
 (0)