Obs Browser

Interfaces

Interfaces

ObservabilityConfig

Observability configuration

Properties:

PropertyTypeRequiredDescription
urlstringYes
apiKeystringYes
projectIdstringYes
environmentstring | undefinedNo
releasestring | undefinedNo
userIdstring | undefinedNo
autoCaptureboolean | undefinedNo

Breadcrumb structure

Properties:

PropertyTypeRequiredDescription
timestampnumberYes
category"navigation" | "click" | "console" | "http" | "error"Yes
messagestringYes
dataRecord<string, any> | undefinedNo

ErrorEvent

Error event structure (matches server expectations)

Properties:

PropertyTypeRequiredDescription
idstringYes
type"error"Yes
projectIdstringYes
timestampnumberYes
level"error" | "fatal"Yes
messagestringYes
stackTracestring[]Yes
environment{ platform: "browser" | "node" | "react-native" | "electron"; userAgent?: string; os?: string; appVersion?: string; }Yes
metadataRecord<string, any>Yes
releasestring | undefinedNo
userIdstring | undefinedNo
urlstring | undefinedNo
breadcrumbsBreadcrumb[] | undefinedNo
contextRecord<string, any> | undefinedNo
tagsRecord<string, string> | undefinedNo
stackstring | undefinedNo

LogEvent

Log event structure (matches server expectations)

Properties:

PropertyTypeRequiredDescription
idstringYes
type"log"Yes
projectIdstringYes
timestampnumberYes
level"error" | "debug" | "info" | "warn"Yes
messagestringYes
environmentstring | undefinedNo
releasestring | undefinedNo
userIdstring | undefinedNo
dataRecord<string, any> | undefinedNo
contextRecord<string, any> | undefinedNo
tagsRecord<string, string> | undefinedNo

WebSocketClientConfig

WebSocket client configuration

Properties:

PropertyTypeRequiredDescription
urlstringYes
apiKeystringYes
reconnectboolean | undefinedNo
maxReconnectAttemptsnumber | undefinedNo
reconnectIntervalnumber | undefinedNo
maxReconnectIntervalnumber | undefinedNo
bufferSizenumber | undefinedNo
pingIntervalnumber | undefinedNo

ErrorEvent

Error event structure

Properties:

PropertyTypeRequiredDescription
type"error"Yes
messagestringYes
stackstring | undefinedNo
timestampnumberYes

LogEvent

Log event structure

Properties:

PropertyTypeRequiredDescription
type"log"Yes
level"error" | "debug" | "info" | "warn"Yes
messagestringYes
timestampnumberYes
Previous
API Reference