Class: Honeybadger::Config Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Logging::Helper
Defined in:
lib/honeybadger/config.rb,
lib/honeybadger/config/env.rb,
lib/honeybadger/config/ruby.rb,
lib/honeybadger/config/yaml.rb,
lib/honeybadger/config/defaults.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

The Config class is used to manage Honeybadger’s initialization and configuration.

Defined Under Namespace

Modules: Env, Yaml Classes: Boolean, ConfigError, Mash, Ruby

Constant Summary collapse

KEY_REPLACEMENT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Regexp.new('[^a-z\d_]', Regexp::IGNORECASE).freeze
DOTTED_KEY =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Regexp.new('\A([^\.]+)\.(.+)\z').freeze
NOT_BLANK =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Regexp.new('\S').freeze
IVARS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

[:@ruby, :@env, :@yaml, :@framework].freeze
IGNORE_DEFAULT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

['ActionController::RoutingError',
'AbstractController::ActionNotFound',
'ActionController::MethodNotAllowed',
'ActionController::UnknownHttpMethod',
'ActionController::NotImplemented',
'ActionController::UnknownFormat',
'ActionController::InvalidAuthenticityToken',
'ActionController::InvalidCrossOriginRequest',
# ActionDispatch::ParamsParser::ParseError was removed in Rails 6.0
# and may be removed here once support for Rails 5.2 is dropped.
# https://github.com/rails/rails/commit/e16c765ac6dcff068ff2e5554d69ff345c003de1
# https://github.com/honeybadger-io/honeybadger-ruby/pull/358
'ActionDispatch::ParamsParser::ParseError',
'ActionDispatch::Http::Parameters::ParseError',
'ActionController::BadRequest',
'ActionController::ParameterMissing',
'ActiveRecord::RecordNotFound',
'ActionController::UnknownAction',
'ActionDispatch::Http::MimeNegotiation::InvalidType',
'Rack::QueryParser::ParameterTypeError',
'Rack::QueryParser::InvalidParameterError',
'CGI::Session::CookieStore::TamperedWithCookie',
'Mongoid::Errors::DocumentNotFound',
'Sinatra::NotFound',
'Sidekiq::JobRetry::Skip'].map(&:freeze).freeze
DEVELOPMENT_ENVIRONMENTS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

['development', 'test', 'cucumber'].map(&:freeze).freeze
DEFAULT_PATHS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

['honeybadger.yml', 'config/honeybadger.yml', "#{ENV['HOME']}/honeybadger.yml"].map(&:freeze).freeze
OPTIONS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

{
  api_key: {
    description: 'The API key for your Honeybadger project.',
    default: nil,
    type: String
  },
  env: {
    description: 'The current application\'s environment name.',
    default: nil,
    type: String
  },
  report_data: {
    description: 'Enable/disable reporting of data. Defaults to true for non-development environments.',
    default: nil,
    type: Boolean
  },
  root: {
    description: 'The project\'s absolute root path.',
    default: Dir.pwd,
    type: String
  },
  revision: {
    description: 'The git revision of the project.',
    default: nil,
    type: String
  },
  hostname: {
    description: 'The hostname of the current box.',
    default: Socket.gethostname,
    type: String
  },
  backend: {
    description: 'An alternate backend to use for reporting data.',
    default: nil,
    type: String
  },
  debug: {
    description: 'Enables debug logging.',
    default: false,
    type: Boolean
  },
  development_environments: {
    description: 'Environments which will not report data by default (use report_data to enable/disable explicitly).',
    default: DEVELOPMENT_ENVIRONMENTS,
    type: Array
  },
  :'send_data_at_exit' => {
    description: 'Send remaining data when Ruby exits.',
    default: true,
    type: Boolean
  },
  max_queue_size: {
    description: 'Maximum number of items for each worker queue.',
    default: 100,
    type: Integer
  },
  :'events.batch_size' => {
    description: 'Send events batch if n events have accumulated',
    default: 100,
    type: Integer
  },
  :'events.timeout' => {
    description: 'Timeout after which the events batch will be sent regardless (in milliseconds)',
    default: 30_000,
    type: Integer
  },
  plugins: {
    description: 'An optional list of plugins to load. Default is to load all plugins.',
    default: nil,
    type: Array
  },
  sync: {
    description: 'Enable all notices to be sent synchronously. Default is false.',
    default: false,
    type: Boolean
  },
  :'skipped_plugins' => {
    description: 'An optional list of plugins to skip.',
    default: nil,
    type: Array
  },
  :'config.path' => {
    description: 'The path (absolute, or relative from config.root) to the project\'s YAML configuration file.',
    default: DEFAULT_PATHS,
    type: String
  },
  :'logging.path' => {
    description: 'The path (absolute, or relative from config.root) to the log file.',
    default: nil,
    type: String
  },
  :'logging.level' => {
    description: 'The log level.',
    default: 'INFO',
    type: String
  },
  :'logging.debug' => {
    description: 'Override debug logging.',
    default: nil,
    type: Boolean
  },
  :'logging.tty_level' => {
    description: 'Level to log when attached to a terminal (anything < logging.level will always be ignored).',
    default: 'DEBUG',
    type: String
  },
  :'connection.secure' => {
    description: 'Use SSL when sending data.',
    default: true,
    type: Boolean
  },
  :'connection.host' => {
    description: 'The host to use when sending data.',
    default: 'api.honeybadger.io'.freeze,
    type: String
  },
  :'connection.port' => {
    description: 'The port to use when sending data.',
    default: nil,
    type: Integer
  },
  :'connection.system_ssl_cert_chain' => {
    description: 'Use the system\'s SSL certificate chain (if available).',
    default: false,
    type: Boolean
  },
  :'connection.ssl_ca_bundle_path' => {
    description: 'Use this ca bundle when establishing secure connections.',
    default: nil,
    type: String
  },
  :'connection.http_open_timeout' => {
    description: 'The HTTP open timeout when connecting to the server.',
    default: 2,
    type: Integer
  },
  :'connection.http_read_timeout' => {
    description: 'The HTTP read timeout when connecting to the server.',
    default: 5,
    type: Integer
  },
  :'connection.proxy_host' => {
    description: 'The proxy host to use when sending data.',
    default: nil,
    type: String
  },
  :'connection.proxy_port' => {
    description: 'The proxy port to use when sending data.',
    default: nil,
    type: Integer
  },
  :'connection.proxy_user' => {
    description: 'The proxy user to use when sending data.',
    default: nil,
    type: String
  },
  :'connection.proxy_pass' => {
    description: 'The proxy password to use when sending data.',
    default: nil,
    type: String
  },
  :'request.filter_keys' => {
    description: 'A list of keys to filter when sending request data.',
    default: ['password'.freeze, 'password_confirmation'.freeze, 'HTTP_AUTHORIZATION'.freeze].freeze,
    type: Array
  },
  :'request.disable_session' => {
    description: 'Prevent session from being sent with request data.',
    default: false,
    type: Boolean
  },
  :'request.disable_params' => {
    description: 'Prevent params from being sent with request data.',
    default: false,
    type: Boolean
  },
  :'request.disable_environment' => {
    description: 'Prevent Rack environment from being sent with request data.',
    default: false,
    type: Boolean
  },
  :'request.disable_url' => {
    description: 'Prevent url from being sent with request data (Rack environment may still contain it in some cases).',
    default: false,
    type: Boolean
  },
  :'user_informer.enabled' => {
    description: 'Enable the UserInformer middleware.',
    default: true,
    type: Boolean
  },
  :'user_informer.info' => {
    description: 'Replacement string for HTML comment in templates.',
    default: 'Honeybadger Error {{error_id}}'.freeze,
    type: String
  },
  :'feedback.enabled' => {
    description: 'Enable the UserFeedback middleware.',
    default: true,
    type: Boolean
  },
  :'exceptions.enabled' => {
    description: 'Enable automatic reporting of exceptions.',
    default: true,
    type: Boolean
  },
  :'exceptions.ignore' => {
    description: 'A list of additional exceptions to ignore (includes default ignored exceptions).',
    default: IGNORE_DEFAULT,
    type: Array
  },
  :'exceptions.ignore_only' => {
    description: 'A list of exceptions to ignore (overrides the default ignored exceptions).',
    default: nil,
    type: Array
  },
  :'exceptions.ignored_user_agents' => {
    description: 'A list of user agents to ignore.',
    default: [].freeze,
    type: Array
  },
  :'exceptions.rescue_rake' => {
    description: 'Enable reporting exceptions in rake tasks.',
    default: !STDOUT.tty?,
    type: Boolean
  },
  :'exceptions.notify_at_exit' => {
    description: 'Report unhandled exception when Ruby crashes (at_exit).',
    default: true,
    type: Boolean
  },
  :'exceptions.source_radius' => {
    description: 'The number of lines before and after the source when reporting snippets.',
    default: 2,
    type: Integer
  },
  :'exceptions.local_variables' => {
    description: 'Enable sending local variables. Requires binding_of_caller to be loaded.',
    default: false,
    type: Boolean
  },
  :'exceptions.unwrap' => {
    description: 'Reports #original_exception or #cause one level up from rescued exception when available.',
    default: false,
    type: Boolean
  },
  :'active_job.attempt_threshold' => {
    description: 'The number of attempts before notifications will be sent.',
    default: 0,
    type: Integer
  },
  :'delayed_job.attempt_threshold' => {
    description: 'The number of attempts before notifications will be sent.',
    default: 0,
    type: Integer
  },
  :'sidekiq.attempt_threshold' => {
    description: 'The number of attempts before notifications will be sent.',
    default: 0,
    type: Integer
  },
  :'shoryuken.attempt_threshold' => {
    description: 'The number of attempts before notifications will be sent.',
    default: 0,
    type: Integer
  },
  :'faktory.attempt_threshold' => {
    description: 'The number of attempts before notifications will be sent.',
    default: 0,
    type: Integer
  },
  :'sidekiq.use_component' => {
    description: 'Automatically set the component to the class of the job. Helps with grouping.',
    default: true,
    type: Boolean
  },
  :'sinatra.enabled' => {
    description: 'Enable Sinatra auto-initialization.',
    default: true,
    type: Boolean
  },
  :'rails.subscriber_ignore_sources' => {
    description: "Sources (strings or regexes) that should be ignored when using the Rails' (7+) native error reporter (handled exceptions only).",
    # External libraries (eg Sidekiq, Resque) may wrap their execution in Rails' executor.
    # But this means errors will first be reported by Rails.error, before the library's native error handler
    # We ignore these reports, since the native error handler provides more context (such as job details)
    default: ['application.active_support'],
    type: Array
  },
  :'resque.resque_retry.send_exceptions_when_retrying' => {
    description: 'Send exceptions when retrying job.',
    default: true,
    type: Boolean
  },
  :'breadcrumbs.enabled' => {
    description: 'Disable breadcrumb functionality.',
    default: true,
    type: Boolean
  },
  :'breadcrumbs.active_support_notifications' => {
    description: 'Configuration for automatic Active Support Instrumentation events.',
    default: Breadcrumbs::ActiveSupport.default_notifications,
    type: Hash
  },
  :'breadcrumbs.logging.enabled' => {
    description: 'Enable/Disable automatic breadcrumbs from log messages.',
    default: true,
    type: Boolean
  }
}.freeze
DEFAULTS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Hash[OPTIONS.map{|k,v| [k, v[:default]] }].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opts = {}) ⇒ Config

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Config.



40
41
42
43
44
45
# File 'lib/honeybadger/config.rb', line 40

def initialize(opts = {})
  @ruby = opts.freeze
  @env = {}.freeze
  @yaml = {}.freeze
  @framework = {}.freeze
end

Instance Attribute Details

#envObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



47
48
49
# File 'lib/honeybadger/config.rb', line 47

def env
  @env
end

#frameworkObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



47
48
49
# File 'lib/honeybadger/config.rb', line 47

def framework
  @framework
end

#rubyObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



47
48
49
# File 'lib/honeybadger/config.rb', line 47

def ruby
  @ruby
end

#yamlObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



47
48
49
# File 'lib/honeybadger/config.rb', line 47

def yaml
  @yaml
end

Instance Method Details

#backendObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



150
151
152
153
# File 'lib/honeybadger/config.rb', line 150

def backend
  init_backend! unless @backend
  @backend
end

#backend=(backend) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



155
156
157
158
# File 'lib/honeybadger/config.rb', line 155

def backend=(backend)
  set(:backend, backend)
  @backend = nil
end

#backtrace_filter(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



82
83
84
85
86
87
88
89
# File 'lib/honeybadger/config.rb', line 82

def backtrace_filter(&block)
  if block_given?
    warn('DEPRECATED: backtrace_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#backtrace_filter')
    self[:backtrace_filter] = block
  end

  self[:backtrace_filter]
end

#before_notify_hooksObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



91
92
93
# File 'lib/honeybadger/config.rb', line 91

def before_notify_hooks
  (ruby[:before_notify] || []).clone
end

#ca_bundle_pathObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



191
192
193
194
195
196
197
198
199
# File 'lib/honeybadger/config.rb', line 191

def ca_bundle_path
  if self[:'connection.system_ssl_cert_chain'] && File.exist?(OpenSSL::X509::DEFAULT_CERT_FILE)
    OpenSSL::X509::DEFAULT_CERT_FILE
  elsif self[:'connection.ssl_ca_bundle_path']
    self[:'connection.ssl_ca_bundle_path']
  else
    local_cert_path
  end
end

#configure {|new_ruby| ... } ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Yields:

  • (new_ruby)


74
75
76
77
78
79
80
# File 'lib/honeybadger/config.rb', line 74

def configure
  new_ruby = Ruby.new(self)
  yield(new_ruby)
  self.ruby = ruby.merge(new_ruby).freeze
  @logger = @backend = nil
  self
end

#connection_portObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



205
206
207
208
209
210
211
212
213
# File 'lib/honeybadger/config.rb', line 205

def connection_port
  if self[:'connection.port']
    self[:'connection.port']
  elsif self[:'connection.secure']
    443
  else
    80
  end
end

#connection_protocolObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



215
216
217
218
219
220
221
# File 'lib/honeybadger/config.rb', line 215

def connection_protocol
  if self[:'connection.secure']
    'https'
  else
    'http'
  end
end

#debug?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



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

def debug?
  !!self[:debug]
end

#detected_frameworkObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
# File 'lib/honeybadger/config.rb', line 275

def detected_framework
  if self[:framework] =~ NOT_BLANK
    self[:framework].to_sym
  elsif defined?(::Rails::VERSION) && ::Rails::VERSION::STRING > '3.0'
    :rails
  elsif defined?(::Sinatra::VERSION)
    :sinatra
  elsif defined?(::Hanami::VERSION) && ::Hanami::VERSION >= '2.0'
    :hanami
  elsif defined?(::Rack.release)
    :rack
  else
    :ruby
  end
end

#dev?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



160
161
162
# File 'lib/honeybadger/config.rb', line 160

def dev?
  self[:env] && Array(self[:development_environments]).include?(self[:env])
end

#events_batch_sizeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



227
228
229
# File 'lib/honeybadger/config.rb', line 227

def events_batch_size
  self[:'events.batch_size']
end

#events_timeoutObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



231
232
233
# File 'lib/honeybadger/config.rb', line 231

def events_timeout
  self[:'events.timeout']
end

#exception_filter(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



95
96
97
98
99
100
101
102
# File 'lib/honeybadger/config.rb', line 95

def exception_filter(&block)
  if block_given?
    warn('DEPRECATED: exception_filter is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_filter')
    self[:exception_filter] = block
  end

  self[:exception_filter]
end

#exception_fingerprint(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



104
105
106
107
108
109
110
111
# File 'lib/honeybadger/config.rb', line 104

def exception_fingerprint(&block)
  if block_given?
    warn('DEPRECATED: exception_fingerprint is deprecated. Please use before_notify instead. See https://docs.honeybadger.io/ruby/support/v4-upgrade#exception_fingerprint')
    self[:exception_fingerprint] = block
  end

  self[:exception_fingerprint]
end

#excluded_request_keysObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



239
240
241
242
243
244
245
246
# File 'lib/honeybadger/config.rb', line 239

def excluded_request_keys
  [].tap do |keys|
    keys << :session  if self[:'request.disable_session']
    keys << :params   if self[:'request.disable_params']
    keys << :cgi_data if self[:'request.disable_environment']
    keys << :url      if self[:'request.disable_url']
  end
end

#framework_nameObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



291
292
293
294
295
296
297
298
299
300
# File 'lib/honeybadger/config.rb', line 291

def framework_name
  case detected_framework
  when :rails then "Rails #{::Rails::VERSION::STRING}"
  when :sinatra then "Sinatra #{::Sinatra::VERSION}"
  when :hanami then "Hanami #{::Hanami::VERSION}"
  when :rack then "Rack #{::Rack.release}"
  else
    "Ruby #{RUBY_VERSION}"
  end
end

#get(key) ⇒ Object Also known as: []

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



113
114
115
116
117
118
119
120
121
122
# File 'lib/honeybadger/config.rb', line 113

def get(key)
  IVARS.each do |var|
    source = instance_variable_get(var)
    if source.has_key?(key)
      return source[key]
    end
  end

  DEFAULTS[key]
end

#ignored_classesObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



183
184
185
186
187
188
189
# File 'lib/honeybadger/config.rb', line 183

def ignored_classes
  ignore_only = get(:'exceptions.ignore_only')
  return ignore_only if ignore_only
  return DEFAULTS[:'exceptions.ignore'] unless ignore = get(:'exceptions.ignore')

  DEFAULTS[:'exceptions.ignore'] | Array(ignore)
end

#init!(opts = {}, env = ENV) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Called by framework (see lib/honeybadger/init/) at the point of initialization. This is not required for the notifier to work (i.e. with ‘require ’honeybadger/ruby’‘).



52
53
54
55
56
57
58
59
60
61
62
# File 'lib/honeybadger/config.rb', line 52

def init!(opts = {}, env = ENV)
  load!(framework: opts, env: env)

  init_logging!
  init_backend!

  logger.debug(sprintf('Initializing Honeybadger Error Tracker for Ruby. Ship it! version=%s framework=%s', Honeybadger::VERSION, detected_framework))
  logger.warn('Development mode is enabled. Data will not be reported until you deploy your app.') if warn_development?

  self
end

#load!(framework: {}, env: ENV) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



64
65
66
67
68
69
70
71
72
# File 'lib/honeybadger/config.rb', line 64

def load!(framework: {}, env: ENV)
  return self if @loaded
  self.framework = framework.freeze
  self.env = Env.new(env).freeze
  load_config_from_disk {|yaml| self.yaml = yaml.freeze }
  detect_revision!
  @loaded = true
  self
end

#load_plugin?(name) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



259
260
261
262
263
# File 'lib/honeybadger/config.rb', line 259

def load_plugin?(name)
  return false if includes_token?(self[:'skipped_plugins'], name)
  return true unless self[:plugins].kind_of?(Array)
  includes_token?(self[:plugins], name)
end

#local_cert_pathObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



201
202
203
# File 'lib/honeybadger/config.rb', line 201

def local_cert_path
  File.expand_path(File.join('..', '..', '..', 'resources', 'ca-bundle.crt'), __FILE__)
end

#log_debug?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



178
179
180
181
# File 'lib/honeybadger/config.rb', line 178

def log_debug?
  return debug? if self[:'logging.debug'].nil?
  !!self[:'logging.debug']
end

#log_level(key = :'logging.level') ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



248
249
250
251
252
253
254
255
256
257
# File 'lib/honeybadger/config.rb', line 248

def log_level(key = :'logging.level')
  case self[key].to_s
  when /\A(0|debug)\z/i then Logger::DEBUG
  when /\A(1|info)\z/i  then Logger::INFO
  when /\A(2|warn)\z/i  then Logger::WARN
  when /\A(3|error)\z/i then Logger::ERROR
  else
    Logger::INFO
  end
end

#loggerObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



145
146
147
148
# File 'lib/honeybadger/config.rb', line 145

def logger
  init_logging! unless @logger
  @logger
end

#max_queue_sizeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



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

def max_queue_size
  self[:max_queue_size]
end

#params_filtersObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



235
236
237
# File 'lib/honeybadger/config.rb', line 235

def params_filters
  Array(self[:'request.filter_keys'])
end

#public?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



168
169
170
171
172
# File 'lib/honeybadger/config.rb', line 168

def public?
  return true if self[:report_data]
  return false if self[:report_data] == false
  !self[:env] || !dev?
end

#root_regexpObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



265
266
267
268
269
270
271
272
273
# File 'lib/honeybadger/config.rb', line 265

def root_regexp
  return @root_regexp if @root_regexp
  return nil if @no_root

  root = get(:root).to_s
  @no_root = true and return nil unless root =~ NOT_BLANK

  @root_regexp = Regexp.new("^#{ Regexp.escape(root) }")
end

#set(key, value) ⇒ Object Also known as: []=

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



125
126
127
128
# File 'lib/honeybadger/config.rb', line 125

def set(key, value)
  self.ruby = ruby.merge(key => value).freeze
  @logger = @backend = nil
end

#to_hash(defaults = false) ⇒ Object Also known as: to_h

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



131
132
133
134
135
136
137
138
139
# File 'lib/honeybadger/config.rb', line 131

def to_hash(defaults = false)
  hash = [:@ruby, :@env, :@yaml, :@framework].reverse.reduce({}) do |a,e|
    a.merge!(instance_variable_get(e))
  end

  hash = DEFAULTS.merge(hash) if defaults

  undotify_keys(hash.select {|k,v| DEFAULTS.has_key?(k) })
end

#warn_development?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:



164
165
166
# File 'lib/honeybadger/config.rb', line 164

def warn_development?
  dev? && backend.kind_of?(Backend::Null)
end