Class: StatsigDriver
- Inherits:
-
Object
- Object
- StatsigDriver
- Defined in:
- lib/statsig_driver.rb
Instance Method Summary collapse
- #check_gate(user, gate_name, options = nil) ⇒ Object
- #clear_config_overrides ⇒ Object
- #clear_gate_overrides ⇒ Object
- #get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides) ⇒ Hash
- #get_config(user, dynamic_config_name, options = nil) ⇒ Object
- #get_experiment(user, experiment_name, options = nil) ⇒ Object
- #get_gate(user, gate_name, options = nil) ⇒ Object
- #get_gate_impl(user, gate_name, disable_log_exposure: false, skip_evaluation: false, disable_evaluation_details: false, ignore_local_overrides: false) ⇒ Object
- #get_layer(user, layer_name, options = nil) ⇒ Object
- #get_user_persisted_values(user, id_type) ⇒ Object
-
#initialize(secret_key, options = nil, error_callback = nil) ⇒ StatsigDriver
constructor
A new instance of StatsigDriver.
- #list_autotunes ⇒ Object
- #list_configs ⇒ Object
- #list_experiments ⇒ Object
- #list_gates ⇒ Object
- #list_layers ⇒ Object
- #log_event(user, event_name, value = nil, metadata = nil) ⇒ Object
- #manually_log_config_exposure(user, config_name) ⇒ Object
- #manually_log_gate_exposure(user, gate_name) ⇒ Object
- #manually_log_layer_parameter_exposure(user, layer_name, parameter_name) ⇒ Object
- #manually_sync_idlists ⇒ Object
- #manually_sync_rulesets ⇒ Object
- #maybe_restart_background_threads ⇒ Object
- #override_config(config_name, config_value) ⇒ Object
- #override_gate(gate_name, gate_value) ⇒ Object
- #remove_config_override(config_name) ⇒ Object
- #remove_gate_override(gate_name) ⇒ Object
- #shutdown ⇒ Object
Constructor Details
#initialize(secret_key, options = nil, error_callback = nil) ⇒ StatsigDriver
Returns a new instance of StatsigDriver.
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
# File 'lib/statsig_driver.rb', line 19 def initialize(secret_key, = nil, error_callback = nil) unless secret_key.start_with?('secret-') raise Statsig::ValueError.new('Invalid secret key provided. Provide your project secret key from the Statsig console') end if !.nil? && !.instance_of?(StatsigOptions) raise Statsig::ValueError.new('Invalid options provided. Either provide a valid StatsigOptions object or nil') end @err_boundary = Statsig::ErrorBoundary.new(secret_key) @err_boundary.capture(task: lambda { @diagnostics = Statsig::Diagnostics.new() tracker = @diagnostics.track('initialize', 'overall') @options = || StatsigOptions.new @shutdown = false @secret_key = secret_key @net = Statsig::Network.new(secret_key, @options) @logger = Statsig::StatsigLogger.new(@net, @options, @err_boundary) @persistent_storage_utils = Statsig::UserPersistentStorageUtils.new(@options) @store = Statsig::SpecStore.new(@net, @options, error_callback, @diagnostics, @err_boundary, @logger, secret_key) @evaluator = Statsig::Evaluator.new(@store, @options, @persistent_storage_utils) tracker.end(success: true) @logger.log_diagnostics_event(@diagnostics, 'initialize') }, caller: __method__.to_s) end |
Instance Method Details
#check_gate(user, gate_name, options = nil) ⇒ Object
84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/statsig_driver.rb', line 84 def check_gate(user, gate_name, = nil) @err_boundary.capture(task: lambda { run_with_diagnostics(task: lambda { get_gate_impl( user, gate_name, disable_log_exposure: &.disable_log_exposure == true, disable_evaluation_details: &.disable_evaluation_details == true, ignore_local_overrides: &.ignore_local_overrides == true ).value }, caller: __method__.to_s) }, recover: -> { false }, caller: __method__.to_s) end |
#clear_config_overrides ⇒ Object
286 287 288 289 290 |
# File 'lib/statsig_driver.rb', line 286 def clear_config_overrides @err_boundary.capture(task: lambda { @evaluator.clear_config_overrides }, caller: __method__.to_s) end |
#clear_gate_overrides ⇒ Object
268 269 270 271 272 |
# File 'lib/statsig_driver.rb', line 268 def clear_gate_overrides @err_boundary.capture(task: lambda { @evaluator.clear_gate_overrides }, caller: __method__.to_s) end |
#get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides) ⇒ Hash
296 297 298 299 300 301 302 |
# File 'lib/statsig_driver.rb', line 296 def get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides) @err_boundary.capture(task: lambda { validate_user(user) normalize_user(user) @evaluator.get_client_initialize_response(user, hash, client_sdk_key, include_local_overrides) }, recover: -> { nil }, caller: __method__.to_s) end |
#get_config(user, dynamic_config_name, options = nil) ⇒ Object
107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/statsig_driver.rb', line 107 def get_config(user, dynamic_config_name, = nil) @err_boundary.capture(task: lambda { run_with_diagnostics(task: lambda { user = verify_inputs(user, dynamic_config_name, "dynamic_config_name") get_config_impl( user, dynamic_config_name, &.disable_log_exposure == true, disable_evaluation_details: &.disable_evaluation_details == true, ignore_local_overrides: &.ignore_local_overrides == true ) }, caller: __method__.to_s) }, recover: -> { DynamicConfig.new(dynamic_config_name) }, caller: __method__.to_s) end |
#get_experiment(user, experiment_name, options = nil) ⇒ Object
122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/statsig_driver.rb', line 122 def get_experiment(user, experiment_name, = nil) @err_boundary.capture(task: lambda { run_with_diagnostics(task: lambda { user = verify_inputs(user, experiment_name, "experiment_name") get_config_impl( user, experiment_name, &.disable_log_exposure == true, user_persisted_values: &.user_persisted_values, disable_evaluation_details: &.disable_evaluation_details == true, ignore_local_overrides: &.ignore_local_overrides == true ) }, caller: __method__.to_s) }, recover: -> { DynamicConfig.new(experiment_name) }, caller: __method__.to_s) end |
#get_gate(user, gate_name, options = nil) ⇒ Object
72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/statsig_driver.rb', line 72 def get_gate(user, gate_name, = nil) @err_boundary.capture(task: lambda { run_with_diagnostics(task: lambda { get_gate_impl(user, gate_name, disable_log_exposure: &.disable_log_exposure == true, skip_evaluation: &.skip_evaluation == true, disable_evaluation_details: &.disable_evaluation_details == true ) }, caller: __method__.to_s) }, recover: -> { false }, caller: __method__.to_s) end |
#get_gate_impl(user, gate_name, disable_log_exposure: false, skip_evaluation: false, disable_evaluation_details: false, ignore_local_overrides: false) ⇒ Object
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 |
# File 'lib/statsig_driver.rb', line 46 def get_gate_impl( user, gate_name, disable_log_exposure: false, skip_evaluation: false, disable_evaluation_details: false, ignore_local_overrides: false ) if skip_evaluation gate = @store.get_gate(gate_name) return FeatureGate.new(gate_name) if gate.nil? return FeatureGate.new(gate.name, target_app_ids: gate.target_app_ids) end user = verify_inputs(user, gate_name, 'gate_name') res = Statsig::ConfigResult.new(name: gate_name, disable_exposures: disable_log_exposure, disable_evaluation_details: disable_evaluation_details) @evaluator.check_gate(user, gate_name, res, ignore_local_overrides: ignore_local_overrides) unless disable_log_exposure @logger.log_gate_exposure( user, res.name, res.gate_value, res.rule_id, res.secondary_exposures, res.evaluation_details ) end FeatureGate.from_config_result(res) end |
#get_layer(user, layer_name, options = nil) ⇒ Object
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/statsig_driver.rb', line 157 def get_layer(user, layer_name, = nil) @err_boundary.capture(task: lambda { run_with_diagnostics(task: lambda { user = verify_inputs(user, layer_name, "layer_name") exposures_disabled = &.disable_log_exposure == true res = Statsig::ConfigResult.new( name: layer_name, disable_exposures: exposures_disabled, disable_evaluation_details: &.disable_evaluation_details == true ) @evaluator.get_layer(user, layer_name, res) exposure_log_func = !exposures_disabled ? lambda { |layer, parameter_name| @logger.log_layer_exposure(user, layer, parameter_name, res) } : nil Layer.new(res.name, res.json_value, res.rule_id, res.group_name, res.config_delegate, exposure_log_func) }, caller: __method__.to_s) }, recover: lambda { Layer.new(layer_name) }, caller: __method__.to_s) end |
#get_user_persisted_values(user, id_type) ⇒ Object
148 149 150 151 152 153 154 155 |
# File 'lib/statsig_driver.rb', line 148 def get_user_persisted_values(user, id_type) @err_boundary.capture(task: lambda { persisted_values = @persistent_storage_utils.get_user_persisted_values(user, id_type) return {} if persisted_values.nil? persisted_values }, caller: __method__.to_s) end |
#list_autotunes ⇒ Object
236 237 238 239 240 |
# File 'lib/statsig_driver.rb', line 236 def list_autotunes @err_boundary.capture(task: lambda { @evaluator.list_autotunes }, caller: __method__.to_s) end |
#list_configs ⇒ Object
224 225 226 227 228 |
# File 'lib/statsig_driver.rb', line 224 def list_configs @err_boundary.capture(task: lambda { @evaluator.list_configs }, caller: __method__.to_s) end |
#list_experiments ⇒ Object
230 231 232 233 234 |
# File 'lib/statsig_driver.rb', line 230 def list_experiments @err_boundary.capture(task: lambda { @evaluator.list_experiments }, caller: __method__.to_s) end |
#list_gates ⇒ Object
218 219 220 221 222 |
# File 'lib/statsig_driver.rb', line 218 def list_gates @err_boundary.capture(task: lambda { @evaluator.list_gates }, caller: __method__.to_s) end |
#list_layers ⇒ Object
242 243 244 245 246 |
# File 'lib/statsig_driver.rb', line 242 def list_layers @err_boundary.capture(task: lambda { @evaluator.list_layers }, caller: __method__.to_s) end |
#log_event(user, event_name, value = nil, metadata = nil) ⇒ Object
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/statsig_driver.rb', line 189 def log_event(user, event_name, value = nil, = nil) @err_boundary.capture(task: lambda { if !user.nil? && !user.instance_of?(StatsigUser) raise Statsig::ValueError.new('Must provide a valid StatsigUser or nil') end check_shutdown user = normalize_user(user) event = StatsigEvent.new(event_name) event.user = user event.value = value event. = @logger.log_event(event) }, caller: __method__.to_s) end |
#manually_log_config_exposure(user, config_name) ⇒ Object
138 139 140 141 142 143 144 145 146 |
# File 'lib/statsig_driver.rb', line 138 def manually_log_config_exposure(user, config_name) @err_boundary.capture(task: lambda { res = Statsig::ConfigResult.new(name: config_name) @evaluator.get_config(user, config_name, res) context = { :is_manual_exposure => true } @logger.log_config_exposure(user, res.name, res.rule_id, res.secondary_exposures, res.evaluation_details, context) }, caller: __method__.to_s) end |
#manually_log_gate_exposure(user, gate_name) ⇒ Object
98 99 100 101 102 103 104 105 |
# File 'lib/statsig_driver.rb', line 98 def manually_log_gate_exposure(user, gate_name) @err_boundary.capture(task: lambda { res = Statsig::ConfigResult.new(name: gate_name) @evaluator.check_gate(user, gate_name, res) context = { :is_manual_exposure => true } @logger.log_gate_exposure(user, gate_name, res.gate_value, res.rule_id, res.secondary_exposures, res.evaluation_details, context) }) end |
#manually_log_layer_parameter_exposure(user, layer_name, parameter_name) ⇒ Object
178 179 180 181 182 183 184 185 186 187 |
# File 'lib/statsig_driver.rb', line 178 def manually_log_layer_parameter_exposure(user, layer_name, parameter_name) @err_boundary.capture(task: lambda { res = Statsig::ConfigResult.new(name: layer_name) @evaluator.get_layer(user, layer_name, res) layer = Layer.new(layer_name, res.json_value, res.rule_id, res.group_name, res.config_delegate) context = { :is_manual_exposure => true } @logger.log_layer_exposure(user, layer, parameter_name, res, context) }, caller: __method__.to_s) end |
#manually_sync_idlists ⇒ Object
212 213 214 215 216 |
# File 'lib/statsig_driver.rb', line 212 def manually_sync_idlists @err_boundary.capture(task: lambda { @evaluator.spec_store.sync_id_lists }, caller: __method__.to_s) end |
#manually_sync_rulesets ⇒ Object
206 207 208 209 210 |
# File 'lib/statsig_driver.rb', line 206 def manually_sync_rulesets @err_boundary.capture(task: lambda { @evaluator.spec_store.sync_config_specs }, caller: __method__.to_s) end |
#maybe_restart_background_threads ⇒ Object
304 305 306 307 308 309 310 311 312 313 |
# File 'lib/statsig_driver.rb', line 304 def maybe_restart_background_threads if @options.local_mode return end @err_boundary.capture(task: lambda { @evaluator.maybe_restart_background_threads @logger.maybe_restart_background_threads }, caller: __method__.to_s) end |
#override_config(config_name, config_value) ⇒ Object
274 275 276 277 278 |
# File 'lib/statsig_driver.rb', line 274 def override_config(config_name, config_value) @err_boundary.capture(task: lambda { @evaluator.override_config(config_name, config_value) }, caller: __method__.to_s) end |
#override_gate(gate_name, gate_value) ⇒ Object
256 257 258 259 260 |
# File 'lib/statsig_driver.rb', line 256 def override_gate(gate_name, gate_value) @err_boundary.capture(task: lambda { @evaluator.override_gate(gate_name, gate_value) }, caller: __method__.to_s) end |
#remove_config_override(config_name) ⇒ Object
280 281 282 283 284 |
# File 'lib/statsig_driver.rb', line 280 def remove_config_override(config_name) @err_boundary.capture(task: lambda { @evaluator.remove_config_override(config_name) }, caller: __method__.to_s) end |
#remove_gate_override(gate_name) ⇒ Object
262 263 264 265 266 |
# File 'lib/statsig_driver.rb', line 262 def remove_gate_override(gate_name) @err_boundary.capture(task: lambda { @evaluator.remove_gate_override(gate_name) }, caller: __method__.to_s) end |
#shutdown ⇒ Object
248 249 250 251 252 253 254 |
# File 'lib/statsig_driver.rb', line 248 def shutdown @err_boundary.capture(task: lambda { @shutdown = true @logger.shutdown @evaluator.shutdown }, caller: __method__.to_s) end |