Module: Raven
- Defined in:
- lib/raven/backtrace.rb,
lib/raven.rb,
lib/raven/rack.rb,
lib/raven/error.rb,
lib/raven/event.rb,
lib/raven/client.rb,
lib/raven/logger.rb,
lib/raven/context.rb,
lib/raven/railtie.rb,
lib/raven/sidekiq.rb,
lib/raven/version.rb,
lib/raven/linecache.rb,
lib/raven/processor.rb,
lib/raven/interfaces.rb,
lib/raven/transports.rb,
lib/raven/configuration.rb,
lib/raven/transports/udp.rb,
lib/raven/interfaces/http.rb,
lib/raven/transports/http.rb,
lib/raven/interfaces/message.rb,
lib/raven/interfaces/exception.rb,
lib/raven/interfaces/stack_trace.rb,
lib/raven/processors/sanitizedata.rb,
lib/raven/rails/controller_methods.rb,
lib/raven/rails/middleware/debug_exceptions_catcher.rb
Overview
A much simpler source line cacher because linecache sucks at platform compat
Defined Under Namespace
Modules: Processor, Rails, Transports Classes: Backtrace, Client, Configuration, Context, Error, Event, ExceptionInterface, HttpInterface, Interface, LineCache, Logger, MessageInterface, Rack, Railtie, Sidekiq, StacktraceInterface
Constant Summary collapse
- VERSION =
"0.4.6"
- INTERFACES =
{}
Class Attribute Summary collapse
-
.client ⇒ Object
The client object is responsible for delivering formatted data to the Sentry server.
-
.configuration ⇒ Object
The configuration object.
Class Method Summary collapse
-
.capture(options = {}, &block) ⇒ Object
Capture and process any exceptions from the given block, or globally if no block is given.
- .capture_exception(exception, options = {}) ⇒ Object (also: captureException)
- .capture_message(message, options = {}) ⇒ Object (also: captureMessage)
-
.configure(silent = false) ⇒ Object
Call this method to modify defaults in your initializers.
- .context ⇒ Object
-
.extra_context(options = {}) ⇒ Object
Bind extra context.
- .find_interface(name) ⇒ Object
- .logger ⇒ Object
- .register_interface(mapping) ⇒ Object
-
.report_ready ⇒ Object
Tell the log that the client is good to go.
-
.send(evt) ⇒ Object
Send an event to the configured Sentry server.
-
.tags_context(options = {}) ⇒ Object
Bind tags context.
-
.user_context(options = {}) ⇒ Object
Bind user context.
Class Attribute Details
.client ⇒ Object
The client object is responsible for delivering formatted data to the Sentry server.
44 45 46 |
# File 'lib/raven.rb', line 44 def client @client ||= Client.new(configuration) end |
.configuration ⇒ Object
The configuration object.
39 40 41 |
# File 'lib/raven.rb', line 39 def configuration @configuration ||= Configuration.new end |
Class Method Details
.capture(options = {}, &block) ⇒ Object
Capture and process any exceptions from the given block, or globally if no block is given
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 |
# File 'lib/raven.rb', line 85 def capture(={}, &block) if block begin block.call rescue Error => e raise # Don't capture Raven errors rescue Exception => e capture_exception(e, ) raise end else # Install at_exit hook at_exit do if $! logger.debug "Caught a post-mortem exception: #{$!.inspect}" capture_exception($!, ) end end end end |
.capture_exception(exception, options = {}) ⇒ Object Also known as: captureException
106 107 108 109 110 111 |
# File 'lib/raven.rb', line 106 def capture_exception(exception, ={}) if evt = Event.capture_exception(exception, ) yield evt if block_given? send(evt) end end |
.capture_message(message, options = {}) ⇒ Object Also known as: captureMessage
113 114 115 116 117 118 |
# File 'lib/raven.rb', line 113 def (, ={}) if evt = Event.(, ) yield evt if block_given? send(evt) end end |
.configure(silent = false) ⇒ Object
Call this method to modify defaults in your initializers.
59 60 61 62 63 64 65 66 67 |
# File 'lib/raven.rb', line 59 def configure(silent = false) if block_given? yield(configuration) end self.client = Client.new(configuration) report_ready unless silent self.client end |
.extra_context(options = {}) ⇒ Object
Bind extra context. Merges with existing context (if any).
Extra context shows up as Additional Data within Sentry, and is completely arbitrary.
148 149 150 |
# File 'lib/raven.rb', line 148 def extra_context(={}) self.context.extra.merge!() end |
.find_interface(name) ⇒ Object
33 34 35 |
# File 'lib/raven/interfaces.rb', line 33 def self.find_interface(name) INTERFACES[name.to_s] end |
.logger ⇒ Object
33 34 35 |
# File 'lib/raven.rb', line 33 def logger @logger ||= Logger.new end |
.register_interface(mapping) ⇒ Object
26 27 28 29 30 31 |
# File 'lib/raven/interfaces.rb', line 26 def self.register_interface(mapping) mapping.each_pair do |key, klass| INTERFACES[key.to_s] = klass INTERFACES[klass.name] = klass end end |
.report_ready ⇒ Object
Tell the log that the client is good to go
49 50 51 |
# File 'lib/raven.rb', line 49 def report_ready self.logger.info "Raven #{VERSION} ready to catch errors" end |
.send(evt) ⇒ Object
Send an event to the configured Sentry server
74 75 76 |
# File 'lib/raven.rb', line 74 def send(evt) client.send(evt) end |
.tags_context(options = {}) ⇒ Object
Bind tags context. Merges with existing context (if any).
Tags are key / value pairs which generally represent things like application version, environment, role, and server names.
138 139 140 |
# File 'lib/raven.rb', line 138 def (={}) self.context..merge!() end |
.user_context(options = {}) ⇒ Object
Bind user context. Merges with existing context (if any).
It is recommending that you send at least the “id“ and “email“ values. All other values are arbitrary.
127 128 129 |
# File 'lib/raven.rb', line 127 def user_context(={}) self.context.user.merge!() end |