Support access the tracer context in spring gateway filter #539

darknesstm · 2023-05-26T13:15:49Z

If this is non-trivial feature, paste the links/URLs to the design doc.
Update the documentation to include this new feature.
Tests(including UT, IT, E2E) are added to verify the new feature.
If it's UI related, attach the screenshots below.
If this pull request closes/resolves/fixes an existing issue, replace the issue number. [Feature] Support access the tracer context in the spring gateway filter skywalking#10862
Update the CHANGES log.

CHANGES.md

wu-sheng · 2023-05-26T14:21:30Z

Hi, this feature should be good. But you instrument a lot of things, could you try to put a doc about why you are instrumenting? And why there are so many things have to be done?

darknesstm · 2023-05-27T03:47:06Z

Hi, this feature should be good. But you instrument a lot of things, could you try to put a doc about why you are instrumenting? And why there are so many things have to be done?

I add a [Feature] issues linked to this.
The source is mainly based on the relevant source of apm-toolkit-trace, with some simple modifications.

wu-sheng · 2023-05-30T04:24:09Z

I am not sure why, but this PR doesn't drive CI running.

darknesstm · 2023-05-30T14:42:06Z

I am not sure why, but this PR doesn't drive CI running.

I also see the same problem in #541

wu-sheng · 2023-05-30T14:59:31Z

No, it isn't. That PR is waiting for maintainers' approval to run. But your PR doesn't.

Yours

That PR

darknesstm · 2023-05-30T15:05:46Z

It may be that the github actions of my account were banned before, and I didn't continue to pay attention without much impact, so I will submitted the a ticket and deal with that.

kezhenxu94 · 2023-06-01T10:59:44Z

You need to resolve conflicts before we can run the CI

wu-sheng · 2023-06-01T13:06:19Z

You need to resolve conflicts before we can run the CI

There was no conflict, still not working.

darknesstm · 2023-07-06T01:23:11Z

You need to resolve conflicts before we can run the CI

There was no conflict, still not working.

My Github Actions now works normally...

wu-sheng · 2023-07-06T04:56:21Z

Could you rebase your commits, 14 commits for now...

wu-sheng · 2023-07-06T07:02:15Z

.../apache/skywalking/apm/toolkit/activation/webflux/WebFluxSkyWalkingSegmentIDInterceptor.java

+    @Override
+    public void handleMethodException(Class clazz, Method method, Object[] allArguments, Class<?>[] parameterTypes,
+                                      Throwable t) {
+        LOGGER.error("Failed to getDefault segment Id.", t);


What is default segment ID? Anything not default?

...pache/skywalking/apm/toolkit/activation/webflux/WebFluxSkyWalkingTraceContextActivation.java

wu-sheng · 2023-07-06T07:04:42Z

...ywalking/apm/toolkit/activation/webflux/WebFluxSkyWalkingStaticMethodsAroundInterceptor.java

+
+public abstract class WebFluxSkyWalkingStaticMethodsAroundInterceptor implements StaticMethodsAroundInterceptor {
+
+    protected static EnhancedInstance getInstance(Object o) {


As protected, why static?

purpose was to serve as a internal-use static method

wu-sheng · 2023-07-06T07:04:50Z

...ywalking/apm/toolkit/activation/webflux/WebFluxSkyWalkingStaticMethodsAroundInterceptor.java

+        return instance;
+    }
+
+    protected static ContextSnapshot getContextSnapshot(Object o) {


wu-sheng · 2023-07-06T07:22:09Z

docs/en/setup/service-agent/java-agent/Application-toolkit-webflux.md

+        // fetch trace ID
+        String traceId = WebFluxSkyWalkingTraceContext.traceId(exchange);


Please update all APIs you added. This is an official doc, we should provide a complete version.

wuwen5 · 2023-07-06T15:16:45Z

BTW , If the feature of apache/skywalking#10862 is implemented with minimal modifications, it seems that only the putCorrelation method needs to be implemented, as the current WebFluxSkyWalkingOperators + TraceContext can support read operations.

e.g.

public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        ServerHttpRequest buildRequest = exchange.getRequest()
                .mutate()
                .headers(httpHeaders -> WebFluxSkyWalkingOperators.continueTracing(exchange, () -> {
                    httpHeaders.add("x-trace-id", TraceContext.traceId());
                    httpHeaders.add("x-segment-id", TraceContext.segmentId());
                    httpHeaders.add("x-span-id", String.valueOf(TraceContext.spanId()));
                }))
                .build();
        return chain.filter(exchange.mutate().request(buildRequest).build());
    }

wu-sheng · 2023-07-06T15:18:52Z

Good catch. @darknesstm Let's minimal the changes.

darknesstm · 2023-07-07T01:20:49Z

BTW , If the feature of apache/skywalking#10862 is implemented with minimal modifications, it seems that only the putCorrelation method needs to be implemented, as the current WebFluxSkyWalkingOperators + TraceContext can support read operations.

e.g.

public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {

        ServerHttpRequest buildRequest = exchange.getRequest()
                .mutate()
                .headers(httpHeaders -> WebFluxSkyWalkingOperators.continueTracing(exchange, () -> {
                    httpHeaders.add("x-trace-id", TraceContext.traceId());
                    httpHeaders.add("x-segment-id", TraceContext.segmentId());
                    httpHeaders.add("x-span-id", String.valueOf(TraceContext.spanId()));
                }))
                .build();
        return chain.filter(exchange.mutate().request(buildRequest).build());
    }

In this context WebFluxSkyWalkingOperators.continueTracing will add a meaningless LocalSpan

wu-sheng · 2023-07-07T09:15:11Z

In this context WebFluxSkyWalkingOperators.continueTracing will add a meaningless LocalSpan

Make sense. You are correct. Keep what you have built. But please update others accordingly.

wu-sheng

LGTM

Co-authored-by: darknesstm <[email protected]>

wu-sheng reviewed May 26, 2023

View reviewed changes

CHANGES.md Show resolved Hide resolved

wu-sheng changed the title ~~Support access the sky-walking tracer context in spring gateway filter~~ Support access the tracer context in spring gateway filter May 26, 2023

wu-sheng added plugin feature labels May 26, 2023

wu-sheng reviewed Jul 6, 2023

View reviewed changes

...pache/skywalking/apm/toolkit/activation/webflux/WebFluxSkyWalkingTraceContextActivation.java Outdated Show resolved Hide resolved

wu-sheng reviewed Jul 6, 2023

View reviewed changes

darknesstm force-pushed the feature/scg_filter branch from 8e121f7 to b6bb310 Compare July 7, 2023 16:26

darknesstm added 6 commits July 8, 2023 00:30

Support access the sky-walking tracer context in spring gateway filter

a96c698

add WebFluxSkyWalkingTraceContext sample code.

624322c

update plugin def

c0b2532

fix source for checkStyle

81f33d6

add test for WebFluxSkyWalkingTraceContext

36a7a21

make operations on CorrelationContext thread-safe

2879f20

wu-sheng and others added 2 commits July 8, 2023 00:30

Polish the doc

d7aaeeb

fix after source review

51ba252

darknesstm force-pushed the feature/scg_filter branch from b6bb310 to 51ba252 Compare July 7, 2023 16:31

wu-sheng added this to the 9.0.0 milestone Jul 7, 2023

wu-sheng approved these changes Jul 7, 2023

View reviewed changes

wu-sheng merged commit c9a6170 into apache:main Jul 7, 2023

darknesstm deleted the feature/scg_filter branch July 8, 2023 01:38

wu-sheng mentioned this pull request Jul 30, 2023

[Feature] Support access the tracer context in the spring gateway filter apache/skywalking#10862

Closed

3 tasks

yangyulely pushed a commit to yangyulely/skywalking-java that referenced this pull request May 25, 2024

Support access the tracer context in spring gateway filter (apache#539)

457f7ae

Co-authored-by: darknesstm <[email protected]>

wuwen5 mentioned this pull request Dec 10, 2024

[Feature] Support Tracing for GlobalFilter and GatewayFilter in Gateway #736

Merged

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support access the tracer context in spring gateway filter #539

Support access the tracer context in spring gateway filter #539

darknesstm commented May 26, 2023 •

edited

Loading

wu-sheng commented May 26, 2023

darknesstm commented May 27, 2023

wu-sheng commented May 30, 2023

darknesstm commented May 30, 2023

wu-sheng commented May 30, 2023

darknesstm commented May 30, 2023

kezhenxu94 commented Jun 1, 2023

wu-sheng commented Jun 1, 2023

darknesstm commented Jul 6, 2023

wu-sheng commented Jul 6, 2023

wu-sheng Jul 6, 2023

wu-sheng Jul 6, 2023

darknesstm Jul 7, 2023

wu-sheng Jul 6, 2023

wu-sheng Jul 6, 2023

wuwen5 commented Jul 6, 2023

wu-sheng commented Jul 6, 2023

darknesstm commented Jul 7, 2023

wu-sheng commented Jul 7, 2023

wu-sheng left a comment


		public abstract class WebFluxSkyWalkingStaticMethodsAroundInterceptor implements StaticMethodsAroundInterceptor {

		protected static EnhancedInstance getInstance(Object o) {

		// fetch trace ID
		String traceId = WebFluxSkyWalkingTraceContext.traceId(exchange);

Support access the tracer context in spring gateway filter #539

Support access the tracer context in spring gateway filter #539

Conversation

darknesstm commented May 26, 2023 • edited Loading

wu-sheng commented May 26, 2023

darknesstm commented May 27, 2023

wu-sheng commented May 30, 2023

darknesstm commented May 30, 2023

wu-sheng commented May 30, 2023

darknesstm commented May 30, 2023

kezhenxu94 commented Jun 1, 2023

wu-sheng commented Jun 1, 2023

darknesstm commented Jul 6, 2023

wu-sheng commented Jul 6, 2023

wu-sheng Jul 6, 2023

Choose a reason for hiding this comment

wu-sheng Jul 6, 2023

Choose a reason for hiding this comment

darknesstm Jul 7, 2023

Choose a reason for hiding this comment

wu-sheng Jul 6, 2023

Choose a reason for hiding this comment

wu-sheng Jul 6, 2023

Choose a reason for hiding this comment

wuwen5 commented Jul 6, 2023

wu-sheng commented Jul 6, 2023

darknesstm commented Jul 7, 2023

wu-sheng commented Jul 7, 2023

wu-sheng left a comment

Choose a reason for hiding this comment

darknesstm commented May 26, 2023 •

edited

Loading