Module: Raven
- Defined in:
- lib/raven/okjson.rb,
lib/raven/cli.rb,
lib/raven/base.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/backtrace.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: OkJson, Processor, Rails, Transports Classes: Backtrace, CLI, Client, Configuration, Context, Error, Event, ExceptionInterface, HttpInterface, Interface, LineCache, Logger, MessageInterface, Rack, Railtie, Sidekiq, StacktraceInterface
Constant Summary collapse
- VERSION =
"0.9.0"
- 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
-
.annotate_exception(exc, options = {}) ⇒ Object
(also: annotateException, annotate)
Provides extra context to the exception prior to it being handled by Raven.
-
.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) {|configuration| ... } ⇒ Object
Call this method to modify defaults in your initializers.
- .context ⇒ Object
-
.extra_context(options = {}) ⇒ Object
Bind extra context.
- .find_interface(name) ⇒ Object
-
.inject ⇒ Object
Injects rails.
- .logger ⇒ Object
- .rack_context(env) ⇒ 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.
- .send_or_skip ⇒ Object
-
.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.
41 42 43 |
# File 'lib/raven/base.rb', line 41 def client @client ||= Client.new(configuration) end |
.configuration ⇒ Object
The configuration object.
36 37 38 |
# File 'lib/raven/base.rb', line 36 def configuration @configuration ||= Configuration.new end |
Class Method Details
.annotate_exception(exc, options = {}) ⇒ Object Also known as: annotateException, annotate
Provides extra context to the exception prior to it being handled by Raven. An exception can have multiple annotations, which are merged together.
The options (annotation) is treated the same as the “options“ parameter to “capture_exception“ or “Event.from_exception“, and can contain the same “:user“, “:tags“, etc. options as these methods.
These will be merged with the “options“ parameter to “Event.from_exception“ at the top of execution.
154 155 156 157 158 159 |
# File 'lib/raven/base.rb', line 154 def annotate_exception(exc, = {}) notes = exc.instance_variable_get(:@__raven_context) || {} notes.merge!() exc.instance_variable_set(:@__raven_context, notes) exc end |
.capture(options = {}, &block) ⇒ Object
Capture and process any exceptions from the given block, or globally if no block is given
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/raven/base.rb', line 80 def capture( = {}, &block) if block begin block.call rescue Error raise # Don't capture Raven errors rescue Exception => e capture_exception(e, ) raise end else # Install at_exit hook at_exit do if $ERROR_INFO logger.debug "Caught a post-mortem exception: #{$ERROR_INFO.inspect}" capture_exception($ERROR_INFO, ) end end end end |
.capture_exception(exception, options = {}) ⇒ Object Also known as: captureException
101 102 103 104 105 106 107 108 109 110 111 112 |
# File 'lib/raven/base.rb', line 101 def capture_exception(exception, = {}) send_or_skip do if evt = Event.from_exception(exception, ) yield evt if block_given? if configuration.async? configuration.async.call(evt) else send(evt) end end end end |
.capture_message(message, options = {}) ⇒ Object Also known as: captureMessage
114 115 116 117 118 119 120 121 122 123 124 125 |
# File 'lib/raven/base.rb', line 114 def (, = {}) send_or_skip do if evt = Event.(, ) yield evt if block_given? if configuration.async? configuration.async.call(evt) else send(evt) end end end end |
.configure(silent = false) {|configuration| ... } ⇒ Object
Call this method to modify defaults in your initializers.
56 57 58 59 60 61 62 |
# File 'lib/raven/base.rb', line 56 def configure(silent = false) yield(configuration) if block_given? 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.
189 190 191 |
# File 'lib/raven/base.rb', line 189 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 |
.inject ⇒ Object
Injects rails
201 202 203 204 205 |
# File 'lib/raven/base.rb', line 201 def inject require 'raven/railtie' if defined?(Rails::Railtie) require 'raven/sidekiq' if defined?(Sidekiq) require 'raven/tasks' if defined?(Rake) end |
.logger ⇒ Object
30 31 32 |
# File 'lib/raven/base.rb', line 30 def logger @logger ||= Logger.new end |
.rack_context(env) ⇒ Object
193 194 195 196 197 198 |
# File 'lib/raven/base.rb', line 193 def rack_context(env) if env.empty? env = nil end self.context.rack_env = env 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
46 47 48 |
# File 'lib/raven/base.rb', line 46 def report_ready self.logger.info "Raven #{VERSION} ready to catch errors" end |
.send(evt) ⇒ Object
Send an event to the configured Sentry server
69 70 71 |
# File 'lib/raven/base.rb', line 69 def send(evt) client.send(evt) end |
.send_or_skip ⇒ Object
127 128 129 130 131 132 133 |
# File 'lib/raven/base.rb', line 127 def send_or_skip if configuration.send_in_current_environment? yield if block_given? else configuration. end 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.
179 180 181 |
# File 'lib/raven/base.rb', line 179 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.
168 169 170 |
# File 'lib/raven/base.rb', line 168 def user_context( = {}) self.context.user = end |