Class: LaunchDarkly::Config

Inherits:
Object
  • Object
show all
Defined in:
lib/ldclient-rb/config.rb

Overview

This class exposes advanced configuration options for the LaunchDarkly client library. Most users will not need to use a custom configuration-- the default configuration sets sane defaults for most use cases.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Config

Constructor for creating custom LaunchDarkly configurations.

Parameters:

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

    the configuration options

Options Hash (opts):

  • :logger (Logger) —

    See #logger.

  • :base_uri (String) — default: "https://app.launchdarkly.com" —

    See #base_uri.

  • :stream_uri (String) — default: "https://stream.launchdarkly.com" —

    See #stream_uri.

  • :events_uri (String) — default: "https://events.launchdarkly.com" —

    See #events_uri.

  • :capacity (Integer) — default: 10000 —

    See #capacity.

  • :flush_interval (Float) — default: 30 —

    See #flush_interval.

  • :read_timeout (Float) — default: 10 —

    See #read_timeout.

  • :connect_timeout (Float) — default: 2 —

    See #connect_timeout.

  • :cache_store (Object) —

    See #cache_store.

  • :feature_store (Object) —

    See #feature_store.

  • :use_ldd (Boolean) — default: false —

    See #use_ldd?.

  • :offline (Boolean) — default: false —

    See #offline?.

  • :poll_interval (Float) — default: 30 —

    See #poll_interval.

  • :stream (Boolean) — default: true —

    See #stream?.

  • all_attributes_private (Boolean) — default: false —

    See #all_attributes_private.

  • :private_attribute_names (Array) —

    See #private_attribute_names.

  • :send_events (Boolean) — default: true —

    See #send_events.

  • :user_keys_capacity (Integer) — default: 1000 —

    See #user_keys_capacity.

  • :user_keys_flush_interval (Float) — default: 300 —

    See #user_keys_flush_interval.

  • :inline_users_in_events (Boolean) — default: false —

    See #inline_users_in_events.

  • :data_source (Object) —

    See #data_source.

  • :update_processor (Object) —

    Obsolete synonym for data_source.

  • :update_processor_factory (Object) —

    Obsolete synonym for data_source.



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ldclient-rb/config.rb', line 41

def initialize(opts = {})
  @base_uri = (opts[:base_uri] || Config.default_base_uri).chomp("/")
  @stream_uri = (opts[:stream_uri] || Config.default_stream_uri).chomp("/")
  @events_uri = (opts[:events_uri] || Config.default_events_uri).chomp("/")
  @capacity = opts[:capacity] || Config.default_capacity
  @logger = opts[:logger] || Config.default_logger
  @cache_store = opts[:cache_store] || Config.default_cache_store
  @flush_interval = opts[:flush_interval] || Config.default_flush_interval
  @connect_timeout = opts[:connect_timeout] || Config.default_connect_timeout
  @read_timeout = opts[:read_timeout] || Config.default_read_timeout
  @feature_store = opts[:feature_store] || Config.default_feature_store
  @stream = opts.has_key?(:stream) ? opts[:stream] : Config.default_stream
  @use_ldd = opts.has_key?(:use_ldd) ? opts[:use_ldd] : Config.default_use_ldd
  @offline = opts.has_key?(:offline) ? opts[:offline] : Config.default_offline
  @poll_interval = opts.has_key?(:poll_interval) && opts[:poll_interval] > Config.default_poll_interval ? opts[:poll_interval] : Config.default_poll_interval
  @all_attributes_private = opts[:all_attributes_private] || false
  @private_attribute_names = opts[:private_attribute_names] || []
  @send_events = opts.has_key?(:send_events) ? opts[:send_events] : Config.default_send_events
  @user_keys_capacity = opts[:user_keys_capacity] || Config.default_user_keys_capacity
  @user_keys_flush_interval = opts[:user_keys_flush_interval] || Config.default_user_keys_flush_interval
  @inline_users_in_events = opts[:inline_users_in_events] || false
  @data_source = opts[:data_source] || opts[:update_processor] || opts[:update_processor_factory]
  @update_processor = opts[:update_processor]
  @update_processor_factory = opts[:update_processor_factory]
end

Instance Attribute Details

#all_attributes_private ⇒ Boolean (readonly)

True if all user attributes (other than the key) should be considered private. This means that the attribute values will not be sent to LaunchDarkly in analytics events and will not appear on the LaunchDarkly dashboard.

Returns:

  • (Boolean)

See Also:



194
195
196
 
# File 'lib/ldclient-rb/config.rb', line 194

def all_attributes_private
  @all_attributes_private
end

#base_uri ⇒ String (readonly)

The base URL for the LaunchDarkly server. This is configurable mainly for testing purposes; most users should use the default value.

Returns:

  • (String) 


72
73
74
 
# File 'lib/ldclient-rb/config.rb', line 72

def base_uri
  @base_uri
end

#cache_store ⇒ Object (readonly)

A store for HTTP caching (used only in polling mode). This must support the semantics used by the faraday-http-cache gem, although the SDK no longer uses Faraday. Defaults to the Rails cache in a Rails environment, or a thread-safe in-memory store otherwise.

Returns:

  • (Object) 


161
162
163
 
# File 'lib/ldclient-rb/config.rb', line 161

def cache_store
  @cache_store
end

#capacity ⇒ Integer (readonly)

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, events will be discarded. Increasing the capacity means that events are less likely to be discarded, at the cost of consuming more memory.

Returns:

  • (Integer) 


152
153
154
 
# File 'lib/ldclient-rb/config.rb', line 152

def capacity
  @capacity
end

#connect_timeout ⇒ Float (readonly)

The connect timeout for network connections in seconds.

Returns:

  • (Float) 


174
175
176
 
# File 'lib/ldclient-rb/config.rb', line 174

def connect_timeout
  @connect_timeout
end

#data_source ⇒ LaunchDarkly::Interfaces::DataSource|lambda (readonly)

An object that is responsible for receiving feature flag data from LaunchDarkly. By default, the client uses its standard polling or streaming implementation; this is customizable for testing purposes.

This may be set to either an object that conforms to Interfaces::DataSource, or a lambda (or Proc) that takes two parameters-- SDK key and LaunchDarkly::Config-- and returns such an object.

Returns:

See Also:



252
253
254
 
# File 'lib/ldclient-rb/config.rb', line 252

def data_source
  @data_source
end

#events_uri ⇒ String (readonly)

The base URL for the LaunchDarkly events server. This is configurable mainly for testing purposes; most users should use the default value.

Returns:

  • (String) 


86
87
88
 
# File 'lib/ldclient-rb/config.rb', line 86

def events_uri
  @events_uri
end

#feature_store ⇒ LaunchDarkly::Interfaces::FeatureStore (readonly)

A store for feature flags and related data. The client uses it to store all data received from LaunchDarkly, and uses the last stored data when evaluating flags. Defaults to InMemoryFeatureStore; for other implementations, see Integrations.

For more information, see "Using a persistent feature store".

Returns:



185
186
187
 
# File 'lib/ldclient-rb/config.rb', line 185

def feature_store
  @feature_store
end

#flush_interval ⇒ Float (readonly)

The number of seconds between flushes of the event buffer. Decreasing the flush interval means that the event buffer is less likely to reach capacity.

Returns:

  • (Float) 


127
128
129
 
# File 'lib/ldclient-rb/config.rb', line 127

def flush_interval
  @flush_interval
end

#inline_users_in_events ⇒ Boolean (readonly)

Whether to include full user details in every analytics event. By default, events will only include the user key, except for one "index" event that provides the full details for the user. The only reason to change this is if you are using the Analytics Data Stream.

Returns:

  • (Boolean) 


238
239
240
 
# File 'lib/ldclient-rb/config.rb', line 238

def inline_users_in_events
  @inline_users_in_events
end

#logger ⇒ Logger (readonly)

The configured logger for the LaunchDarkly client. The client library uses the log to print warning and error messages. If not specified, this defaults to the Rails logger in a Rails environment, or stdout otherwise.

Returns:

  • (Logger) 


142
143
144
 
# File 'lib/ldclient-rb/config.rb', line 142

def logger
  @logger
end

#poll_interval ⇒ Float (readonly)

The number of seconds to wait before polling for feature flag updates. This option has no effect unless streaming is disabled.

Returns:

  • (Float) 


134
135
136
 
# File 'lib/ldclient-rb/config.rb', line 134

def poll_interval
  @poll_interval
end

#private_attribute_names ⇒ Array<String> (readonly)

A list of user attribute names that should always be considered private. This means that the attribute values will not be sent to LaunchDarkly in analytics events and will not appear on the LaunchDarkly dashboard.

You can also specify the same behavior for an individual flag evaluation by storing an array of attribute names in the :privateAttributeNames property (note camelcase name) of the user object.

Returns:

  • (Array<String>)

See Also:



208
209
210
 
# File 'lib/ldclient-rb/config.rb', line 208

def private_attribute_names
  @private_attribute_names
end

#read_timeout ⇒ Float (readonly)

The read timeout for network connections in seconds. This does not apply to the streaming connection, which uses a longer timeout since the server does not send data constantly.

Returns:

  • (Float) 


168
169
170
 
# File 'lib/ldclient-rb/config.rb', line 168

def read_timeout
  @read_timeout
end

#send_events ⇒ Boolean (readonly)

Whether to send events back to LaunchDarkly. This differs from #offline? in that it affects only the sending of client-side events, not streaming or polling for events from the server.

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/ldclient-rb/config.rb', line 215

def send_events
  @send_events
end

#stream_uri ⇒ String (readonly)

The base URL for the LaunchDarkly streaming server. This is configurable mainly for testing purposes; most users should use the default value.

Returns:

  • (String) 


79
80
81
 
# File 'lib/ldclient-rb/config.rb', line 79

def stream_uri
  @stream_uri
end

#update_processor ⇒ Object (readonly)

Deprecated.

This is replaced by #data_source.



255
256
257
 
# File 'lib/ldclient-rb/config.rb', line 255

def update_processor
  @update_processor
end

#update_processor_factory ⇒ Object (readonly)

Deprecated.

This is replaced by #data_source.



258
259
260
 
# File 'lib/ldclient-rb/config.rb', line 258

def update_processor_factory
  @update_processor_factory
end

#user_keys_capacity ⇒ Integer (readonly)

The number of user keys that the event processor can remember at any one time. This reduces the amount of duplicate user details sent in analytics events.

Returns:

  • (Integer)

See Also:



223
224
225
 
# File 'lib/ldclient-rb/config.rb', line 223

def user_keys_capacity
  @user_keys_capacity
end

#user_keys_flush_interval ⇒ Float (readonly)

The interval in seconds at which the event processor will reset its set of known user keys.

Returns:

  • (Float)

See Also:



230
231
232
 
# File 'lib/ldclient-rb/config.rb', line 230

def user_keys_flush_interval
  @user_keys_flush_interval
end

Class Method Details

.default ⇒ Config

The default LaunchDarkly client configuration. This configuration sets reasonable defaults for most users.

Returns:

  • (Config) —

    The default LaunchDarkly configuration.



265
266
267
 
# File 'lib/ldclient-rb/config.rb', line 265

def self.default
  Config.new
end

.default_base_uri ⇒ String

The default value for #base_uri.

Returns:



281
282
283
 
# File 'lib/ldclient-rb/config.rb', line 281

def self.default_base_uri
  "https://app.launchdarkly.com"
end

.default_cache_store ⇒ Object

The default value for #cache_store.

Returns:

  • (Object) —

    the Rails cache if in Rails, or a simple in-memory implementation otherwise



305
306
307
 
# File 'lib/ldclient-rb/config.rb', line 305

def self.default_cache_store
  defined?(Rails) && Rails.respond_to?(:cache) ? Rails.cache : ThreadSafeMemoryStore.new
end

.default_capacity ⇒ Integer

The default value for #capacity.

Returns:

  • (Integer) —

    10000



273
274
275
 
# File 'lib/ldclient-rb/config.rb', line 273

def self.default_capacity
  10000
end

.default_connect_timeout ⇒ Float

The default value for #connect_timeout.

Returns:

  • (Float) —

    10



329
330
331
 
# File 'lib/ldclient-rb/config.rb', line 329

def self.default_connect_timeout
  2
end

.default_events_uri ⇒ String

The default value for #events_uri.

Returns:



297
298
299
 
# File 'lib/ldclient-rb/config.rb', line 297

def self.default_events_uri
  "https://events.launchdarkly.com"
end

.default_feature_store ⇒ LaunchDarkly::Interfaces::FeatureStore

The default value for #feature_store.

Returns:



367
368
369
 
# File 'lib/ldclient-rb/config.rb', line 367

def self.default_feature_store
  InMemoryFeatureStore.new
end

.default_flush_interval ⇒ Float

The default value for #flush_interval.

Returns:

  • (Float) —

    10



313
314
315
 
# File 'lib/ldclient-rb/config.rb', line 313

def self.default_flush_interval
  10
end

.default_logger ⇒ Logger

The default value for #logger.

Returns:

  • (Logger) —

    the Rails logger if in Rails, or a default Logger at WARN level otherwise



337
338
339
340
341
342
343
344
345
 
# File 'lib/ldclient-rb/config.rb', line 337

def self.default_logger
  if defined?(Rails) && Rails.respond_to?(:logger)
    Rails.logger 
  else 
    log = ::Logger.new($stdout)
    log.level = ::Logger::WARN
    log
  end
end

.default_offline ⇒ Boolean

The default value for #offline?.

Returns:

  • (Boolean) —

    false



375
376
377
 
# File 'lib/ldclient-rb/config.rb', line 375

def self.default_offline
  false
end

.default_poll_interval ⇒ Float

The default value for #poll_interval.

Returns:

  • (Float) —

    30



383
384
385
 
# File 'lib/ldclient-rb/config.rb', line 383

def self.default_poll_interval
  30
end

.default_read_timeout ⇒ Float

The default value for #read_timeout.

Returns:

  • (Float) —

    10



321
322
323
 
# File 'lib/ldclient-rb/config.rb', line 321

def self.default_read_timeout
  10
end

.default_send_events ⇒ Boolean

The default value for #send_events.

Returns:

  • (Boolean) —

    true



391
392
393
 
# File 'lib/ldclient-rb/config.rb', line 391

def self.default_send_events
  true
end

.default_stream ⇒ Boolean

The default value for #stream?.

Returns:

  • (Boolean) —

    true



351
352
353
 
# File 'lib/ldclient-rb/config.rb', line 351

def self.default_stream
  true
end

.default_stream_uri ⇒ String

The default value for #stream_uri.

Returns:



289
290
291
 
# File 'lib/ldclient-rb/config.rb', line 289

def self.default_stream_uri
  "https://stream.launchdarkly.com"
end

.default_use_ldd ⇒ Boolean

The default value for #use_ldd?.

Returns:

  • (Boolean) —

    false



359
360
361
 
# File 'lib/ldclient-rb/config.rb', line 359

def self.default_use_ldd
  false
end

.default_user_keys_capacity ⇒ Integer

The default value for #user_keys_capacity.

Returns:

  • (Integer) —

    1000



399
400
401
 
# File 'lib/ldclient-rb/config.rb', line 399

def self.default_user_keys_capacity
  1000
end

.default_user_keys_flush_interval ⇒ Float

The default value for #user_keys_flush_interval.

Returns:

  • (Float) —

    300



407
408
409
 
# File 'lib/ldclient-rb/config.rb', line 407

def self.default_user_keys_flush_interval
  300
end

Instance Method Details

#offline? ⇒ Boolean

Whether the client should be initialized in offline mode. In offline mode, default values are returned for all flags and no remote network requests are made.

Returns:

  • (Boolean) 


118
119
120
 
# File 'lib/ldclient-rb/config.rb', line 118

def offline?
  @offline
end

#stream? ⇒ Boolean

Whether streaming mode should be enabled. Streaming mode asynchronously updates feature flags in real-time using server-sent events. Streaming is enabled by default, and should only be disabled on the advice of LaunchDarkly support.

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/ldclient-rb/config.rb', line 94

def stream?
  @stream
end

#use_ldd? ⇒ Boolean

Whether to use the LaunchDarkly relay proxy in daemon mode. In this mode, the client does not use polling or streaming to get feature flag updates from the server, but instead reads them from the feature store, which is assumed to be a database that is populated by a LaunchDarkly relay proxy. For more information, see "The relay proxy" and "Using a persistent feature store".

All other properties related to streaming or polling are ignored if this option is set to true.

Returns:

  • (Boolean) 


109
110
111
 
# File 'lib/ldclient-rb/config.rb', line 109

def use_ldd?
  @use_ldd
end