WebSocket logging

Log WebSocket open, message, and close events

Use wrapWs on the plugin instance to add lifecycle logs for WebSocket routes:

import { Elysia } from 'elysia'
import logixlysia from 'logixlysia'

const plugin = logixlysia({
  config: {
    service: 'chat'
  }
})

interface ChatWs {
  send(data: unknown): void
}

const app = new Elysia().use(plugin).ws('/chat', {
  ...plugin.wrapWs('/chat', {
    open(ws) {
      ;(ws as unknown as ChatWs).send('connected')
    },
    message(ws, message) {
      ;(ws as unknown as ChatWs).send(message)
    },
    close(ws) {
      console.log('bye', ws.id)
    }
  })
})

The hooks type the socket as the plugin’s WebSocketLike, which does not declare send, so the example casts it to a local ChatWs; a typed default is a planned library improvement.

A hook may reply by returning a value, a promise or a generator; wrapWs passes whatever Elysia accepts from a hook on to Elysia unchanged, so a wrapped hook replies exactly as an unwrapped one does.

Each lifecycle event logs with HTTP method WS, the route path, the connection’s age (shown where an HTTP line shows its duration), status 200 on every line, and optional wsId in context. Your close hook receives the WebSocket’s close code and reason, and the “WebSocket closed” line logs them too.

Request context on WebSockets

Accumulate context with the WebSocket instance as the key:

.ws('/chat', {
  ...plugin.wrapWs('/chat', {
    message(ws, payload) {
      plugin.store.logger.mergeContext(ws, { lastPayloadType: typeof payload })
    }
  })
})

The plugin stores context per connection, so a value merged in open is still there on later message and close lines.

Disable WebSocket logs

logixlysia({
  config: {
    disableWebSocketLogging: true
  }
})