Classes

ObservabilityClient

ObservabilityClient class Main client for integrating observability into browser applications

Constructor

constructor(config: ObservabilityConfig)

Parameters:

Parameter	Type	Required	Description
`config`	`ObservabilityConfig`	Yes

Methods

init

Initialize the client

init(): void

shutdown

Shutdown the client

shutdown(): void

captureError

Capture error manually

captureError(error: Error, context?: Record<string, any> | undefined): void

Parameters:

Parameter	Type	Required	Description
`error`	`Error`	Yes
`context`	`Record<string, any> \| undefined`	No

captureException

Capture exception (alias for captureError)

captureException(error: Error, context?: Record<string, any> | undefined): void

Parameters:

Parameter	Type	Required	Description
`error`	`Error`	Yes
`context`	`Record<string, any> \| undefined`	No

log

Generic log method

log(level: "error" | "debug" | "info" | "warn", message: string, data?: Record<string, any> | undefined): void

Parameters:

Parameter	Type	Required
`level`	`"error" \| "debug" \| "info" \| "warn"`	Yes
`message`	`string`	Yes
`data`	`Record<string, any> \| undefined`	No

debug

Log debug message

debug(message: string, data?: any): void

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`data`	`any`	No

info

Log info message

info(message: string, data?: any): void

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`data`	`any`	No

warn

Log warning message

warn(message: string, data?: any): void

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`data`	`any`	No

error

Log error message

error(message: string, data?: any): void

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`data`	`any`	No

Add breadcrumb

addBreadcrumb(breadcrumb: Breadcrumb): void

Parameters:

Parameter	Type	Required	Description
`breadcrumb`	`Breadcrumb`	Yes

setUser

Set user context

setUser(userId: string, _userData?: Record<string, any> | undefined): void

Parameters:

Parameter	Type	Required	Description
`userId`	`string`	Yes
`_userData`	`Record<string, any> \| undefined`	No

clearUser

Clear user context

clearUser(): void

setContext

Set custom context

setContext(key: string, value: any): void

Parameters:

Parameter	Type	Required	Description
`key`	`string`	Yes
`value`	`any`	Yes

clearContext

Clear custom context

clearContext(key?: string | undefined): void

Parameters:

Parameter	Type	Required	Description
`key`	`string \| undefined`	No

setTag

Set tag

setTag(key: string, value: string): void

Parameters:

Parameter	Type	Required	Description
`key`	`string`	Yes
`value`	`string`	Yes

WebSocketClient

WebSocket Client class Manages WebSocket connections with automatic reconnection, message buffering, and heartbeat

Constructor

constructor(config: WebSocketClientConfig)

Parameters:

Parameter	Type	Required	Description
`config`	`WebSocketClientConfig`	Yes

Methods

connect

Connect to WebSocket server

connect(): void

disconnect

Disconnect from WebSocket server

disconnect(): void

sendError

Send error event to server

sendError(event: ErrorEvent): void

Parameters:

Parameter	Type	Required	Description
`event`	`ErrorEvent`	Yes

sendLog

Send log event to server

sendLog(event: LogEvent): void

Parameters:

Parameter	Type	Required	Description
`event`	`LogEvent`	Yes

getState

Get current connection state

getState(): ConnectionState

Returns:

ConnectionState -

on

on(event: "stateChange", callback: EventListener): void

Parameters:

Parameter	Type	Required	Description
`event`	`"stateChange"`	Yes
`callback`	`EventListener`	Yes

off

Remove event listener

off(event: "stateChange", callback: EventListener): void

Parameters:

Parameter	Type	Required	Description
`event`	`"stateChange"`	Yes
`callback`	`EventListener`	Yes