@livy/websocket-handler

This Livy handler sends log records to a WebSocket using Engine.IO.

Synchronous logger support: no

Runtime: Node.js and browsers

Basic Example

const { WebSocketHandler } = require('@livy/websocket-handler')

const handler = new WebSocketHandler('wss://example.com/logs')

Installation

Install it via npm:

npm install @livy/websocket-handler

Options

The first argument to this handler's constructor contains the WebSocket endpoint to connect to.

An object of options can be passed as the second argument.

The following options are available:

bubble

Type: boolean

Default: true

Description: Controls whether records handled by this handler should bubble up to other handlers.

See also: Bubbling

connection

Type: object

Default: {}

Description: An object of Engine.IO initialization options.

formatter

Type: FormatterInterface

Default: new JsonFormatter

Description: The formatter to use.

level

Type: LogLevel

Default: 'debug'

Description: Controls which log records should be handled based on their log level.

Public API

bubble

Controls whether records handled by this handler should bubble up to other handlers. Initially set through the bubble option.

See also: Bubbling

close()

This handler implements the ClosableHandlerInterface. On cleanup, it closes the WebSocket connection.

You usually don't want to call this method manually. It is done automatically when a Node.js process exits / a browser page is closed.

defaultFormatter (read-only)

The formatter used by this handler if no formatter option is set.

formatter

This handler supports formatters by implementing the FormattableHandlerInterface.

level

The minimum log level of a log record to be considered by this handler. Initially set through the level option.

processors

This handler supports processors by implementing the ProcessableHandlerInterface.

reset()

This handler implements the ResettableInterface. Resetting it resets all attached processors.

You usually don't want to call this method manually on an individual handler. Consider calling it on the logger instead.