Class: Raven::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/raven/event.rb

Constant Summary collapse

LOG_LEVELS = 
{
  "debug" => 10,
  "info" => 20,
  "warn" => 30,
  "warning" => 30,
  "error" => 40,
  "fatal" => 50,
}
BACKTRACE_RE = 
/^(.+?):(\d+)(?::in `(.+?)')?$/
PLATFORM = 
"ruby"

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, &block) ⇒ Event

Returns a new instance of Event.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/raven/event.rb', line 29

def initialize(options = {}, &block)
  @configuration = options[:configuration] || Raven.configuration
  @interfaces = {}

  context = options[:context] || Raven.context

  @id = options[:id] || generate_event_id
  @message = options[:message]
  @timestamp = options[:timestamp] || Time.now.utc
  @time_spent = options[:time_spent]

  @level = options[:level] || :error
  @logger = options[:logger] || 'root'
  @culprit = options[:culprit]
  @server_name = options[:server_name] || @configuration.server_name || get_hostname

  options[:modules] ||= get_modules if @configuration.send_modules

  @modules = options[:modules]

  @user = options[:user] || {}
  @user.merge!(context.user)

  @extra = options[:extra] || {}
  @extra.merge!(context.extra)

  @tags = {}
  @tags.merge!(@configuration.tags)
  @tags.merge!(options[:tags] || {})
  @tags.merge!(context.tags)

  block.call(self) if block

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

  # 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

Instance Attribute Details

#culprit ⇒ Object

Returns the value of attribute culprit.



27
28
29
 
# File 'lib/raven/event.rb', line 27

def culprit
  @culprit
end

#extra ⇒ Object

Returns the value of attribute extra.



27
28
29
 
# File 'lib/raven/event.rb', line 27

def extra
  @extra
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



25
26
27
 
# File 'lib/raven/event.rb', line 25

def id
  @id
end

#level ⇒ Object

Returns the value of attribute level.



26
27
28
 
# File 'lib/raven/event.rb', line 26

def level
  @level
end

#logger ⇒ Object

Returns the value of attribute logger.



27
28
29
 
# File 'lib/raven/event.rb', line 27

def logger
  @logger
end

#message ⇒ Object

Returns the value of attribute message.



26
27
28
 
# File 'lib/raven/event.rb', line 26

def message
  @message
end

#modules ⇒ Object

Returns the value of attribute modules.



27
28
29
 
# File 'lib/raven/event.rb', line 27

def modules
  @modules
end

#project ⇒ Object

Returns the value of attribute project.



26
27
28
 
# File 'lib/raven/event.rb', line 26

def project
  @project
end

#server_name ⇒ Object

Returns the value of attribute server_name.



27
28
29
 
# File 'lib/raven/event.rb', line 27

def server_name
  @server_name
end

#tags ⇒ Object

Returns the value of attribute tags.



27
28
29
 
# File 'lib/raven/event.rb', line 27

def tags
  @tags
end

#time_spent ⇒ Object

Returns the value of attribute time_spent.



26
27
28
 
# File 'lib/raven/event.rb', line 26

def time_spent
  @time_spent
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



26
27
28
 
# File 'lib/raven/event.rb', line 26

def timestamp
  @timestamp
end

Class Method Details

._source_lines(_path, _from, _to) ⇒ Object

Because linecache can go to hell



187
188
 
# File 'lib/raven/event.rb', line 187

def self._source_lines(_path, _from, _to)
end

.from_exception(exc, options = {}, &block) ⇒ Object Also known as: captureException, capture_exception 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/raven/event.rb', line 123

def self.from_exception(exc, options = {}, &block)
  notes = 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

  context_lines = configuration[:context_lines]

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

    evt.interface(:exception) do |int|
      int.type = exc.class.to_s
      int.value = exc.to_s
      int.module = exc.class.to_s.split('::')[0...-1].join('::')

      # TODO(dcramer): this needs cleaned up, but I couldn't figure out how to
      # work Hashie as a non-Rubyist
      if exc.backtrace
        int.stacktrace = StacktraceInterface.new do |stacktrace|
          backtrace = Backtrace.parse(exc.backtrace)
          stacktrace.frames = backtrace.lines.reverse.map do |line|
            stacktrace.frame do |frame|
              frame.abs_path = line.file
              frame.function = line.method
              frame.lineno = line.number
              frame.in_app = line.in_app
              if context_lines && frame.abs_path
                frame.pre_context, frame.context_line, frame.post_context = \
                  evt.get_file_context(frame.abs_path, frame.lineno, context_lines)
              end
            end
          end.select { |f| f.filename }

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

    block.call(evt) if block
  end
end

.from_message(message, options = {}) ⇒ Object Also known as: captureMessage, capture_message 



176
177
178
179
180
181
182
183
184
 
# File 'lib/raven/event.rb', line 176

def self.from_message(message, options = {})
  new(options) do |evt|
    evt.message = message
    evt.level = options[:level] || :error
    evt.interface :message do |int|
      int.message = message
    end
  end
end

Instance Method Details

#[](key) ⇒ Object 



92
93
94
 
# File 'lib/raven/event.rb', line 92

def [](key)
  interface(key)
end

#[]=(key, value) ⇒ Object 



96
97
98
 
# File 'lib/raven/event.rb', line 96

def []=(key, value)
  interface(key, value)
end

#get_culprit(frames) ⇒ Object 



197
198
199
200
 
# File 'lib/raven/event.rb', line 197

def get_culprit(frames)
  lastframe = frames.reverse.find { |f| f.in_app } || frames.last
  "#{lastframe.filename} in #{lastframe.function} at line #{lastframe.lineno}" if lastframe
end

#get_file_context(filename, lineno, context) ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/raven/event.rb', line 190

def get_file_context(filename, lineno, context)
  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

#get_hostname ⇒ Object 



74
75
76
77
78
 
# File 'lib/raven/event.rb', line 74

def get_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

#get_modules ⇒ Object 



80
81
82
83
 
# File 'lib/raven/event.rb', line 80

def get_modules
  # 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

#interface(name, value = nil, &block) ⇒ Object

Raises:



85
86
87
88
89
90
 
# File 'lib/raven/event.rb', line 85

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

#to_hash ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/raven/event.rb', line 100

def to_hash
  data = {
    'event_id' => @id,
    'message' => @message,
    'timestamp' => @timestamp,
    'time_spent' => @time_spent,
    'level' => @level,
    'project' => @project,
    'logger' => @logger,
    'platform' => PLATFORM,
  }
  data['culprit'] = @culprit if @culprit
  data['server_name'] = @server_name if @server_name
  data['modules'] = @modules if @modules
  data['extra'] = @extra if @extra
  data['tags'] = @tags if @tags
  data['user'] = @user if @user
  @interfaces.each_pair do |name, int_data|
    data[name] = int_data.to_hash
  end
  data
end