Class: SplitIoClient::SplitConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/splitclient-rb/split_config.rb

Overview

This class manages configuration options for the split client library. If not custom configuration is required the default configuration values will be used

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ type

Constructor for creating custom split client config

Parameters:

  • opts (Hash) (defaults to: {}) —

    optional hash with configuration options

Options Hash (opts):

  • :base_uri (String) — default: "https://sdk.split.io/api/" —

    The base URL for split API end points

  • :events_uri (String) — default: "https://events.split.io/api/" —

    The events URL for events end points

  • :read_timeout (Int) — default: 10 —

    The read timeout for network connections in seconds.

  • :connection_timeout (Int) — default: 2 —

    The connect timeout for network connections in seconds.

  • :features_refresh_rate (Int) —

    The SDK polls Split servers for changes to feature roll-out plans. This parameter controls this polling period in seconds.

  • :segments_refresh_rate (Int)
  • :metrics_refresh_rate (Int)
  • :impressions_refresh_rate (Int)
  • :logger (Object) —

    a logger to user for messages from the client. Defaults to stdout

  • :debug_enabled (Boolean) — default: false —

    The value for the debug flag

  • :impressions_queue_size (Int) —

    how big the impressions queue is before dropping impressions. -1 to disable it.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/splitclient-rb/split_config.rb', line 27

def initialize(opts = {})
  @base_uri = (opts[:base_uri] || SplitConfig.default_base_uri).chomp('/')
  @events_uri = (opts[:events_uri] || SplitConfig.default_events_uri).chomp('/')
  @mode = opts[:mode] || SplitConfig.default_mode
  @redis_url = opts[:redis_url] || SplitConfig.default_redis_url
  @redis_namespace = opts[:redis_namespace] || SplitConfig.default_redis_namespace
  @cache_adapter = SplitConfig.init_cache_adapter(
    opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, @redis_url, false
  )
  @connection_timeout = opts[:connection_timeout] || SplitConfig.default_connection_timeout
  @read_timeout = opts[:read_timeout] || SplitConfig.default_read_timeout
  @features_refresh_rate = opts[:features_refresh_rate] || SplitConfig.default_features_refresh_rate
  @segments_refresh_rate = opts[:segments_refresh_rate] || SplitConfig.default_segments_refresh_rate
  @metrics_refresh_rate = opts[:metrics_refresh_rate] || SplitConfig.default_metrics_refresh_rate

  @impressions_refresh_rate = opts[:impressions_refresh_rate] || SplitConfig.default_impressions_refresh_rate
  @impressions_queue_size = opts[:impressions_queue_size] || SplitConfig.default_impressions_queue_size
  @impressions_adapter = SplitConfig.init_cache_adapter(
    opts[:cache_adapter] || SplitConfig.default_cache_adapter, :queue_adapter, @redis_url, @impressions_queue_size
  )

  @metrics_adapter = SplitConfig.init_cache_adapter(
    opts[:cache_adapter] || SplitConfig.default_cache_adapter, :map_adapter, @redis_url, false
  )

  @logger = opts[:logger] || SplitConfig.default_logger
  @debug_enabled = opts[:debug_enabled] || SplitConfig.default_debug
  @transport_debug_enabled = opts[:transport_debug_enabled] || SplitConfig.default_debug
  @block_until_ready = opts[:ready] || opts[:block_until_ready] || 0
  @machine_name = SplitConfig.get_hostname
  @machine_ip = SplitConfig.get_ip

  @labels_enabled = opts[:labels_enabled].nil? ? SplitConfig.default_labels_logging : opts[:labels_enabled]

  startup_log
end

Instance Attribute Details

#base_uri ⇒ String (readonly)

The base URL for split API end points

Returns:

  • (String) —

    The configured base URL for the split API end points



68
69
70
 
# File 'lib/splitclient-rb/split_config.rb', line 68

def base_uri
  @base_uri
end

#block_until_ready ⇒ Integer (readonly)

The number of seconds to wait for SDK readiness or false to disable waiting

Returns:

  • (Integer) —

    /[FalseClass]



140
141
142
 
# File 'lib/splitclient-rb/split_config.rb', line 140

def block_until_ready
  @block_until_ready
end

#cache_adapter ⇒ Object (readonly)

The cache adapter to store splits/segments in

Returns:

  • (Object) —

    Cache adapter instance



91
92
93
 
# File 'lib/splitclient-rb/split_config.rb', line 91

def cache_adapter
  @cache_adapter
end

#connection_timeout ⇒ Int (readonly)

The connection timeout for network connections in seconds.

Returns:

  • (Int) —

    The connect timeout in seconds.



109
110
111
 
# File 'lib/splitclient-rb/split_config.rb', line 109

def connection_timeout
  @connection_timeout
end

#debug_enabled ⇒ Boolean (readonly)

The boolean that represents the state of the debug log level

Returns:

  • (Boolean) —

    The value for the debug flag



122
123
124
 
# File 'lib/splitclient-rb/split_config.rb', line 122

def debug_enabled
  @debug_enabled
end

#events_uri ⇒ String (readonly)

The base URL for split events API end points

Returns:

  • (String) —

    The configured URL for the events API end points



74
75
76
 
# File 'lib/splitclient-rb/split_config.rb', line 74

def events_uri
  @events_uri
end

#features_refresh_rate ⇒ Object (readonly)

Returns the value of attribute features_refresh_rate.



145
146
147
 
# File 'lib/splitclient-rb/split_config.rb', line 145

def features_refresh_rate
  @features_refresh_rate
end

#impressions_adapter ⇒ Object (readonly)

The cache adapter to store impressions in

Returns:

  • (Object) —

    Impressions adapter instance



97
98
99
 
# File 'lib/splitclient-rb/split_config.rb', line 97

def impressions_adapter
  @impressions_adapter
end

#impressions_queue_size ⇒ Integer (readonly)

Wow big the impressions queue is before dropping impressions. -1 to disable it.

Returns:

  • (Integer) 


154
155
156
 
# File 'lib/splitclient-rb/split_config.rb', line 154

def impressions_queue_size
  @impressions_queue_size
end

#impressions_refresh_rate ⇒ Object (readonly)

Returns the value of attribute impressions_refresh_rate.



148
149
150
 
# File 'lib/splitclient-rb/split_config.rb', line 148

def impressions_refresh_rate
  @impressions_refresh_rate
end

#labels_enabled ⇒ Boolean (readonly)

Enable logging labels and sending potentially sensitive information

Returns:

  • (Boolean) —

    The value for the labels enabled flag



134
135
136
 
# File 'lib/splitclient-rb/split_config.rb', line 134

def labels_enabled
  @labels_enabled
end

#logger ⇒ Logger (readonly)

The configured logger. The client library uses the log to print warning and error messages.

Returns:

  • (Logger) —

    The configured logger



116
117
118
 
# File 'lib/splitclient-rb/split_config.rb', line 116

def logger
  @logger
end

#machine_ip ⇒ Object (readonly)

Returns the value of attribute machine_ip.



142
143
144
 
# File 'lib/splitclient-rb/split_config.rb', line 142

def machine_ip
  @machine_ip
end

#machine_name ⇒ Object (readonly)

Returns the value of attribute machine_name.



143
144
145
 
# File 'lib/splitclient-rb/split_config.rb', line 143

def machine_name
  @machine_name
end

#metrics_adapter ⇒ Symbol (readonly)

The cache adapter to store metrics in

Returns:

  • (Symbol) —

    Metrics adapter



103
104
105
 
# File 'lib/splitclient-rb/split_config.rb', line 103

def metrics_adapter
  @metrics_adapter
end

#metrics_refresh_rate ⇒ Object (readonly)

Returns the value of attribute metrics_refresh_rate.



147
148
149
 
# File 'lib/splitclient-rb/split_config.rb', line 147

def metrics_refresh_rate
  @metrics_refresh_rate
end

#mode ⇒ Symbol (readonly)

The mode SDK will run

Returns:

  • (Symbol) —

    One of the available SDK modes: standalone, consumer, producer



80
81
82
 
# File 'lib/splitclient-rb/split_config.rb', line 80

def mode
  @mode
end

#read_timeout ⇒ Int (readonly)

The read timeout for network connections in seconds.

Returns:

  • (Int) —

    The timeout in seconds.



85
86
87
 
# File 'lib/splitclient-rb/split_config.rb', line 85

def read_timeout
  @read_timeout
end

#redis_namespace ⇒ Object (readonly)

Returns the value of attribute redis_namespace.



157
158
159
 
# File 'lib/splitclient-rb/split_config.rb', line 157

def redis_namespace
  @redis_namespace
end

#redis_url ⇒ Object (readonly)

Returns the value of attribute redis_url.



156
157
158
 
# File 'lib/splitclient-rb/split_config.rb', line 156

def redis_url
  @redis_url
end

#segments_refresh_rate ⇒ Object (readonly)

Returns the value of attribute segments_refresh_rate.



146
147
148
 
# File 'lib/splitclient-rb/split_config.rb', line 146

def segments_refresh_rate
  @segments_refresh_rate
end

#transport_debug_enabled ⇒ Boolean (readonly)

Enable to log the content retrieved from endpoints

Returns:

  • (Boolean) —

    The value for the debug flag



128
129
130
 
# File 'lib/splitclient-rb/split_config.rb', line 128

def transport_debug_enabled
  @transport_debug_enabled
end

Class Method Details

.default ⇒ Config

The default split client configuration

Returns:

  • (Config) —

    The default split client configuration.



163
164
165
 
# File 'lib/splitclient-rb/split_config.rb', line 163

def self.default
  SplitConfig.new
end

.default_base_uri ⇒ string

The default base uri for api calls

Returns:

  • (string) —

    The default base uri



179
180
181
 
# File 'lib/splitclient-rb/split_config.rb', line 179

def self.default_base_uri
  'https://sdk.split.io/api/'
end

.default_cache_adapter ⇒ LocalStore

Returns configuration value for local cache store.

Returns:

  • (LocalStore) —

    configuration value for local cache store



212
213
214
 
# File 'lib/splitclient-rb/split_config.rb', line 212

def self.default_cache_adapter
  :memory
end

.default_connection_timeout ⇒ int

The default connection timeout value

Returns:

  • (int) 


232
233
234
 
# File 'lib/splitclient-rb/split_config.rb', line 232

def self.default_connection_timeout
  5
end

.default_debug ⇒ boolean

The default debug value

Returns:

  • (boolean) 


268
269
270
 
# File 'lib/splitclient-rb/split_config.rb', line 268

def self.default_debug
  false
end

.default_events_uri ⇒ Object 



183
184
185
 
# File 'lib/splitclient-rb/split_config.rb', line 183

def self.default_events_uri
  'https://events.split.io/api/'
end

.default_features_refresh_rate ⇒ Object 



236
237
238
 
# File 'lib/splitclient-rb/split_config.rb', line 236

def self.default_features_refresh_rate
  30
end

.default_impressions_queue_size ⇒ Object 



252
253
254
 
# File 'lib/splitclient-rb/split_config.rb', line 252

def self.default_impressions_queue_size
  5000
end

.default_impressions_refresh_rate ⇒ Object 



248
249
250
 
# File 'lib/splitclient-rb/split_config.rb', line 248

def self.default_impressions_refresh_rate
  60
end

.default_labels_logging ⇒ boolean

The default labels logging value

Returns:

  • (boolean) 


276
277
278
 
# File 'lib/splitclient-rb/split_config.rb', line 276

def self.default_labels_logging
  true
end

.default_logger ⇒ object

The default logger object

Returns:

  • (object) 


260
261
262
 
# File 'lib/splitclient-rb/split_config.rb', line 260

def self.default_logger
  Logger.new($stdout)
end

.default_metrics_adapter ⇒ Object 



216
217
218
 
# File 'lib/splitclient-rb/split_config.rb', line 216

def self.default_metrics_adapter
  :memory
end

.default_metrics_refresh_rate ⇒ Object 



244
245
246
 
# File 'lib/splitclient-rb/split_config.rb', line 244

def self.default_metrics_refresh_rate
  60
end

.default_mode ⇒ Object 



207
208
209
 
# File 'lib/splitclient-rb/split_config.rb', line 207

def self.default_mode
  :standalone
end

.default_read_timeout ⇒ int

The default read timeout value

Returns:

  • (int) 


224
225
226
 
# File 'lib/splitclient-rb/split_config.rb', line 224

def self.default_read_timeout
  5
end

.default_redis_namespace ⇒ Object 



284
285
286
 
# File 'lib/splitclient-rb/split_config.rb', line 284

def self.default_redis_namespace
  "SPLITIO/ruby-#{VERSION}"
end

.default_redis_url ⇒ Object 



280
281
282
 
# File 'lib/splitclient-rb/split_config.rb', line 280

def self.default_redis_url
  'redis://127.0.0.1:6379/0'
end

.default_segments_refresh_rate ⇒ Object 



240
241
242
 
# File 'lib/splitclient-rb/split_config.rb', line 240

def self.default_segments_refresh_rate
  60
end

.get_hostname ⇒ string

gets the hostname where the sdk gem is running

Returns:

  • (string) 


321
322
323
324
325
326
327
328
 
# File 'lib/splitclient-rb/split_config.rb', line 321

def self.get_hostname
  begin
    Socket.gethostname
  rescue
    #unable to get hostname
    'localhost'
  end
end

.get_ip ⇒ string

gets the ip where the sdk gem is running

Returns:

  • (string) 


334
335
336
337
338
 
# File 'lib/splitclient-rb/split_config.rb', line 334

def self.get_ip
  Socket.ip_address_list.detect { |intf| intf.ipv4_private? }.ip_address
rescue StandardError
  'unknown'
end

.init_cache_adapter(adapter, data_structure, redis_url = nil, impressions_queue_size = nil) ⇒ Object 



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/splitclient-rb/split_config.rb', line 187

def self.init_cache_adapter(adapter, data_structure, redis_url = nil, impressions_queue_size = nil)
  case adapter
  when :memory
    # takes :memory_adapter (symbol) and returns MemoryAdapter (string)
    adapter = SplitIoClient::Cache::Adapters::MemoryAdapters.const_get(
      data_structure.to_s.split('_').collect(&:capitalize).join
    ).new(impressions_queue_size)

    SplitIoClient::Cache::Adapters::MemoryAdapter.new(adapter)
  when :redis
    begin
      require 'redis'
    rescue LoadError
      fail StandardError, 'To use Redis as a cache adapter you must include it in your Gemfile'
    end

    SplitIoClient::Cache::Adapters::RedisAdapter.new(redis_url)
  end
end

.sdk_version ⇒ string

method that returns the sdk gem version

Returns:

  • (string) —

    version value for this sdk



171
172
173
 
# File 'lib/splitclient-rb/split_config.rb', line 171

def self.sdk_version
  'ruby-'+SplitIoClient::VERSION
end

.transport_debug ⇒ boolean

The default transport_debug_enabled value

Returns:

  • (boolean) 


292
293
294
 
# File 'lib/splitclient-rb/split_config.rb', line 292

def self.transport_debug
  false
end

Instance Method Details

#log_found_exception(caller, exn) ⇒ void

This method returns an undefined value.

custom logger of exceptions



300
301
302
303
304
 
# File 'lib/splitclient-rb/split_config.rb', line 300

def log_found_exception(caller, exn)
  error_traceback = "#{exn.inspect} #{exn}\n\t#{exn.backtrace.join("\n\t")}"
  error = "[splitclient-rb] Unexpected exception in #{caller}: #{error_traceback}"
  @logger.error(error)
end

#startup_log ⇒ void

This method returns an undefined value.

log which cache class was loaded and SDK mode



310
311
312
313
314
315
 
# File 'lib/splitclient-rb/split_config.rb', line 310

def startup_log
  return if ENV['SPLITCLIENT_ENV'] == 'test'

  @logger.info("Loaded SDK in the #{@mode} mode")
  @logger.info("Loaded cache class: #{@cache_adapter.class}")
end