com.snowplowanalytics.snowplow.tracker.configuration

Class EmitterConfiguration

java.lang.Object

com.snowplowanalytics.snowplow.tracker.configuration.EmitterConfiguration

public class EmitterConfiguration
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
EmitterConfiguration() Create an EmitterConfiguration instance.

Method Summary

Modifier and Type	Method and Description
EmitterConfiguration	batchSize(int batchSize) The default batch size is 50.
EmitterConfiguration	bufferCapacity(int bufferCapacity) The default buffer capacity is 10 000 events.
EmitterConfiguration	callback(EmitterCallback callback) Provide a custom EmitterCallback to access successfully sent or failed event payloads.
EmitterConfiguration	customRetryForStatusCodes(java.util.Map<java.lang.Integer,java.lang.Boolean> customRetryForStatusCodes) Set custom retry rules for HTTP status codes received in emit responses from the Collector.
EmitterConfiguration	eventStore(EventStore eventStore) The default EventStore is InMemoryEventStore.
int	getBatchSize() Returns the number of events to send per request (batched).
int	getBufferCapacity() Returns the maximum number of events to buffer in memory.
EmitterCallback	getCallback() Returns the custom callback which is called when events are successfully sent to the collector, or after certain failure conditions.
java.util.Map<java.lang.Integer,java.lang.Boolean>	getCustomRetryForStatusCodes() Returns the custom configuration for HTTP status codes.
EventStore	getEventStore() Returns the EventStore used to buffer events.
java.util.concurrent.ScheduledExecutorService	getRequestExecutorService() Returns the ScheduledExecutorService used for sending events.
int	getThreadCount() Returns the number of threads used for event sending using the ScheduledExecutorService.
EmitterConfiguration	requestExecutorService(java.util.concurrent.ScheduledExecutorService requestExecutorService) Set a custom ScheduledExecutorService to send http requests (default is ScheduledThreadPoolExecutor).
EmitterConfiguration	threadCount(int threadCount) Sets the Thread Count for the ScheduledExecutorService (default is 50).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EmitterConfiguration

public EmitterConfiguration()

Create an EmitterConfiguration instance. The default configuration is: 50 batched events per request; maximum 10 000 events buffered in memory; 50 threads; no retry for request status codes 400, 401, 403, 410 or 422; and OkHttp (OkHttpClientAdapter) used for HTTP requests.

Method Detail

getBatchSize

public int getBatchSize()

Returns the number of events to send per request (batched).

Returns:

the batch size

getBufferCapacity

public int getBufferCapacity()

Returns the maximum number of events to buffer in memory.

Returns:

maximum buffer capacity

getEventStore

public EventStore getEventStore()

Returns the EventStore used to buffer events.

Returns:

EventStore instance

getCustomRetryForStatusCodes

public java.util.Map<java.lang.Integer,java.lang.Boolean> getCustomRetryForStatusCodes()

Returns the custom configuration for HTTP status codes. "True" means the

Returns:

map of integers (status codes) to booleans (true for retry and false for not retry)

getThreadCount

public int getThreadCount()

Returns the number of threads used for event sending using the ScheduledExecutorService.

Returns:

thread count

getRequestExecutorService

public java.util.concurrent.ScheduledExecutorService getRequestExecutorService()

Returns the ScheduledExecutorService used for sending events.

Returns:

ScheduledExecutorService object

getCallback

public EmitterCallback getCallback()

Returns the custom callback which is called when events are successfully sent to the collector, or after certain failure conditions.

Returns:

EmitterCallback object

batchSize

public EmitterConfiguration batchSize(int batchSize)

The default batch size is 50.

Parameters:

batchSize - The count of events to send in one HTTP request

Returns:

itself

bufferCapacity

public EmitterConfiguration bufferCapacity(int bufferCapacity)

The default buffer capacity is 10 000 events. When the buffer is full (due to network outage), new events are lost.

Parameters:

bufferCapacity - The maximum capacity of the default InMemoryEventStore event buffer

Returns:

itself

eventStore

public EmitterConfiguration eventStore(EventStore eventStore)

The default EventStore is InMemoryEventStore.

Parameters:

eventStore - The EventStore to use

Returns:

itself

customRetryForStatusCodes

public EmitterConfiguration customRetryForStatusCodes(java.util.Map<java.lang.Integer,java.lang.Boolean> customRetryForStatusCodes)

Set custom retry rules for HTTP status codes received in emit responses from the Collector. By default, retry will not occur for status codes 400, 401, 403, 410 or 422. This can be overridden here. Note that 2xx codes will never retry as they are considered successful.

Parameters:

customRetryForStatusCodes - Mapping of integers (status codes) to booleans (true for retry and false for not retry)

Returns:

itself

threadCount

public EmitterConfiguration threadCount(int threadCount)

Sets the Thread Count for the ScheduledExecutorService (default is 50).

Parameters:

threadCount - the size of the thread pool

Returns:

itself

requestExecutorService

public EmitterConfiguration requestExecutorService(java.util.concurrent.ScheduledExecutorService requestExecutorService)

Set a custom ScheduledExecutorService to send http requests (default is ScheduledThreadPoolExecutor).

Implementation note: Be aware that calling `close()` on a BatchEmitter instance has a side-effect and will shutdown that ExecutorService.

Parameters:

requestExecutorService - the ScheduledExecutorService to use

Returns:

itself

callback

public EmitterConfiguration callback(EmitterCallback callback)

Provide a custom EmitterCallback to access successfully sent or failed event payloads.

Parameters:

callback - an EmitterCallback

Returns:

itself