Server span is not getting closed when using embedded Tomcat v9 with SpringBoot v2.6.15

[MaheshGPai]

I see that the auto instrumentation code is not closing the Server span when application is deployed with Tomcat v9 with SpringBoot v2.6.15

The reason for this is the that the below condition evaluates to false when the Request processing ends:

opentelemetry-java-instrumentation/instrumentation/tomcat/tomcat-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/tomcat/common/TomcatHelper.java

Line 52 in b739010

if (throwable != null || mustEndOnHandlerMethodExit(request)) {

    if (throwable != null || mustEndOnHandlerMethodExit(request)) {
      instrumenter.end(context, request, response, throwable);
    }

On further debugging the issue seems to be the HttpServletRequest type. The instrumentation is expecting an instance of jakarta.servlet.http.HttpServletRequest. But the actual instance type is javax.servlet.http.HttpServletRequest

Due to this mis-match, the servletEntityProvider returns null @

opentelemetry-java-instrumentation/instrumentation/tomcat/tomcat-common/javaagent/src/main/java/io/opentelemetry/javaagent/instrumentation/tomcat/common/TomcatHelper.java

Line 58 in b739010

REQUEST servletRequest = servletEntityProvider.getServletRequest(request);

  private boolean mustEndOnHandlerMethodExit(Request request) {
    REQUEST servletRequest = servletEntityProvider.getServletRequest(request);
    return servletRequest != null && servletHelper.mustEndOnHandlerMethodExit(servletRequest);
  }

Can you please advice how to over come this issue?

[laurit]

are you bundling both jakarta and javax servlet api inside your application?

[laurit]

Would it be possible to provide a minimal sample application that reproduces this issue?

[MaheshGPai]

There was one more jakarta dependecy that was causing this behaviour. After execluding jetty-jakarta-servlet-api, I see the spans are getting closed and exported as expected.

[MaheshGPai]

Is there any other way to handle? I presume this mixing up of jarkata & javax modules are quite common?

[laurit]

I presume this mixing up of jarkata & javax modules are quite common?

I don't think it is common as both of these dependencies can not reasonably co-exist in the same application. If both of them are included then it very likely that it is because of a mistake.

I have create a PR that hopefully resolves this #10757

[MaheshGPai]

Fair point. Thanks a lot for the pointers and the PR. Helped in quickly solving this!