Interface ws

This plugin automatically instruments the ws module.

interface ws {
    enabled?: boolean;
    measured?: boolean | { [key: string]: boolean };
    service?: any;
    traceWebsocketMessagesEnabled?: boolean;
}

Properties

enabled?: boolean

Whether to enable the plugin.

true

measured?: boolean | { [key: string]: boolean }

Whether to measure the span. Can also be set to a key-value pair with span names as keys and booleans as values for more granular control.

service?: any

The service name to be used for this plugin.

traceWebsocketMessagesEnabled?: boolean

Controls whether websocket messages should be traced. This is also configurable via DD_TRACE_WEBSOCKET_MESSAGES_ENABLED.