Event batching for the JavaScript SDK v6

❗️

Warning

This content covers the Feature Experimentation JavaScript (Browser) SDK v6 features currently in pre-production testing and is subject to change before release

For the latest released version, see JavaScript (Browser) SDK.

The Optimizely Feature Experimentation Javascript (Browser) SDK lets you batch events and includes options to set a maximum batch size and flush interval timeout. The benefit of event batching is less network traffic for the same number of impression and conversion events tracked.

Minimum SDK version

v6.0.0+

📘

Note

In order to enable "Event Batching" it is required to use "Batch Event Processor" in Javascript SDK version 6 or newer.

Event batching works with the default and custom event dispatchers.

The event batching process does not remove any personally identifiable information (PII) from events. You must ensure that you are not sending any unnecessary PII to Optimizely.

Basic example

Optimizely provides two options to configure event batching: batchSize and flushInterval. You can pass in both options during eventProcessor creation. Events are held in a queue until the following:

• The number of events reaches the defined batchSize.

• The oldest event has been in the queue for longer than the defined flushInterval, which is specified in milliseconds. The queue is then flushed and all queued events are sent to Optimizely Feature Experimentation in a single network request.

• A new datafile revision is received. This occurs only when live datafile updates are enabled.

import { createInstance } from '@optimizely/optimizely-sdk';

const SDK_KEY="YOUR_SDK_KEY";

const pollingConfigManager = createPollingProjectConfigManager({
  sdkKey: SDK_KEY,
});

const batchEventProcessor = createBatchEventProcessor({
  batchSize: 100,
  flushInterval: 5000
});

const optimizelyClient = createInstance({
  projectConfigManager: pollingConfigManager,
  eventProcessor: batchEventProcessor 
});

By default, batch size is 10 and flush interval is 1 second.

❗️

Warning

The maximum payload size is 3.5 MB. Optimizely rejects requests with a 400 response code, Bad Request Error, if the batch payload exceeds this limit.

The size limitation is because of the Optimizely Events API, which Feature Experimentation uses to send data to Optimizely.

The most common cause of a large payload size is a high batch size. If your payloads exceed the size limit, try configuring a smaller batch size.

The following table defines these options and lists general recommendations. On the browser you should use a small eventBatchSize (10) and a short eventFlushInterval (1000). This ensures that events are sent in a relatively fast manner, since some events could be lost if a user immediately bounces, while gaining network efficiency in cases where many decisions calls happen back-to-back.

For more information, see Initialize the JavaScript (Browser) SDK.

Side effects

The following table describes other functionality related to event batching.

Register a LogEvent listener

To register a LogEvent notification listener see the following code example:

// Using notificationCenter to register logEvent listener
import { NOTIFICATION_TYPES } from '@optimizely/optimizely-sdk'

optlimizely.notificationCenter
  .addNotificationListener(NOTIFICATION_TYPES.LOG_EVENT, (logEvent) => {});

LogEvent

LogEvent represents the batch of decision and conversion events sent to the Optimizely Feature Experimentation backend.

Close Optimizely Feature Experimentation on application exit

If you enable event batching, you must call the Close method (optimizely.close()) before exiting. This ensures that queued events are flushed as soon as possible to avoid any data loss.

❗

Warning

Because the Optimizely client maintains a buffer of queued events, you must call close() on the Optimizely Feature Experimentation instance before shutting down your application or whenever dereferencing the instance.

On the browser side, optimizely.close() is automatically connected to the pagehide event, so there is no need to do any manual instrumentation.