# class Raven::Event

### Constants

BACKTRACE_RE
LOG_LEVELS
PLATFORM

### Attributes

checksum[RW]
configuration[RW]
context[RW]
culprit[RW]
extra[RW]
fingerprint[RW]
id[R]
level[RW]
logger[RW]
message[RW]
modules[RW]
project[RW]
release[RW]
server_name[RW]
tags[RW]
time_spent[RW]
timestamp[RW]

### Public Class Methods

_source_lines(_path, _from, _to) click to toggle source

Because linecache can go to hell

    # File lib/raven/event.rb, line 219
    def self._source_lines(_path, _from, _to)
    end

add_exception_interface(evt, exc) click to toggle source

    # File lib/raven/event.rb, line 166
    def self.add_exception_interface(evt, exc)
      evt.interface(:exception) do |exc_int|
        exceptions = [exc]
        context = Set.new [exc.object_id]
        while exc.respond_to?(:cause) && exc.cause
          exceptions << exc.cause
          exc = exc.cause
          # TODO(dcramer): ideally this would log to inform the user
          if context.include?(exc.object_id)
            break
          end
          context.add(exc.object_id)
        end
        exceptions.reverse!

        exc_int.values = exceptions.map do |e|
          SingleExceptionInterface.new do |int|
            int.type = e.class.to_s
            int.value = e.to_s
            int.module = e.class.to_s.split('::')[0...-1].join('::')

            int.stacktrace =
              if e.backtrace
                StacktraceInterface.new do |stacktrace|
                  stacktrace_interface_from(stacktrace, evt, e.backtrace)
                end
              end
          end
        end
      end
    end

captureException(exc, options = {}, &block)
Alias for: from_exception
captureMessage(message, options = {})
Alias for: from_message
capture_exception(exc, options = {}, &block)
Alias for: from_exception
capture_message(message, options = {})
Alias for: from_message
from_exception(exc, options = {}, &block) click to toggle source

    # File lib/raven/event.rb, line 123
    def self.from_exception(exc, options = {}, &block)
      notes = (exc.instance_variable_defined?(:@__raven_context) && exc.instance_variable_get(:@__raven_context)) || {}
      options = notes.merge(options)

      configuration = options[:configuration] || Raven.configuration
      if exc.is_a?(Raven::Error)
        # Try to prevent error reporting loops
        Raven.logger.info "Refusing to capture Raven error: #{exc.inspect}"
        return nil
      end
      if configuration[:excluded_exceptions].any? { |x| (x === exc rescue false) || x == exc.class.name }
        Raven.logger.info "User excluded error: #{exc.inspect}"
        return nil
      end

      new(options) do |evt|
        evt.configuration = configuration
        evt.message = "#{exc.class}: #{exc.message}"
        evt.level = options[:level] || :error

        add_exception_interface(evt, exc)

        block.call(evt) if block
      end
    end

Also aliased as: captureException, capture_exception
from_message(message, options = {}) click to toggle source

    # File lib/raven/event.rb, line 149
    def self.from_message(message, options = {})
      configuration = options[:configuration] || Raven.configuration
      new(options) do |evt|
        evt.configuration = configuration
        evt.message = message
        evt.level = options[:level] || :error
        evt.interface :message do |int|
          int.message = message
        end
        if options[:backtrace]
          evt.interface(:stacktrace) do |int|
            stacktrace_interface_from(int, evt, options[:backtrace])
          end
        end
      end
    end

Also aliased as: captureMessage, capture_message
new(init = {}) { |self| ... } click to toggle source

    # File lib/raven/event.rb, line 30
    def initialize(init = {})
      @configuration = Raven.configuration
      @interfaces    = {}
      @context       = Raven.context
      @id            = generate_event_id
      @project       = nil
      @message       = nil
      @timestamp     = Time.now.utc
      @time_spent    = nil
      @level         = :error
      @logger        = ''
      @culprit       = nil
      @server_name   = @configuration.server_name || resolve_hostname
      @release       = @configuration.release
      @modules       = list_gem_specs if @configuration.send_modules
      @user          = {}
      @extra         = {}
      @tags          = {}
      @checksum      = nil
      @fingerprint   = nil

      yield self if block_given?

      if !self[:http] && @context.rack_env
        interface :http do |int|
          int.from_rack(@context.rack_env)
        end
      end

      init.each_pair { |key, val| instance_variable_set('@' + key.to_s, val) }

      @user = @context.user.merge(@user)
      @extra = @context.extra.merge(@extra)
      @tags = @configuration.tags.merge(@context.tags).merge(@tags)

      # Some type coercion
      @timestamp  = @timestamp.strftime('%Y-%m-%dT%H:%M:%S') if @timestamp.is_a?(Time)
      @time_spent = (@time_spent*1000).to_i if @time_spent.is_a?(Float)
      @level      = LOG_LEVELS[@level.to_s.downcase] if @level.is_a?(String) || @level.is_a?(Symbol)
    end

stacktrace_interface_from(int, evt, backtrace) click to toggle source

    # File lib/raven/event.rb, line 198
    def self.stacktrace_interface_from(int, evt, backtrace)
      backtrace = Backtrace.parse(backtrace)
      int.frames = backtrace.lines.reverse.map do |line|
        StacktraceInterface::Frame.new.tap do |frame|
          frame.abs_path = line.file if line.file
          frame.function = line.method if line.method
          frame.lineno = line.number
          frame.in_app = line.in_app
          frame.module = line.module_name if line.module_name

          if evt.configuration[:context_lines] && frame.abs_path
            frame.pre_context, frame.context_line, frame.post_context =                evt.get_file_context(frame.abs_path, frame.lineno, evt.configuration[:context_lines])
          end
        end
      end.select(&:filename)

      evt.culprit = evt.get_culprit(int.frames)
    end

### Public Instance Methods

[](key) click to toggle source

    # File lib/raven/event.rb, line 89
    def [](key)
      interface(key)
    end

[]=(key, value) click to toggle source

    # File lib/raven/event.rb, line 93
    def []=(key, value)
      interface(key, value)
    end

get_culprit(frames) click to toggle source

    # File lib/raven/event.rb, line 230
    def get_culprit(frames)
      lastframe = frames.reverse.find(&:in_app) || frames.last
      "#{lastframe.filename} in #{lastframe.function} at line #{lastframe.lineno}" if lastframe
    end

get_file_context(filename, lineno, context) click to toggle source

    # File lib/raven/event.rb, line 222
    def get_file_context(filename, lineno, context)
      return nil, nil, nil unless Raven::LineCache.is_valid_file(filename)
      lines = (2 * context + 1).times.map do |i|
        Raven::LineCache.getline(filename, lineno - context + i)
      end
      [lines[0..(context - 1)], lines[context], lines[(context + 1)..-1]]
    end

interface(name, value = nil, &block) click to toggle source

    # File lib/raven/event.rb, line 82
    def interface(name, value = nil, &block)
      int = Raven.find_interface(name)
      raise Error.new("Unknown interface: #{name}") unless int
      @interfaces[int.name] = int.new(value, &block) if value || block
      @interfaces[int.name]
    end

list_gem_specs() click to toggle source

    # File lib/raven/event.rb, line 77
    def list_gem_specs
      # Older versions of Rubygems don't support iterating over all specs
      Hash[Gem::Specification.map { |spec| [spec.name, spec.version.to_s] }] if Gem::Specification.respond_to?(:map)
    end

resolve_hostname() click to toggle source

    # File lib/raven/event.rb, line 71
    def resolve_hostname
      # Try to resolve the hostname to an FQDN, but fall back to whatever the load name is
      hostname = Socket.gethostname
      Socket.gethostbyname(hostname).first rescue hostname
    end

to_hash() click to toggle source

    # File lib/raven/event.rb, line 97
    def to_hash
      data = {
        :event_id => @id,
        :message => @message,
        :timestamp => @timestamp,
        :time_spent => @time_spent,
        :level => @level,
        :project => @project,
        :platform => PLATFORM,
      }
      data[:logger] = @logger if @logger
      data[:culprit] = @culprit if @culprit
      data[:server_name] = @server_name if @server_name
      data[:release] = @release if @release
      data[:fingerprint] = @fingerprint if @fingerprint
      data[:modules] = @modules if @modules
      data[:extra] = @extra if @extra
      data[:tags] = @tags if @tags
      data[:user] = @user if @user
      data[:checksum] = @checksum if @checksum
      @interfaces.each_pair do |name, int_data|
        data[name.to_sym] = int_data.to_hash
      end
      data
    end