Obs Browser
Interfaces
Interfaces
ObservabilityConfig
Observability configuration
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
apiKey | string | Yes | |
projectId | string | Yes | |
environment | string | undefined | No | |
release | string | undefined | No | |
userId | string | undefined | No | |
autoCapture | boolean | undefined | No |
Breadcrumb
Breadcrumb structure
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
timestamp | number | Yes | |
category | "navigation" | "click" | "console" | "http" | "error" | Yes | |
message | string | Yes | |
data | Record<string, any> | undefined | No |
ErrorEvent
Error event structure (matches server expectations)
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
type | "error" | Yes | |
projectId | string | Yes | |
timestamp | number | Yes | |
level | "error" | "fatal" | Yes | |
message | string | Yes | |
stackTrace | string[] | Yes | |
environment | { platform: "browser" | "node" | "react-native" | "electron"; userAgent?: string; os?: string; appVersion?: string; } | Yes | |
metadata | Record<string, any> | Yes | |
release | string | undefined | No | |
userId | string | undefined | No | |
url | string | undefined | No | |
breadcrumbs | Breadcrumb[] | undefined | No | |
context | Record<string, any> | undefined | No | |
tags | Record<string, string> | undefined | No | |
stack | string | undefined | No |
LogEvent
Log event structure (matches server expectations)
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
type | "log" | Yes | |
projectId | string | Yes | |
timestamp | number | Yes | |
level | "error" | "debug" | "info" | "warn" | Yes | |
message | string | Yes | |
environment | string | undefined | No | |
release | string | undefined | No | |
userId | string | undefined | No | |
data | Record<string, any> | undefined | No | |
context | Record<string, any> | undefined | No | |
tags | Record<string, string> | undefined | No |
WebSocketClientConfig
WebSocket client configuration
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | |
apiKey | string | Yes | |
reconnect | boolean | undefined | No | |
maxReconnectAttempts | number | undefined | No | |
reconnectInterval | number | undefined | No | |
maxReconnectInterval | number | undefined | No | |
bufferSize | number | undefined | No | |
pingInterval | number | undefined | No |
ErrorEvent
Error event structure
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
type | "error" | Yes | |
message | string | Yes | |
stack | string | undefined | No | |
timestamp | number | Yes |
LogEvent
Log event structure
Properties:
| Property | Type | Required | Description |
|---|---|---|---|
type | "log" | Yes | |
level | "error" | "debug" | "info" | "warn" | Yes | |
message | string | Yes | |
timestamp | number | Yes |