Class HoptoadNotifier::Configuration
In: lib/hoptoad_notifier/configuration.rb
Parent: Object

Used to set up and modify settings for the notifier.

Constants

OPTIONS = [:api_key, :backtrace_filters, :development_environments, :development_lookup, :environment_name, :host, :http_open_timeout, :http_read_timeout, :ignore, :ignore_by_filters, :ignore_user_agent, :notifier_name, :notifier_url, :notifier_version, :params_filters, :project_root, :port, :protocol, :proxy_host, :proxy_pass, :proxy_port, :proxy_user, :secure, :framework, :user_information].freeze
DEFAULT_PARAMS_FILTERS = %w(password password_confirmation).freeze
DEFAULT_BACKTRACE_FILTERS = [ lambda { |line| if defined?(HoptoadNotifier.configuration.project_root) && HoptoadNotifier.configuration.project_root.to_s != ''

Attributes

api_key  [RW]  The API key for your project, found on the project edit form.
backtrace_filters  [R]  A list of filters for cleaning and pruning the backtrace. See filter_backtrace.
development_environments  [RW]  A list of environments in which notifications should not be sent.
development_lookup  [RW]  true if you want to check for production errors matching development errors, false otherwise.
environment_name  [RW]  The name of the environment the application is running in
framework  [RW]  The framework HoptoadNotifier is configured to use
host  [RW]  The host to connect to (defaults to hoptoadapp.com).
http_open_timeout  [RW]  The HTTP open timeout in seconds (defaults to 2).
http_read_timeout  [RW]  The HTTP read timeout in seconds (defaults to 5).
ignore  [R]  A list of exception classes to ignore. The array can be appended to.
ignore_by_filters  [R]  A list of filters for ignoring exceptions. See ignore_by_filter.
ignore_user_agent  [R]  A list of user agents that are being ignored. The array can be appended to.
logger  [RW]  The logger used by HoptoadNotifier
notifier_name  [RW]  The name of the notifier library being used to send notifications (such as "Hoptoad Notifier")
notifier_url  [RW]  The url of the notifier library being used to send notifications
notifier_version  [RW]  The version of the notifier library being used to send notifications (such as "1.0.2")
params_filters  [R]  A list of parameters that should be filtered out of what is sent to Hoptoad. By default, all "password" attributes will have their contents replaced.
port  [RW]  The port on which your Hoptoad server runs (defaults to 443 for secure connections, 80 for insecure connections).
project_root  [RW]  The path to the project in which the error occurred, such as the RAILS_ROOT
proxy_host  [RW]  The hostname of your proxy server (if using a proxy)
proxy_pass  [RW]  The password to use when logging into your proxy server (if using a proxy)
proxy_port  [RW]  The port of your proxy server (if using a proxy)
proxy_user  [RW]  The username to use when logging into your proxy server (if using a proxy)
secure  [RW]  true for https connections, false for http connections.
user_information  [RW]  The text that the placeholder is replaced with. {{error_id}} is the actual error number.

[Validate]