Interface BreadcrumbsOptions

True to enable click breadcrumbs. Defaults to true.

True to enable automatic evaluation breadcrumbs. Defaults to true.

Custom breadcrumb filters.

Can be used to redact or modify breadcrumbs.

Example:

// We want to redact any click events that include the message 'sneaky-button'
filters: [
  (breadcrumb) => {
    if(
      breadcrumb.class === 'ui' &&
      breadcrumb.type === 'click' &&
      breadcrumb.message?.includes('sneaky-button')
    ) {
      return;
    }
   return breadcrumb;
  }
]
Copy

If you want to redact or modify URLs in breadcrumbs, then a urlFilter should be used.

If any breadcrumb filters throw an exception while processing a breadcrumb, then that breadcrumb will be excluded.

If any breadcrumbFilter cannot be executed, for example because it is not a function, then all breadcrumbs will be excluded.

True to enable flag change breadcrumbs. Defaults to true.

Controls instrumentation and breadcrumbs for HTTP requests. The default is to instrument XMLHttpRequests and fetch requests.

false to disable all HTTP breadcrumbs and instrumentation.

Example:

// This would instrument only XmlHttpRequests
http: {
 instrumentFetch: false
 instrumentXhr: true
}

// Disable all HTTP instrumentation:
http: false
Copy

True to enable input breadcrumbs for keypresses. Defaults to true.

Input breadcrumbs do not include entered text, just that text was entered.

Set the maximum number of breadcrumbs. Defaults to 50.