Jetty 11 instrumentation sets `http.route` to `/*` instead of actual route

[vincentlejeune]

Hello OpenTelemetry team,

I'm using the OpenTelemetry Java agent to instrument my Java application, which runs on Jetty 11. I've noticed that all HTTP server spans have the http.route attribute set to /*, regardless of the actual request path. However, the url.path attribute correctly reflects the full request path.

I understand that the Jetty 11 instrumentation is supported, as per the supported libraries documentation. However, it seems that the instrumentation does not capture the specific route patterns, leading to http.route being set to a generic /*.

I attempted to manually instrument the application to set the http.route attribute more accurately. While this approach allows me to set the desired value, it results in duplicate spans in my traces.

Is there a recommended way to have the Jetty 11 instrumentation capture the correct http.route values without resorting to manual instrumentation? Alternatively, is there guidance on how to suppress the automatic spans when adding manual instrumentation to avoid duplication?

Thank you for your assistance.

[laurit]

This is expected. https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/ sets the following requirements for the route

MUST NOT be populated when this is not supported by the HTTP server framework as the route attribute should have low-cardinality and the URI path can NOT substitute it. SHOULD include the application root if there is one.

For servlets the best we can use for route the is the path that the servlet is mapped to. Usually route is provided by a higher level framework that runs on top of jetty or other servlet container.
You can set the route from the application by calling

opentelemetry-java-instrumentation/instrumentation-api/src/main/java/io/opentelemetry/instrumentation/api/semconv/http/HttpServerRoute.java

Line 60 in 1ac6cc0

public static void update(

this is what framework instrumentations also use.

[github-actions]

This has been automatically marked as stale because it has been marked as needing author feedback and has not had any activity for 7 days. It will be closed automatically if there is no response from the author within 7 additional days from this comment.

[john9x]

Alternatively, is there guidance on how to suppress the automatic spans when adding manual instrumentation to avoid duplication?

@vincentlejeune I achieve this using

HttpServerRoute.update(Context.current(), HttpServerRouteSource.CONTROLLER,  newRoute);

inside Servlet service method. To avoid duplication you should not to create a new span but to use current already created by instrumentation agent.

[github-actions]

This has been automatically marked as stale because it has been marked as needing author feedback and has not had any activity for 7 days. It will be closed automatically if there is no response from the author within 7 additional days from this comment.