Skip to main content

Configuration

Options for Pulse.start() — the JS-layer initialization call.

For native-side configuration, see the platform SDK references: iOS SDK Initialization · Android SDK Configuration.

Pulse.start(options?)

Pulse.start({
autoDetectExceptions: true, // JS crash and error detection
autoDetectNetwork: true, // HTTP request interception
autoDetectNavigation: true, // kill switch for navigation tracking
});

All options default to true. Pass false to disable an instrumentation.

OptionDefaultDescription
autoDetectExceptionstrueGlobal JS error handler — catches unhandled exceptions and promise rejections
autoDetectNetworktrueIntercepts XMLHttpRequest / fetch / axios — zero code changes required
autoDetectNavigationtrueKill switch — set to false to completely disable navigation tracking. Tracking requires the useNavigationTracking hook regardless — see Navigation Instrumentation.

Network Header Capture

Capture specific request or response headers alongside network spans:

Pulse.start({
networkHeaders: {
requestHeaders: ['x-request-id', 'x-trace-id'],
responseHeaders: ['x-response-time', 'cache-control'],
},
});

Shutdown

Permanently shuts down the SDK. Cannot be reversed in the same process.

Pulse.shutdown();

Next Steps

I want to…Go to
Configure a specific instrumentationInstrumentation guides
Track business eventsCustom Events
Report handled errorsError Tracking
Measure operation durationsCustom Spans
Catch React render errorsError Boundaries
Attach user identityUser Identification
Add global metadataGlobal Attributes
Gate collection behind consentData Collection Consent
Configure native iOS instrumentationiOS SDK Initialization
Configure native Android instrumentationAndroid SDK Configuration