Type Alias ObserveOptions

Type declaration

• OptionalconsoleMethodsToRecord?: ConsoleMethods[]

  Specifies which console methods to record. The value here will be ignored if disabledConsoleRecording is true.

  Default

  All console methods.
  Copy

  Example

  consoleMethodsToRecord: ['log', 'info', 'error']
  Copy

• OptionaldisableConsoleRecording?: boolean

  Specifies whether Highlight will record console messages.

  Default

  false
  Copy

• OptionalenablePerformanceRecording?: boolean

  Specifies whether to record performance metrics (e.g. FPS, device memory).

  Default

  true
  Copy

• OptionalenablePromisePatch?: boolean

  Specifies whether window.Promise should be patched to record the stack trace of promise rejections.

  Default

  true
  Copy

• Optionalenvironment?: "development" | "staging" | "production" | string

  Specifies the environment your application is running in. This is useful to distinguish whether your session was recorded on localhost or in production.

  Default

  'production'
  Copy

• OptionalnetworkRecording?: boolean | NetworkRecordingOptions

  Specifies how and what Highlight records from network requests and responses.

• Optionalotel?: OtelOptions & { eventNames?: EventName[]; otlpEndpoint?: string }

  OTLP options for OpenTelemetry tracing. Instrumentations are enabled by default.

• OptionalreportConsoleErrors?: boolean

  Specifies whether Highlight will report console.error invocations as Highlight Errors.

  Default

  false
  Copy

• OptionaltracingOrigins?: boolean | (string | RegExp)[]

  Specifies where the backend of the app lives. If specified, Highlight will attach the X-Highlight-Request header to outgoing requests whose destination URLs match a substring or regexp from this list, so that backend errors can be linked back to the session. If 'true' is specified, all requests to the current domain will be matched.

  Example

  tracingOrigins: ['localhost', /^//, 'backend.myapp.com']
  Copy