class Itly::Plugin::Iteratively::Options
Options
for the Iteratively
plugin class
Constants
- DEFAULT_URL
Attributes
Public Class Methods
Instantiate a new Options
@param [String] url (optional): specify the url to push events to.
Default to https://data.us-east-2.iterative.ly/t
@param [TrueClass/FalseClass] disabled: set to true to disable the Iteratively
plugin.
Default to +true+ in production environment, to +false+ otherwise
@param [Integer] flush_queue_size
(optional): Number of event in the buffer before
a flush is triggered. Default: 10
@param [Integer] batch_size
(optional): Maximum number of events to send to the server at once. Default: 100 @param [Integer] flush_interval_ms
(optional): Delay in milliseconds between each automatic
flush. Default: 1_000
@param [Integer] max_retries
(optional): Number of retries for pushing
events to the server. Default: 25
@param [Float] retry_delay_min
: Minimum delay between retries in seconds. Default: 10.0 @param [Float] retry_delay_max
: Maximum delay between retries in seconds. Default: 3600.0 (1 hour) @param [TrueClass/FalseClass] omit_values
: set to true to send empty data. Default to false @param [String] branch: Tracking plan branch name (e.g. feature/demo) @param [String] version: Tracking plan version number (e.g. 1.0.0)
# File lib/itly/plugin/iteratively/options.rb, line 37 def initialize( url: DEFAULT_URL, disabled: nil, flush_queue_size: 10, batch_size: 100, flush_interval_ms: 1_000, max_retries: 25, retry_delay_min: 10.0, retry_delay_max: 3600.0, omit_values: false, branch: nil, version: nil ) super() @url = url @disabled = disabled @flush_queue_size = flush_queue_size @batch_size = batch_size @flush_interval_ms = flush_interval_ms @max_retries = max_retries @retry_delay_min = retry_delay_min @retry_delay_max = retry_delay_max @omit_values = omit_values @branch = branch @version = version end
Public Instance Methods
Returns a copy of this Options
with any provided arguments used as overrides
# File lib/itly/plugin/iteratively/options.rb, line 58 def with_overrides( url: nil, disabled: nil, flush_queue_size: nil, batch_size: nil, flush_interval_ms: nil, max_retries: nil, retry_delay_min: nil, retry_delay_max: nil, omit_values: nil, branch: nil, version: nil ) Itly::Plugin::Iteratively::Options.new( url: url.nil? ? @url : url, disabled: disabled.nil? ? @disabled : disabled, flush_queue_size: flush_queue_size.nil? ? @flush_queue_size : flush_queue_size, batch_size: batch_size.nil? ? @batch_size : batch_size, flush_interval_ms: flush_interval_ms.nil? ? @flush_interval_ms : flush_interval_ms, max_retries: max_retries.nil? ? @max_retries : max_retries, retry_delay_min: retry_delay_min.nil? ? @retry_delay_min : retry_delay_min, retry_delay_max: retry_delay_max.nil? ? @retry_delay_max : retry_delay_max, omit_values: omit_values.nil? ? @omit_values : omit_values, branch: branch.nil? ? @branch : branch, version: version.nil? ? @version : version ) end