upstream-hocuspocus/packages/extension-logger

@hocuspocus/extension-logger

Logs connection, document, and lifecycle events for a Hocuspocus server to the console. Useful during development and debugging to see when clients connect, documents load and store, and changes come in.

Installation

npm install @hocuspocus/extension-logger

Usage

import { Server } from "@hocuspocus/server"
import { Logger } from "@hocuspocus/extension-logger"

const server = new Server({
  extensions: [new Logger()],
})

server.listen()

Silence specific hooks

Pass booleans per hook to quiet down the ones you don't care about:

new Logger({
  onConnect: false,
  onDisconnect: false,
  onChange: false,
})

Use a custom log function

Route output to your own logger (pino, winston, structured JSON, etc.):

new Logger({
  log: (...args) => myLogger.info({ msg: args.join(" ") }),
})

Documentation

Full options reference: tiptap.dev/docs/hocuspocus/server/extensions/logger.

License

MIT — see LICENSE.md.