@bugfender/capacitor

Remote logging, crash reporting and in-app user feedback with Bugfender and Capacitor.

This module is a plugin for Capacitor since version 4. You can use @bugfender/capacitor in Ionic projects for iOS, Android, web and electron platforms.

Installation

npm install @bugfender/capacitor @bugfender/sdk @bugfender/common
npx cap sync

Usage

Import Bugfender like this:

import { Bugfender } from '@bugfender/capacitor';

Note: in an Ionic/Capacitor project, always import @bugfender/capacitor instead of @bugfender/sdk. This will enable the native features of the SDK that you wouldn't get otherwise.

Network logging

Network logging is opt-in and disabled by default. When enabled, HTTP requests appear in Bugfender as logs tagged bf_network.

Bugfender.setNetworkLoggingEnabled(true);
// Optional:
Bugfender.setNetworkLoggingCaptureBodies(false);
Bugfender.setNetworkLoggingCaptureErrorResponseBodies(true);
Bugfender.setNetworkLoggingURLFilter(
  ['https://api.example.com/*'],
  ['*/secrets/*']
);
Bugfender.setNetworkLoggingMaxRequestsPerMinute(60);

// Optional: redact sensitive headers/bodies before they are logged
Bugfender.setNetworkLoggingRequestObfuscationHandler((url, headers, body) => ({
  url,
  headers: { ...headers, authorization: '[REDACTED]' },
  body,
}));
Bugfender.setNetworkLoggingResponseObfuscationHandler((headers, body) => ({
  headers,
  body: body ? body.replace(/"token":"[^"]*"/g, '"token":"[REDACTED]"') : null,
}));

You can also enable it at init time with networkLoggingEnabled, networkLoggingCaptureBodies, and networkLoggingCaptureErrorResponseBodies.

Platform notes:

• iOS: URLSession traffic is captured (including Capacitor HTTP when it uses URLSession). Requires Bugfender iOS SDK 3.0.1+.
• Android: OkHttp traffic is captured via the android-okhttp adapter. Requires Bugfender Android SDK 4.x. Note: Capacitor's built-in CapacitorHttp uses HttpURLConnection on Android and is not observed; apps should use OkHttp (or the example's sendInstrumentedNetworkRequest helper) for network logs.
• Web / Electron: Uses @bugfender/sdk (≥ 4.0.0), which intercepts fetch and XMLHttpRequest.

API

Please check the following URL for a complete API reference: https://js.bugfender.com.

• init(...)
• forceSendOnce()
• getDeviceURL()
• getSessionURL()
• getUserFeedback(...)
• log(...)
• log(...)
• warn(...)
• warn(...)
• error(...)
• error(...)
• trace(...)
• trace(...)
• info(...)
• info(...)
• fatal(...)
• fatal(...)
• removeDeviceKey(...)
• sendLog(...)
• sendIssue(...)
• sendCrash(...)
• sendUserFeedback(...)
• setDeviceKey(...)
• setForceEnabled(...)
• setSDKType(...)
• setNetworkLoggingEnabled(...)
• setNetworkLoggingCaptureBodies(...)
• setNetworkLoggingCaptureErrorResponseBodies(...)
• setNetworkLoggingRequestObfuscationHandler(...)
• setNetworkLoggingResponseObfuscationHandler(...)
• setNetworkLoggingURLFilter(...)
• setNetworkLoggingMaxRequestsPerMinute(...)
• Interfaces
• Type Aliases
• Enums

init(...)

init(options: SDKOptions) => Promise<void>

forceSendOnce()

forceSendOnce() => void

getDeviceURL()

getDeviceURL() => Promise<string>

Returns: Promise<string>

getSessionURL()

getSessionURL() => Promise<string>

Returns: Promise<string>

getUserFeedback(...)

getUserFeedback(options?: UserFeedbackOptions | undefined) => Promise<UserFeedbackResult>

Returns: Promise<UserFeedbackResult>

log(...)

log(obj: unknown, ...objs: unknown[]) => void

log(...)

log(msg: string, ...subst: unknown[]) => void

warn(...)

warn(obj: unknown, ...objs: unknown[]) => void

warn(...)

warn(msg: string, ...subst: unknown[]) => void

error(...)

error(obj: unknown, ...objs: unknown[]) => void

error(...)

error(msg: string, ...subst: unknown[]) => void

trace(...)

trace(obj: unknown, ...objs: unknown[]) => void

trace(...)

trace(msg: string, ...subst: unknown[]) => void

info(...)

info(obj: unknown, ...objs: unknown[]) => void

info(...)

info(msg: string, ...subst: unknown[]) => void

fatal(...)

fatal(obj: unknown, ...objs: unknown[]) => void

fatal(...)

fatal(msg: string, ...subst: unknown[]) => void

removeDeviceKey(...)

removeDeviceKey(key: string) => void

sendLog(...)

sendLog(log: LogEntry) => void

sendIssue(...)

sendIssue(title: string, text: string) => Promise<string>

Returns: Promise<string>

sendCrash(...)

sendCrash(title: string, text: string) => Promise<string>

Returns: Promise<string>

sendUserFeedback(...)

sendUserFeedback(title: string, text: string) => Promise<string>

Returns: Promise<string>

setDeviceKey(...)

setDeviceKey(key: string, value: DeviceKeyValue) => void

setForceEnabled(...)

setForceEnabled(state: boolean) => void

setSDKType(...)

setSDKType(sdkType: string, version: number) => void

setNetworkLoggingEnabled(...)

setNetworkLoggingEnabled(enabled: boolean) => void

Enable or disable network logging (default: false).

setNetworkLoggingCaptureBodies(...)

setNetworkLoggingCaptureBodies(capture: boolean) => void

Full mode: capture request/response bodies (default: false).

setNetworkLoggingCaptureErrorResponseBodies(...)

setNetworkLoggingCaptureErrorResponseBodies(capture: boolean) => void

Error-only body mode: capture response body only for HTTP status >= 400 (default: false).

setNetworkLoggingRequestObfuscationHandler(...)

setNetworkLoggingRequestObfuscationHandler(handler: ((url: string, headers: Record<string, string>, body: string | null) => { url: string; headers: Record<string, string>; body: string | null; }) | null) => void

Request obfuscation — (url, headers, body) => { url, headers, body }.

setNetworkLoggingResponseObfuscationHandler(...)

setNetworkLoggingResponseObfuscationHandler(handler: ((headers: Record<string, string>, body: string | null) => { headers: Record<string, string>; body: string | null; }) | null) => void

Response obfuscation — (headers, body) => { headers, body }.

setNetworkLoggingURLFilter(...)

setNetworkLoggingURLFilter(allowlist: string[] | null, denylist: string[] | null) => void

URL filtering: allowlist / denylist. Null = no filter.

setNetworkLoggingMaxRequestsPerMinute(...)

setNetworkLoggingMaxRequestsPerMinute(count: number | null) => void

Rate limit. Null = no limit.

Interfaces

SDKOptions

ExceptionInfo

Information about an exception that can be used to determine if it should be ignored

Error

RegExp

RegExpExecArray

UserFeedbackResultSuccess

UserFeedbackResultCancel

UserFeedbackOptions

Options object for Bugfender.getUserFeedback with customised modal strings.

LogEntry

Log Entry object interface

Type Aliases

ExceptionFilter

Configuration for ignoring exceptions. Can be:

• A function that receives exception info and returns boolean
• An array of patterns (strings or RegExp) to match against the error message
• A combination of both (function and patterns)

ExceptionFilterFunction | ExceptionPattern[] | { /** Function to determine if exception should be ignored / filter?: ExceptionFilterFunction; /* Patterns to match against error message */ patterns?: ExceptionPattern[]; }

ExceptionFilterFunction

A function that determines whether an exception should be ignored. Return true to ignore the exception, false to report it.

(info: ExceptionInfo): boolean

ExceptionPattern

A pattern that can be used to match exception messages. Can be a string (exact or substring match) or a RegExp.

string | RegExp

UserFeedbackResult

UserFeedbackResultSuccess | UserFeedbackResultCancel

DeviceKeyValue

string | number | boolean

Record

Construct a type with a set of properties K of type T

{ [P in K]: T; }

Enums

LogLevel