Customize error handler for the JavaScript (Browser) SDK prior to v6

2 min

In a production environment, you should have full control and visibility over the errors that are happening in your application, including those that would originate from an SDK.

The Optimizely Feature Experimentation SDKs provide default implementations of an error handler in the SDKs. The following is an example of using the default error handler from the SDKs:

import { createInstance, errorHandler } from '@optimizely/optimizely-sdk';
 
const optimizely = createInstance({
  sdkKey: '<YOUR_SDK_KEY>',
  // the default error handler is a no-op
  errorHandler,
});

However, for additional control and visibility into the errors coming from the Optimizely Feature Experimentation JavaScript (Browser) SDK, you should implementing your own custom error handler.

With a custom error handler, you can choose what to do with an error, whether it may be as simple as logging the error to console or sending the error to another error monitoring service.

The following is an example of using a custom error handler to log errors to the console:

import { createInstance } from '@optimizely/optimizely-sdk';
 
/**
 * customErrorHandler
 *
 * Object that has a property `handleError` which will be called
 * when an error is thrown in the SDK.
 */
const customErrorHandler = {
  /**
   * handleError
   *
   * Function which gets called when an error is thrown in the SDK
   * @param {Object} error - error object
   * @param {String} error.message - message of the error
   * @param {String} error.stack - stack trace for the error
   */
  handleError: (error) => {
    console.log('CUSTOM_ERROR_HANDLER');
    console.log('****');
    console.log(`Error Message: ${error.message}`);
    console.log(`Error Stack: ${error.stack}`);
    console.log('****');
  }
}
 
const optimizely = createInstance({
  sdkKey: '<YOUR_SDK_KEY>',
  errorHandler: customErrorHandler,
});