Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySumbit a ticketLog In
GitHubNuGetDev CommunitySumbit a ticket

Event batching

How the Optimizely Full Stack Ruby SDK uses the event processor to batch impressions and conversion events into a single payload before sending it to Optimizely.

The Optimizely Full Stack Ruby SDK batches impression and conversion events into a single payload before sending it to Optimizely. This is achieved through an SDK component called the event processor.

Event batching has the advantage of reducing the number of outbound requests to Optimizely depending on how you define, configure, and use the event processor. It means less network traffic for the same number of impression and conversion events tracked.

In the Ruby SDK, BatchEventProcessor provides an implementation of the EventProcessor interface and batches events. You can control batching based on two parameters:

  • Batch size Defines the number of events that are batched together before sending to Optimizely.
  • Flush interval – Defines the amount of time after which any batched events should be sent to Optimizely.

An event that consists of the batched payload is sent as soon as the batch size reaches the specified limit or the flush interval reaches the specified time limit. BatchEventProcessor options are described in more detail below.

Basic example

require 'optimizely'
require 'optimizely/optimizely_factory'

# Initialize an Optimizely client
optimizely_instance = Optimizely::OptimizelyFactory.default_instance(
  'put_your_sdk_key_here'
)

By default, batch size is 10 and flush interval is 30 seconds.

Advanced example

Set the batch size and flush interval using BatchEventProcessor's constructor.

require 'optimizely'
require 'optimizely/event/batch_event_processor'

# Initialize BatchEventProcessor
event_processor = Optimizely::BatchEventProcessor.new(
  event_dispatcher: event_dispatcher,
  batch_size: 50,
  flush_interval: 1000
)

# Initialize an Optimizely client
optimizely_client = Optimizely::Project.new(
  datafile,
  event_dispatcher,
  logger,
  error_handler,
  skip_json_validation,
  user_profile_service,
  sdk_key,
  config_manager,
  notification_center,
  event_processor
)

❗️

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 Full Stack 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.

BatchEventProcessor

BatchEventProcessor is an implementation of EventProcessor where events are batched. The class maintains a single consumer thread that pulls events off of the queue and buffers them for either a configured batch size or a maximum duration before the resulting LogEvent is sent to the EventDispatcher and NotificationCenter.

The following properties can be used to customize the BatchEventProcessor configuration.

PropertyDefault valueDescription
event_queue1000SizedQueue.new(100) or Queue.new
Queues individual events to be batched and dispatched by the executor.
event_dispatchernilUsed to dispatch event payload to Optimizely.
batch_size10The maximum number of events to batch before dispatching. Once this number is reached, all queued events are flushed and sent to Optimizely.
flush_interval30000Maximum time to wait before batching and dispatching events. In milliseconds.
notification_centernilNotification center instance to be used to trigger any notifications.

For more information, see Initialize SDK.

Side effects

The table lists other Optimizely functionality that may be triggered by using this class.

FunctionalityDescription
LogEventWhenever the event processor produces a batch of events, a LogEvent object will be created using EventFactory.

It contains batch of conversion and impression events.

This object will be dispatched using the provided event dispatcher and also it will be sent to the notification subscribers
Notification ListenersFlush invokes the LOG_EVENT notification listener if this listener is subscribed to.

Register LogEvent listener

To register a LogEvent notification listener:

callback_reference = lambda do |*args|
        puts "Notified!"
end

optimizely_client.notification_center.add_notification_listener(        Optimizely::NotificationCenter::NOTIFICATION_TYPES[:LOG_EVENT], callback_reference )

LogEvent

LogEvent object gets created using EventFactory. It represents the batch of impression and conversion events we send to the Optimizely backend.

ObjectTypeDescription
http_verb
Required (non null)
StringThe HTTP verb to use when dispatching the log event. It can be GET or POST.
url
Required (non null)
StringURL to dispatch log event to.
params
Required (non null)
EventBatchIt contains all the information regarding every event which is batched. including list of visitors which contains UserEvent.
headers
Required
HashRequest headers.

Close Optimizely on application exit

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

Important

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

MethodDescription
close() Stops all timers and flushes the event queue. This method will also stop any timers that are happening for the datafile manager.

Note: Optimizely recommends that you connect this method to a kill signal for the running process.