Setting HTTP_ROUTE inconsistent accross HTTP server frameworks

[Flarna]

HTTP_ROUTE propagation from HTTP server frameworks to HTTP span is inconsistent:

• connect updates only the span name
• express, koa and restify update the span name and return the route via rpcData where Http instrumentation pickes it up
• hapi and fastify update the span name and additionally set HTTP_ROUTE directly on HTTP span

I think all frameworks should avoid modifications of the HTTP span directly instead return the route info via rpcData and leave it up to the HTTP instrumentation to build the final span name and set the HTTP_ROUTE attribute.

Setting HTTP_ROUTE directly breaks for example the assumption done in this PR.

[github-actions]

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 14 days.

[chigia001]

Hey @Flarna, not sure if I can pick this task?

When working on this, should we split it into multiple PR for each framework?

[Flarna]

Sure, feel free to start. I haven't found time to start.

I would start a PR for one framework and once the way how to do it is agree do the remaining ones.

[chigia001]

Current status:

• connect: merged fix(connect): Skip update HTTP's span name and update RpcMetadata's route instead #1534
• express: PR feat(express): Skip update HTTP's span name and update RpcMetadata's route instead #1557
• koa: PR feat(koa): Skip update HTTP's span name and update RpcMetadata's route instead #1567
• resitfy: PR feat(restify): Skip update HTTP's span name and update RpcMetadata's route instead #1571
• hapi: PR feat(hapi): Skip update HTTP's span name and update RpcMetadata's route instead #1570
• fastify: PR feat(fastify): Skip update HTTP's span name and update RpcMetadata's route instead #1569

[JamieDanielson]

We've merged in the change for Express but it looks like there were some unexpected issues that came up. Let's double check these other PRs for Restify, Fastify, Hapi, and Koa to see if we can update those before they are merged in if they have the same problem.

[chigia001]

@JamieDanielson Yes, I double check and koa seem to have the same issue

I just push a fix for that.