Class: Prefab::Options

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

Overview

This class contains all the options that can be passed to the Prefab client.

Defined Under Namespace

Modules: DATASOURCES, ON_INITIALIZATION_FAILURE, ON_NO_DEFAULT

Constant Summary collapse

DEFAULT_LOG_FORMATTER = 
proc { |data|
  severity = data[:severity]
  datetime = data[:datetime]
  progname = data[:progname]
  path = data[:path]
  msg = data[:message]
  log_context = data[:log_context]

  progname = (progname.nil? || progname.empty?) ? path : "#{progname}: #{path}"

  formatted_log_context = log_context.sort.map{|k, v| "#{k}=#{v}" }.join(" ")
  "#{severity.ljust(5)} #{datetime}:#{' ' if progname}#{progname} #{msg}#{log_context.any? ? " " + formatted_log_context : ""}\n"
}
JSON_LOG_FORMATTER = 
proc { |data|
  log_context = data.delete(:log_context)
  data.merge(log_context).compact.to_json << "\n"
}
DEFAULT_MAX_PATHS = 
1_000
DEFAULT_MAX_KEYS = 
100_000
DEFAULT_MAX_EXAMPLE_CONTEXTS = 
100_000
DEFAULT_MAX_EVAL_SUMMARIES = 
100_000

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Options

Returns a new instance of Options.



122
123
124
 
# File 'lib/prefab/options.rb', line 122

def initialize(options = {})
  init(**options)
end

Instance Attribute Details

#api_key ⇒ Object (readonly)

Returns the value of attribute api_key.



6
7
8
 
# File 'lib/prefab/options.rb', line 6

def api_key
  @api_key
end

#collect_sync_interval ⇒ Object (readonly)

Returns the value of attribute collect_sync_interval.



18
19
20
 
# File 'lib/prefab/options.rb', line 18

def collect_sync_interval
  @collect_sync_interval
end

#initialization_timeout_sec ⇒ Object (readonly)

Returns the value of attribute initialization_timeout_sec.



13
14
15
 
# File 'lib/prefab/options.rb', line 13

def initialization_timeout_sec
  @initialization_timeout_sec
end

#log_formatter ⇒ Object (readonly)

Returns the value of attribute log_formatter.



9
10
11
 
# File 'lib/prefab/options.rb', line 9

def log_formatter
  @log_formatter
end

#log_prefix ⇒ Object (readonly)

Returns the value of attribute log_prefix.



8
9
10
 
# File 'lib/prefab/options.rb', line 8

def log_prefix
  @log_prefix
end

#logdev ⇒ Object (readonly)

Returns the value of attribute logdev.



7
8
9
 
# File 'lib/prefab/options.rb', line 7

def logdev
  @logdev
end

#namespace ⇒ Object (readonly)

Returns the value of attribute namespace.



10
11
12
 
# File 'lib/prefab/options.rb', line 10

def namespace
  @namespace
end

#on_init_failure ⇒ Object (readonly)

Returns the value of attribute on_init_failure.



14
15
16
 
# File 'lib/prefab/options.rb', line 14

def on_init_failure
  @on_init_failure
end

#on_no_default ⇒ Object (readonly)

Returns the value of attribute on_no_default.



12
13
14
 
# File 'lib/prefab/options.rb', line 12

def on_no_default
  @on_no_default
end

#prefab_api_url ⇒ Object (readonly)

Returns the value of attribute prefab_api_url.



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

def prefab_api_url
  @prefab_api_url
end

#prefab_config_classpath_dir ⇒ Object (readonly)

Returns the value of attribute prefab_config_classpath_dir.



16
17
18
 
# File 'lib/prefab/options.rb', line 16

def prefab_config_classpath_dir
  @prefab_config_classpath_dir
end

#prefab_config_override_dir ⇒ Object (readonly)

Returns the value of attribute prefab_config_override_dir.



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

def prefab_config_override_dir
  @prefab_config_override_dir
end

#prefab_envs ⇒ Object (readonly)

Returns the value of attribute prefab_envs.



17
18
19
 
# File 'lib/prefab/options.rb', line 17

def prefab_envs
  @prefab_envs
end

Instance Method Details

#collect_max_evaluation_summaries ⇒ Object 



148
149
150
151
152
 
# File 'lib/prefab/options.rb', line 148

def collect_max_evaluation_summaries
  return 0 unless telemetry_allowed?(@collect_evaluation_summaries)

  @collect_max_evaluation_summaries
end

#collect_max_example_contexts ⇒ Object 



142
143
144
145
146
 
# File 'lib/prefab/options.rb', line 142

def collect_max_example_contexts
  return 0 unless telemetry_allowed?(@collect_example_contexts)

  @collect_max_example_contexts
end

#collect_max_paths ⇒ Object 



130
131
132
133
134
 
# File 'lib/prefab/options.rb', line 130

def collect_max_paths
  return 0 unless telemetry_allowed?(@collect_logger_counts)

  @collect_max_paths
end

#collect_max_shapes ⇒ Object 



136
137
138
139
140
 
# File 'lib/prefab/options.rb', line 136

def collect_max_shapes
  return 0 unless telemetry_allowed?(@collect_shapes)

  @collect_max_shapes
end

#local_only? ⇒ Boolean

Returns:

  • (Boolean) 


126
127
128
 
# File 'lib/prefab/options.rb', line 126

def local_only?
  @prefab_datasources == DATASOURCES::LOCAL_ONLY
end

#url_for_api_cdn ⇒ Object

https://api.prefab.cloud -> https://api-prefab-cloud.global.ssl.fastly.net



155
156
157
 
# File 'lib/prefab/options.rb', line 155

def url_for_api_cdn
  ENV['PREFAB_CDN_URL'] || "#{@prefab_api_url.gsub(/\./, '-')}.global.ssl.fastly.net"
end