Class: StatsigOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/statsig_options.rb

Overview

Configuration options for the Statsig SDK.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(environment = nil, api_url_base = nil, api_url_download_config_specs: nil, rulesets_sync_interval: 10, idlists_sync_interval: 60, disable_rulesets_sync: false, disable_idlists_sync: false, logging_interval_seconds: 60, logging_max_buffer_size: 1000, local_mode: false, bootstrap_values: nil, rules_updated_callback: nil, data_store: nil, idlist_threadpool_size: 3, logger_threadpool_size: 3, disable_diagnostics_logging: false, disable_sorbet_logging_handlers: false, network_timeout: nil, post_logs_retry_limit: 3, post_logs_retry_backoff: nil, user_persistent_storage: nil) ⇒ StatsigOptions

Returns a new instance of StatsigOptions.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/statsig_options.rb', line 90

def initialize(
  environment = nil,
  api_url_base = nil,
  api_url_download_config_specs: nil,
  rulesets_sync_interval: 10,
  idlists_sync_interval: 60,
  disable_rulesets_sync: false,
  disable_idlists_sync: false,
  logging_interval_seconds: 60,
  logging_max_buffer_size: 1000,
  local_mode: false,
  bootstrap_values: nil,
  rules_updated_callback: nil,
  data_store: nil,
  idlist_threadpool_size: 3,
  logger_threadpool_size: 3,
  disable_diagnostics_logging: false,
  disable_sorbet_logging_handlers: false,
  network_timeout: nil,
  post_logs_retry_limit: 3,
  post_logs_retry_backoff: nil,
  user_persistent_storage: nil
)
  @environment = environment.is_a?(Hash) ? environment : nil
  @api_url_base = api_url_base || 'https://statsigapi.net/v1'
  @api_url_download_config_specs = api_url_download_config_specs || api_url_base || 'https://api.statsigcdn.com/v1'
  @rulesets_sync_interval = rulesets_sync_interval
  @idlists_sync_interval = idlists_sync_interval
  @disable_rulesets_sync = disable_rulesets_sync
  @disable_idlists_sync = disable_idlists_sync
  @logging_interval_seconds = logging_interval_seconds
  @logging_max_buffer_size = [logging_max_buffer_size, 1000].min
  @local_mode = local_mode
  @bootstrap_values = bootstrap_values
  @rules_updated_callback = rules_updated_callback
  @data_store = data_store
  @idlist_threadpool_size = idlist_threadpool_size
  @logger_threadpool_size = logger_threadpool_size
  @disable_diagnostics_logging = disable_diagnostics_logging
  @disable_sorbet_logging_handlers = disable_sorbet_logging_handlers
  @network_timeout = network_timeout
  @post_logs_retry_limit = post_logs_retry_limit
  @post_logs_retry_backoff = post_logs_retry_backoff
  @user_persistent_storage = user_persistent_storage

end

Instance Attribute Details

#api_url_base ⇒ Object

The base url used to make network calls to Statsig. default: statsigapi.net/v1



15
16
17
 
# File 'lib/statsig_options.rb', line 15

def api_url_base
  @api_url_base
end

#api_url_download_config_specs ⇒ Object

The base url used specifically to call download_config_specs. Takes precedence over api_url_base



19
20
21
 
# File 'lib/statsig_options.rb', line 19

def api_url_download_config_specs
  @api_url_download_config_specs
end

#bootstrap_values ⇒ Object

A string that represents all rules for all feature gates, dynamic configs and experiments. It can be provided to bootstrap the Statsig server SDK at initialization in case your server runs into network issue or Statsig is down temporarily.



50
51
52
 
# File 'lib/statsig_options.rb', line 50

def bootstrap_values
  @bootstrap_values
end

#data_store ⇒ Object

A class that extends IDataStore. Can be used to provide values from a common data store (like Redis) to initialize the Statsig SDK.



57
58
59
 
# File 'lib/statsig_options.rb', line 57

def data_store
  @data_store
end

#disable_diagnostics_logging ⇒ Object

Should diagnostics be logged. These include performance metrics for initialize. default: false



69
70
71
 
# File 'lib/statsig_options.rb', line 69

def disable_diagnostics_logging
  @disable_diagnostics_logging
end

#disable_idlists_sync ⇒ Object

Disable background syncing for id lists



33
34
35
 
# File 'lib/statsig_options.rb', line 33

def disable_idlists_sync
  @disable_idlists_sync
end

#disable_rulesets_sync ⇒ Object

Disable background syncing for rulesets



30
31
32
 
# File 'lib/statsig_options.rb', line 30

def disable_rulesets_sync
  @disable_rulesets_sync
end

#disable_sorbet_logging_handlers ⇒ Object

Statsig utilizes Sorbet (sorbet.org) to ensure type safety of the SDK. This includes logging to console when errors are detected. You can disable this logging by setting this flag to true. default: false



74
75
76
 
# File 'lib/statsig_options.rb', line 74

def disable_sorbet_logging_handlers
  @disable_sorbet_logging_handlers
end

#environment ⇒ Object

Hash you can use to set environment variables that apply to all of your users in the same session and will be used for targeting purposes. eg. { “tier” => “development” }



11
12
13
 
# File 'lib/statsig_options.rb', line 11

def environment
  @environment
end

#idlist_threadpool_size ⇒ Object

The number of threads allocated to syncing IDLists. default: 3



61
62
63
 
# File 'lib/statsig_options.rb', line 61

def idlist_threadpool_size
  @idlist_threadpool_size
end

#idlists_sync_interval ⇒ Object

The interval (in seconds) to poll for changes to your id lists default: 60s



27
28
29
 
# File 'lib/statsig_options.rb', line 27

def idlists_sync_interval
  @idlists_sync_interval
end

#local_mode ⇒ Object

Restricts the SDK to not issue any network requests and only respond with default values (or local overrides) default: false



45
46
47
 
# File 'lib/statsig_options.rb', line 45

def local_mode
  @local_mode
end

#logger_threadpool_size ⇒ Object

The number of threads allocated to posting event logs. default: 3



65
66
67
 
# File 'lib/statsig_options.rb', line 65

def logger_threadpool_size
  @logger_threadpool_size
end

#logging_interval_seconds ⇒ Object

How often to flush logs to Statsig default: 60s



37
38
39
 
# File 'lib/statsig_options.rb', line 37

def logging_interval_seconds
  @logging_interval_seconds
end

#logging_max_buffer_size ⇒ Object

The maximum number of events to batch before flushing logs to the server default: 1000



41
42
43
 
# File 'lib/statsig_options.rb', line 41

def logging_max_buffer_size
  @logging_max_buffer_size
end

#network_timeout ⇒ Object

Number of seconds before a network call is timed out



77
78
79
 
# File 'lib/statsig_options.rb', line 77

def network_timeout
  @network_timeout
end

#post_logs_retry_backoff ⇒ Object

The number of seconds, or a function that returns the number of seconds based on the number of retries remaining which overrides the default backoff time between retries



84
85
86
 
# File 'lib/statsig_options.rb', line 84

def post_logs_retry_backoff
  @post_logs_retry_backoff
end

#post_logs_retry_limit ⇒ Object

Number of times to retry sending a batch of failed log events



80
81
82
 
# File 'lib/statsig_options.rb', line 80

def post_logs_retry_limit
  @post_logs_retry_limit
end

#rules_updated_callback ⇒ Object

A callback function that will be called anytime the rulesets are updated.



53
54
55
 
# File 'lib/statsig_options.rb', line 53

def rules_updated_callback
  @rules_updated_callback
end

#rulesets_sync_interval ⇒ Object

The interval (in seconds) to poll for changes to your Statsig configuration default: 10s



23
24
25
 
# File 'lib/statsig_options.rb', line 23

def rulesets_sync_interval
  @rulesets_sync_interval
end

#user_persistent_storage ⇒ Object

A storage adapter for persisted values. Can be used for sticky bucketing users in experiments. Implements Statsig::Interfaces::IUserPersistentStorage.



88
89
90
 
# File 'lib/statsig_options.rb', line 88

def user_persistent_storage
  @user_persistent_storage
end