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/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

VERSION = 
"0.13.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.



48
49
50
 
# File 'lib/raven/base.rb', line 48

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

.configuration ⇒ Object

The configuration object.

See Also:



43
44
45
 
# File 'lib/raven/base.rb', line 43

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


150
151
152
153
154
155
 
# File 'lib/raven/base.rb', line 150

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


93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/raven/base.rb', line 93

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 



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/raven/base.rb', line 108

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(evt)
    end
  end
end

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

Call this method to modify defaults in your initializers.

Examples:

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

Yields:



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

def configure
  yield(configuration) if block_given?

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

.context ⇒ Object 



33
34
35
 
# File 'lib/raven/base.rb', line 33

def context
  Context.current
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.

Examples:

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


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

def extra_context(options = {})
  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



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/raven/base.rb', line 197

def inject
  available_integrations = %w[delayed_job rails sidekiq rack rake]
  integrations_to_load = available_integrations & 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|
    begin
      require "raven/integrations/#{integration}"
    rescue Exception => error
      self.logger.warn "Unable to load raven/integrations/#{integration}: #{error}"
    end
  end
end

.logger ⇒ Object 



37
38
39
 
# File 'lib/raven/base.rb', line 37

def logger
  @logger ||= Logger.new
end

.rack_context(env) ⇒ Object 



189
190
191
192
193
194
 
# File 'lib/raven/base.rb', line 189

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



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

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(evt) ⇒ Object

Send an event to the configured Sentry server

Examples:

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


82
83
84
 
# File 'lib/raven/base.rb', line 82

def send(evt)
  client.send(evt)
end

.should_capture?(message_or_exc) ⇒ Boolean

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
 
# File 'lib/raven/base.rb', line 123

def should_capture?(message_or_exc)
  if configuration.should_capture
    configuration.should_capture.call(*[message_or_exc])
  else
    true
  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.

Examples:

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


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

def tags_context(options = {})
  self.context.tags.merge!(options)
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.

Examples:

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


164
165
166
 
# File 'lib/raven/base.rb', line 164

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