Skip to main content

useOtelWebSocket

Datalayer Core


Datalayer Core / useOtelWebSocket

Function: useOtelWebSocket()

useOtelWebSocket(options): object

Defined in: src/otel/hooks/index.ts:623

Connect to the OTEL service WebSocket for live telemetry streaming.

The server pushes JSON messages whenever new data is flushed to storage. Authentication is via the token query parameter (JWT or API key).

Parameters

options

autoReconnect?

boolean

Whether to automatically reconnect on disconnect. Default true.

baseUrl?

string

OTEL service base URL (e.g. http://localhost:7800).

callbacks?

OtelWsCallbacks

Callbacks for signal events.

reconnectDelayMs?

number

Reconnect delay in ms. Default 3000.

token?

string

JWT token or API key for authentication.

Returns

object

{ connected, error, close } – reactive connection state.

close

close: () => void

Returns

void

connected

connected: boolean

error

error: string | null