Add telemetry event span for socket dispatch #6019
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The reason for adding this telemetry event is that my OTel spans are full of WebSocket connections that just reads
GET
. This is because Bandit will just use the method which is correct as the URL may be high cardinality, however the socket path is low cardinality and should show up as e.g.GET /live/websocket
.Since socket requests are handled and halted before the rest of the endpoint plugs I can't depend on
Plug.Telemetry
to report them and use the[:phoenix, :endpoint]
events. I could depend on[:phoenix, :socket_connected]
but this will only be for successful connections.So I'm proposing that we add a
[:phoenix, :socket_dispatch]
event matching the[:phoenix, :router_dispatch]
events. It somewhat conflicts with the existing[:phoenix, :socket_connected]
though this event only have high level metadata vs socket connected having connection metadata including the result of setting up the socket.With the ability to attach to this telemetry event we can update the
:opentelemetry_phoenix
to update the span name with the route template in the same way it currently does for router dispatch events.