Skip to content

Add WS Bad Closure Failover Mechanism #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cawthorne merged 4 commits into from
Mar 5, 2026
Merged

Add WS Bad Closure Failover Mechanism #705

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7536f42
Add WS Bad Closure Failover Mechanism
cawthorne Mar 5, 2026
7361d18
Add more test cases
cawthorne Mar 5, 2026
677aabe
lint
cawthorne Mar 5, 2026
b390fdc
Make setter function for failover counter
cawthorne Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 17 additions & 12 deletions src/transports/websocket.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,20 +289,25 @@ export class WebSocketTransport<

// Called when the WS connection closes for any reason
close: (event: WebSocket.CloseEvent) => {
// If the connection closed with 1000, it's a usual closure
const level = event.code === 1000 ? 'debug' : 'info'
logger[level](
`Closed websocket connection. Code: ${event.code} ; reason: ${event.reason?.toString()}`,
)
const filteredUrl = this.currentUrl.split('?')[0]
const isAbnormal = event.code !== 1000
Comment thread
cawthorne marked this conversation as resolved.

// Record active ws connections by decrementing count on close
// Using URL in label since connection_key is removed from v3
metrics.get('wsConnectionActive').dec()
if (isAbnormal) {
this.streamHandlerInvocationsWithNoConnection += 1
logger.warn(
`WebSocket closed abnormally (code: ${event.code}, reason: ${event.reason?.toString() || 'none'}). ` +
`Failover counter incremented to ${this.streamHandlerInvocationsWithNoConnection}. ` +
`URL: ${filteredUrl}`,
)
metrics
.get('wsConnectionFailoverCount')
.labels({ transport_name: this.name, url: filteredUrl })
.set(this.streamHandlerInvocationsWithNoConnection)
Comment thread
cawthorne marked this conversation as resolved.
Outdated
} else {
logger.debug(`WebSocket closed normally (code: ${event.code}). URL: ${filteredUrl}`)
}

// Also, register that the connection was closed and the reason why.
// We need to filter out query params from the URL to avoid having
// the cardinality of the metric go out of control.
const filteredUrl = this.currentUrl.split('?')[0]
metrics.get('wsConnectionActive').dec()
metrics.get('wsConnectionClosures').inc({
code: event.code,
url: filteredUrl,
Expand Down
Loading
Loading