Inconsistent Endpoint Metrics in SkyWalking Affecting Traffic Management Accuracy

[angryxie]

Problem Description

I found an issue with the way SkyWalking collects endpoint_name for SpringMVC services. Instead of using the original URI, it collects the first value defined in the @RequestMapping annotation.

For example:

@RequestMapping(value = {"/index", "/index1", "/index2"}, method = RequestMethod.GET)

In this case, the endpoint_name will be GET:/index, even if the original request URI is /index2.

Upon reviewing the source code, this behavior is confirmed.

public String getRequestURL(Method method) {
        return ParsePathUtil.recursiveParseMethodAnnotation(method, m -> {
            String requestURL = null;
            RequestMapping methodRequestMapping = AnnotationUtils.getAnnotation(m, RequestMapping.class);
            if (methodRequestMapping != null) {
                requestURL = methodRequestMapping.value().length > 0 ? methodRequestMapping.value()[0] : "";
            }
            return requestURL;
        });
    }

Potential Impact

It causes confusion when I try to use SkyWalking metrics for traffic management.

Question

Is there any plan to allow collecting the original URI through configuration in the future?

[wu-sheng]

I think there was a discussion about it, but no one proposed a change to support this case. We need someone to update the plugin and add a new interceptor to set the name.

[angryxie]

I think it's sufficient to keep it consistent with the URL in the tags and abandon the use of EnhanceRequireObjectCache, because the method and URI are 1-to-1 in EnhanceRequireObjectCache.

For example, the following:

        String operationName = this.buildOperationName(method, httpServletRequest.getMethod(), (EnhanceRequireObjectCache) objInst.getSkyWalkingDynamicField());
        AbstractSpan span = ContextManager.createEntrySpan(operationName, contextCarrier);
        Tags.URL.set(span, httpServletRequest.getRequestURL().toString());
        Tags.HTTP.METHOD.set(span, httpServletRequest.getMethod());

Can be simplified to:

        String url =httpServletRequest.getRequestURL().toString();
        String operationName = this.buildOperationName(method, httpServletRequest.getMethod(),url);
        AbstractSpan span = ContextManager.createEntrySpan(operationName, contextCarrier);
        Tags.URL.set(span, url);

[wu-sheng]

Using raw URL is not good. It would bring parameters into the endpoint.

[angryxie]

in Spring WebFlux, it is indeed like this. 🤔

[wu-sheng]

Not just Web flux, all restful API is like that.

[angryxie]

got it