Module: Raven

Defined in:
lib/raven/okjson.rb,
lib/raven/cli.rb,
lib/raven/base.rb,
lib/raven/error.rb,
lib/raven/event.rb,
lib/raven/client.rb,
lib/raven/logger.rb,
lib/raven/context.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/integrations/rack.rb,
lib/raven/integrations/rails.rb,
lib/raven/interfaces/message.rb,
lib/raven/integrations/sidekiq.rb,
lib/raven/interfaces/exception.rb,
lib/raven/interfaces/stack_trace.rb,
lib/raven/processor/sanitizedata.rb,
lib/raven/processor/utf8conversion.rb,
lib/raven/processor/removestacktrace.rb,
lib/raven/interfaces/single_exception.rb,
lib/raven/integrations/rails/active_job.rb,
lib/raven/processor/removecircularreferences.rb,
lib/raven/integrations/rails/controller_methods.rb,
lib/raven/integrations/rails/middleware/debug_exceptions_catcher.rb

Overview

A much simpler source line cacher because linecache sucks at platform compat

Defined Under Namespace

Modules: OkJson, Transports Classes: Backtrace, CLI, Client, ClientState, Configuration, Context, Error, Event, ExceptionInterface, HttpInterface, Interface, LineCache, Logger, MessageInterface, Processor, Rack, Rails, Sidekiq, SingleExceptionInterface, StacktraceInterface

Constant Summary collapse

AVAILABLE_INTEGRATIONS = 
%w[delayed_job railties sidekiq rack rake]
VERSION = 
"0.15.1"
INTERFACES = 
{}

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.client ⇒ Object

The client object is responsible for delivering formatted data to the Sentry server.



50
51
52
 
# File 'lib/raven/base.rb', line 50

def client
  @client ||= Client.new(configuration)
end

.configuration ⇒ Object

The configuration object.

See Also:



45
46
47
 
# File 'lib/raven/base.rb', line 45

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.

Examples:

begin
  raise "Hello"
rescue => exc
  Raven.annotate_exception(exc, :user => { 'id' => 1,
                           'email' => '[email protected]' })
end


160
161
162
163
164
165
 
# File 'lib/raven/base.rb', line 160

def annotate_exception(exc, options = {})
  notes = exc.instance_variable_get(:@__raven_context) || {}
  notes.merge!(options)
  exc.instance_variable_set(:@__raven_context, notes)
  exc
end

.capture(options = {}) ⇒ Object

Capture and process any exceptions from the given block, or globally if no block is given

Examples:

Raven.capture do
  MyApp.run
end


101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/raven/base.rb', line 101

def capture(options = {})
  if block_given?
    begin
      yield
    rescue Error
      raise # Don't capture Raven errors
    rescue Exception => e
      capture_exception(e, options)
      raise
    end
  else
    install_at_exit_hook(options)
  end
end

.capture_type(obj, options = {}) ⇒ Object Also known as: capture_message, capture_exception 



116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/raven/base.rb', line 116

def capture_type(obj, options = {})
  return false unless should_capture?(obj)
  message_or_exc = obj.is_a?(String) ? "message" : "exception"
  if (evt = Event.send("from_" + message_or_exc, obj, options))
    yield evt if block_given?
    if configuration.async?
      configuration.async.call(evt)
    else
      send_event(evt)
    end

    evt
  end
end

.configure {|configuration| ... } ⇒ Object

Call this method to modify defaults in your initializers.

Examples:

Raven.configure do |config|
  config.server = 'http://...'
end

Yields:



71
72
73
74
75
76
77
 
# File 'lib/raven/base.rb', line 71

def configure
  yield(configuration) if block_given?

  self.client = Client.new(configuration)
  report_status
  self.client
end

.context ⇒ Object 



35
36
37
 
# File 'lib/raven/base.rb', line 35

def context
  Context.current
end

.extra_context(options = nil) ⇒ Object

Bind extra context. Merges with existing context (if any).

Extra context shows up as Additional Data within Sentry, and is completely arbitrary.

Examples:

Raven.extra_context('my_custom_data' => 'value')


195
196
197
 
# File 'lib/raven/base.rb', line 195

def extra_context(options = nil)
  self.context.extra.merge!(options || {})
end

.find_interface(name) ⇒ Object 



30
31
32
 
# File 'lib/raven/interfaces.rb', line 30

def self.find_interface(name)
  INTERFACES[name.to_s]
end

.inject ⇒ Object

Injects various integrations. Default behavior: inject all available integrations



207
208
209
 
# File 'lib/raven/base.rb', line 207

def inject
  inject_only(*Raven::AVAILABLE_INTEGRATIONS)
end

.inject_only(*only_integrations) ⇒ Object 



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/raven/base.rb', line 216

def inject_only(*only_integrations)
  only_integrations = only_integrations.map(&:to_s)
  integrations_to_load = Raven::AVAILABLE_INTEGRATIONS & only_integrations
  not_found_integrations = only_integrations - integrations_to_load
  if not_found_integrations.any?
    self.logger.warn "Integrations do not exist: #{not_found_integrations.join ', '}"
  end
  integrations_to_load &= Gem.loaded_specs.keys
  # TODO(dcramer): integrations should have some additional checks baked-in
  # or we should break them out into their own repos. Specifically both the
  # rails and delayed_job checks are not always valid (i.e. Rails 2.3) and
  # https://github.com/getsentry/raven-ruby/issues/180
  integrations_to_load.each do |integration|
    load_integration(integration)
  end
end

.inject_without(*exclude_integrations) ⇒ Object 



211
212
213
214
 
# File 'lib/raven/base.rb', line 211

def inject_without(*exclude_integrations)
  include_integrations = Raven::AVAILABLE_INTEGRATIONS - exclude_integrations.map(&:to_s)
  inject_only(*include_integrations)
end

.load_integration(integration) ⇒ Object 



233
234
235
236
237
 
# File 'lib/raven/base.rb', line 233

def load_integration(integration)
  require "raven/integrations/#{integration}"
rescue Exception => error
  self.logger.warn "Unable to load raven/integrations/#{integration}: #{error}"
end

.logger ⇒ Object 



39
40
41
 
# File 'lib/raven/base.rb', line 39

def logger
  @logger ||= Logger.new
end

.rack_context(env) ⇒ Object 



199
200
201
202
203
204
 
# File 'lib/raven/base.rb', line 199

def rack_context(env)
  if env.empty?
    env = nil
  end
  self.context.rack_env = env
end

.register_interface(mapping) ⇒ Object 



23
24
25
26
27
28
 
# File 'lib/raven/interfaces.rb', line 23

def self.register_interface(mapping)
  mapping.each_pair do |key, klass|
    INTERFACES[key.to_s] = klass
    INTERFACES[klass.name] = klass
  end
end

.report_status ⇒ Object Also known as: report_ready

Tell the log that the client is good to go



55
56
57
58
59
60
61
62
 
# File 'lib/raven/base.rb', line 55

def report_status
  return if client.configuration.silence_ready
  if client.configuration.send_in_current_environment?
    logger.info "Raven #{VERSION} ready to catch errors"
  else
    logger.info "Raven #{VERSION} configured not to send errors."
  end
end

.send(event) ⇒ Object 



88
89
90
91
92
 
# File 'lib/raven/base.rb', line 88

def send(event)
  Raven.logger.warn "DEPRECATION WARNING: Calling #send on Raven::Base will be \
    removed in Raven-Ruby 0.14! Use #send_event instead!"
  client.send_event(event)
end

.send_event(event) ⇒ Object

Send an event to the configured Sentry server

Examples:

evt = Raven::Event.new(:message => "An error")
Raven.send_event(evt)


84
85
86
 
# File 'lib/raven/base.rb', line 84

def send_event(event)
  client.send_event(event)
end

.should_capture?(message_or_exc) ⇒ Boolean

Returns:

  • (Boolean) 


133
134
135
136
137
138
139
 
# File 'lib/raven/base.rb', line 133

def should_capture?(message_or_exc)
  if configuration.should_capture
    configuration.should_capture.call(*[message_or_exc])
  else
    true
  end
end

.tags_context(options = nil) ⇒ 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.

Examples:

Raven.tags_context('my_custom_tag' => 'tag_value')


185
186
187
 
# File 'lib/raven/base.rb', line 185

def tags_context(options = nil)
  self.context.tags.merge!(options || {})
end

.user_context(options = nil) ⇒ 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.

Examples:

Raven.user_context('id' => 1, 'email' => '[email protected]')


174
175
176
 
# File 'lib/raven/base.rb', line 174

def user_context(options = nil)
  self.context.user = options || {}
end