Module: Errorkit
- Defined in:
- lib/errorkit.rb,
lib/errorkit/config.rb,
lib/errorkit/engine.rb,
lib/errorkit/sidekiq.rb,
lib/errorkit/version.rb,
lib/errorkit/errors_mailer.rb,
lib/errorkit/ignorable_error.rb,
lib/errorkit/errors_controller.rb,
lib/generators/errorkit/install_generator.rb
Defined Under Namespace
Classes: Config, Engine, ErrorsController, ErrorsMailer, IgnorableError, InstallGenerator, Sidekiq
Constant Summary
collapse
- REQUEST_ENV =
HTTP_COOKIE removed from this list to protect the session
%w(SERVER_NAME PATH_INFO REMOTE_HOST HTTP_ACCEPT_ENCODING
HTTP_USER_AGENT SERVER_PROTOCOL HTTP_CACHE_CONTROL HTTP_ACCEPT_LANGUAGE HTTP_HOST
REMOTE_ADDR SERVER_SOFTWARE HTTP_KEEP_ALIVE HTTP_REFERER HTTP_ACCEPT_CHARSET
REQUEST_URI SERVER_PORT GATEWAY_INTERFACE QUERY_STRING REMOTE_USER HTTP_ACCEPT
REQUEST_METHOD HTTP_CONNECTION)
- VERSION =
"0.3.2"
Class Method Summary
collapse
Class Method Details
.application_version ⇒ Object
88
89
90
|
# File 'lib/errorkit.rb', line 88
def self.application_version
@version ||= `cd #{Rails.root.to_s} && git rev-parse HEAD`.chomp rescue nil
end
|
.background_error(worker, payload, queue, exception) ⇒ Object
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# File 'lib/errorkit.rb', line 58
def self.background_error(worker, payload, queue, exception)
unless config.errors_class.nil? || config.ignore_exception?(exception)
begin
error = config.errors_class.create(
server: server,
environment: environment,
version: application_version,
exception: exception.class.to_s,
message: exception.message,
backtrace: clean_backtrace(exception),
worker: worker.class.to_s,
queue: queue.to_s,
payload: payload.to_json
)
send_notification(error)
error
rescue Errorkit::IgnorableError
end
end
end
|
.clean_backtrace(exception) ⇒ Object
133
134
135
136
137
138
|
# File 'lib/errorkit.rb', line 133
def self.clean_backtrace(exception)
backtrace = Rails.backtrace_cleaner.send(:filter, exception.backtrace) if defined?(Rails) && Rails.respond_to?(:backtrace_cleaner)
backtrace ||= exception.backtrace
backtrace ||= []
backtrace.join("\n")
end
|
.config ⇒ Object
25
26
27
|
# File 'lib/errorkit.rb', line 25
def self.config
@config ||= Errorkit::Config.new
end
|
15
16
17
18
19
20
21
22
23
|
# File 'lib/errorkit.rb', line 15
def self.configure(&block)
config.instance_eval(&block)
if defined?(Rails)
Rails.application.config.exceptions_app = lambda do |env|
Errorkit.server_error(env)
end
end
end
|
.environment ⇒ Object
80
81
82
|
# File 'lib/errorkit.rb', line 80
def self.environment
Rails.env.to_s if defined?(Rails)
end
|
.filtered_parameters(request) ⇒ Object
92
93
94
|
# File 'lib/errorkit.rb', line 92
def self.filtered_parameters(request)
request.filtered_parameters
end
|
.filtered_request_env(request) ⇒ Object
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# File 'lib/errorkit.rb', line 104
def self.filtered_request_env(request)
begin
require 'action_dispatch/http/parameter_filter'
rescue LoadError
return {}
end
env = {}
REQUEST_ENV.each do |var|
env[var] = request.env[var]
end
param_filter = request.env.fetch("action_dispatch.parameter_filter")
param_filter = ActionDispatch::Http::ParameterFilter.new(param_filter)
param_filter.filter(env)
end
|
.filtered_session(request) ⇒ Object
119
120
121
122
123
124
125
126
127
128
129
130
131
|
# File 'lib/errorkit.rb', line 119
def self.filtered_session(request)
begin
require 'action_dispatch/http/parameter_filter'
rescue LoadError
return {}
end
session = request.session.dup
session.delete(:session_id)
session.delete(:_csrf_token)
param_filter = request.env.fetch("action_dispatch.parameter_filter")
param_filter = ActionDispatch::Http::ParameterFilter.new(param_filter)
param_filter.filter(session.to_hash)
end
|
.send_notification(error) ⇒ Object
140
141
142
143
144
145
|
# File 'lib/errorkit.rb', line 140
def self.send_notification(error)
return if config.mailer_recipients.blank? || config.mailer_sender.blank?
config.errors_mailer.error_notification(error.id).deliver
end
|
.server ⇒ Object
84
85
86
|
# File 'lib/errorkit.rb', line 84
def self.server
@server ||= `hostname`.chomp rescue nil
end
|
.server_error(env) ⇒ Object
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
|
# File 'lib/errorkit.rb', line 29
def self.server_error(env)
exception = env['action_dispatch.exception']
unless config.errors_class.nil? || config.ignore_exception?(exception) || config.ignore_agent?(env['HTTP_USER_AGENT'])
begin
request = ActionDispatch::Request.new(env)
error = config.errors_class.create(
server: server,
environment: environment,
version: application_version,
exception: exception.class.to_s,
message: exception.message,
backtrace: clean_backtrace(exception),
params: filtered_parameters(request).to_json,
session: filtered_session(request).to_json,
remote_ip: request.remote_ip.to_s,
request_env: filtered_request_env(request).to_json,
controller: (env['action_controller.instance'].controller_name rescue nil),
action: (env['action_controller.instance'].action_name rescue nil),
url: request.original_url)
env['errorkit.notified'] = send_notification(error)
env['errorkit.error'] = error
rescue Errorkit::IgnorableError
end
end
config.errors_controller.action(:show).call(env)
end
|