Struct launchdarkly_server_sdk::EventProcessorBuilder

pub struct EventProcessorBuilder { /* private fields */ }

Contains methods for configuring delivery of analytics events.

The SDK normally buffers analytics events and sends them to LaunchDarkly at intervals. If you want to customize this behavior, create a builder with crate::EventProcessorBuilder::new, change its properties with the methods of this struct, and pass it to crate::ConfigBuilder::event_processor.

Examples

Adjust the flush interval

    ConfigBuilder::new("sdk-key").event_processor(EventProcessorBuilder::new()
        .flush_interval(Duration::from_secs(10)));

Implementations

impl EventProcessorBuilder

pub fn new() -> Self

Create a new EventProcessorBuilder with all default values.

pub fn capacity(&mut self, capacity: usize) -> &mut Self

Set the capacity of the events buffer.

The client buffers up to this many events in memory before flushing. If the capacity is exceeded before the buffer is flushed crate::EventProcessor::flush, events will be discarded. Increasing the capacity means that events are less likely to be discarded, at the cost of consuming more memory.

pub fn flush_interval(&mut self, flush_interval: Duration) -> &mut Self

Sets the interval between flushes of the event buffer.

Decreasing the flush interval means that the event buffer is less likely to reach capacity.

pub fn user_keys_capacity(&mut self, user_keys_capacity: usize) -> &mut Self

Sets the number of user keys that the event processor can remember at any one time.

To avoid sending duplicate user details in analytics events, the SDK maintains a cache of recently seen user keys.

pub fn user_keys_flush_interval(
    &mut self,
    user_keys_flush_interval: Duration
) -> &mut Self

Sets the interval at which the event processor will reset its cache of known user keys.

pub fn inline_users_in_events(
    &mut self,
    inline_users_in_events: bool
) -> &mut Self

Sets whether to include full user details in every analytics event.

The default is false: events will only include the user key, except for one “index” event that provides the full details for the user.

pub fn all_attributes_private(
    &mut self,
    all_attributes_private: bool
) -> &mut Self

Sets whether or not all optional user attributes should be hidden from LaunchDarkly.

If this is true, all user attribute values (other than the key) will be private, not just the attributes specified with private_attribute_names or on a per-user basis with UserBuilder methods. By default, it is false.

pub fn private_attribute_names(
    &mut self,
    attributes: HashSet<String>
) -> &mut Self

Marks a set of attribute names as always private.

Any users sent to LaunchDarkly with this configuration active will have attributes with these names removed. This is in addition to any attributes that were marked as private for an individual user with UserBuilder methods. Setting all_attribute_private to true overrides this.

Trait Implementations

impl Clone for EventProcessorBuilder

fn clone(&self) -> EventProcessorBuilder

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for EventProcessorBuilder

fn default() -> Self

Returns the “default value” for a type.