Module: Raygun
- Extended by:
- Testable
- Defined in:
- lib/raygun/sidekiq.rb,
lib/raygun.rb,
lib/raygun/error.rb,
lib/raygun/client.rb,
lib/raygun/version.rb,
lib/raygun/testable.rb,
lib/raygun/breadcrumbs.rb,
lib/raygun/affected_user.rb,
lib/raygun/configuration.rb,
lib/raygun/breadcrumbs/store.rb,
lib/raygun/breadcrumbs/breadcrumb.rb,
lib/generators/raygun/install_generator.rb,
lib/raygun/middleware/rack_exception_interceptor.rb,
lib/raygun/middleware/rails_insert_affected_user.rb,
lib/raygun/middleware/breadcrumbs_store_initializer.rb,
lib/raygun/services/apply_whitelist_filter_to_payload.rb
Overview
Defined Under Namespace
Modules: Breadcrumbs, Middleware, Services, Testable
Classes: AffectedUser, Client, Configuration, Error, InstallGenerator, ItWorksException, Railtie, SidekiqMiddleware, SidekiqReporter
Constant Summary
collapse
- CLIENT_URL =
used to identify ourselves to Raygun
"https://github.com/MindscapeHQ/raygun4ruby"
- CLIENT_NAME =
"Raygun4Ruby Gem"
- VERSION =
"3.0.0"
Class Attribute Summary collapse
Class Method Summary
collapse
-
.configured? ⇒ Boolean
-
.default_configuration ⇒ Object
-
.deprecation_warning(message) ⇒ Object
-
.failsafe_log(message) ⇒ Object
-
.log(message) ⇒ Object
-
.record_breadcrumb(message: nil, category: '', level: :info, timestamp: Time.now.utc, metadata: {}, class_name: nil, method_name: nil, line_number: nil) ⇒ Object
-
.reset_configuration ⇒ Object
-
.setup {|configuration| ... } ⇒ Object
-
.track_exception(exception_instance, env = {}, user = nil, retry_count = 1) ⇒ Object
-
.track_exceptions ⇒ Object
Methods included from Testable
track_test_exception
Class Attribute Details
.configuration ⇒ Object
46
47
48
|
# File 'lib/raygun.rb', line 46
def configuration
@configuration ||= Configuration.new
end
|
Class Method Details
58
59
60
|
# File 'lib/raygun.rb', line 58
def configured?
!!configuration.api_key
end
|
.default_configuration ⇒ Object
50
51
52
|
# File 'lib/raygun.rb', line 50
def default_configuration
configuration.defaults
end
|
.deprecation_warning(message) ⇒ Object
112
113
114
115
116
117
118
|
# File 'lib/raygun.rb', line 112
def deprecation_warning(message)
if defined?(ActiveSupport::Deprecation)
ActiveSupport::Deprecation.warn(message)
else
puts message
end
end
|
.failsafe_log(message) ⇒ Object
108
109
110
|
# File 'lib/raygun.rb', line 108
def failsafe_log(message)
configuration.failsafe_logger.info(message)
end
|
.log(message) ⇒ Object
102
103
104
105
106
|
# File 'lib/raygun.rb', line 102
def log(message)
return unless configuration.debug
configuration.logger.info("[Raygun] #{message}") if configuration.logger
end
|
.record_breadcrumb(message: nil, category: '', level: :info, timestamp: Time.now.utc, metadata: {}, class_name: nil, method_name: nil, line_number: nil) ⇒ Object
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
|
# File 'lib/raygun.rb', line 78
def record_breadcrumb(
message: nil,
category: '',
level: :info,
timestamp: Time.now.utc,
metadata: {},
class_name: nil,
method_name: nil,
line_number: nil
)
log('recording breadcrumb')
Raygun::Breadcrumbs::Store.record(
message: message,
category: category,
level: level,
timestamp: timestamp,
metadata: metadata,
class_name: class_name,
method_name: method_name,
line_number: line_number,
)
end
|
.reset_configuration ⇒ Object
54
55
56
|
# File 'lib/raygun.rb', line 54
def reset_configuration
@configuration = Configuration.new
end
|
.setup {|configuration| ... } ⇒ Object
40
41
42
43
44
|
# File 'lib/raygun.rb', line 40
def setup
yield(configuration)
log("configuration settings: #{configuration.inspect}")
end
|
.track_exception(exception_instance, env = {}, user = nil, retry_count = 1) ⇒ Object
62
63
64
65
66
67
68
69
70
|
# File 'lib/raygun.rb', line 62
def track_exception(exception_instance, env = {}, user = nil, retry_count = 1)
log('tracking exception')
if configuration.send_in_background
track_exception_async(exception_instance, env, user, retry_count)
else
track_exception_sync(exception_instance, env, user, retry_count)
end
end
|
.track_exceptions ⇒ Object
72
73
74
75
76
|
# File 'lib/raygun.rb', line 72
def track_exceptions
yield
rescue => e
track_exception(e)
end
|