Support access the tracer context in spring gateway filter

[darknesstm]

• 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.

[wu-sheng]

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]

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]

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

[darknesstm]

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

I also see the same problem in #541

[wu-sheng]

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

Yours

That PR

[darknesstm]

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]

You need to resolve conflicts before we can run the CI

[wu-sheng]

You need to resolve conflicts before we can run the CI

There was no conflict, still not working.

[darknesstm]

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]

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

[wu-sheng]

What is default segment ID? Anything not default?

[wu-sheng]

As protected, why static?

[darknesstm]

purpose was to serve as a internal-use static method

[wu-sheng]

Same here.

[wu-sheng]

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

[wuwen5]

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]

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

[darknesstm]

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]

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