Class: Raven::Event
- Inherits:
-
Object
- Object
- Raven::Event
- 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
-
#configuration ⇒ Object
Returns the value of attribute configuration.
-
#context ⇒ Object
Returns the value of attribute context.
-
#culprit ⇒ Object
Returns the value of attribute culprit.
-
#extra ⇒ Object
Returns the value of attribute extra.
-
#id ⇒ Object
readonly
Returns the value of attribute id.
-
#level ⇒ Object
Returns the value of attribute level.
-
#logger ⇒ Object
Returns the value of attribute logger.
-
#message ⇒ Object
Returns the value of attribute message.
-
#modules ⇒ Object
Returns the value of attribute modules.
-
#project ⇒ Object
Returns the value of attribute project.
-
#release ⇒ Object
Returns the value of attribute release.
-
#server_name ⇒ Object
Returns the value of attribute server_name.
-
#tags ⇒ Object
Returns the value of attribute tags.
-
#time_spent ⇒ Object
Returns the value of attribute time_spent.
-
#timestamp ⇒ Object
Returns the value of attribute timestamp.
Class Method Summary collapse
-
._source_lines(_path, _from, _to) ⇒ Object
Because linecache can go to hell.
- .add_exception_interface(evt, exc) ⇒ Object
- .from_exception(exc, options = {}, &block) ⇒ Object (also: captureException, capture_exception)
- .from_message(message, options = {}) ⇒ Object (also: captureMessage, capture_message)
- .stacktrace_interface_from(int, evt, backtrace) ⇒ Object
Instance Method Summary collapse
- #[](key) ⇒ Object
- #[]=(key, value) ⇒ Object
- #get_culprit(frames) ⇒ Object
- #get_file_context(filename, lineno, context) ⇒ Object
- #get_hostname ⇒ Object
- #get_modules ⇒ Object
-
#initialize(init = {}) {|_self| ... } ⇒ Event
constructor
A new instance of Event.
- #interface(name, value = nil, &block) ⇒ Object
- #to_hash ⇒ Object
Constructor Details
#initialize(init = {}) {|_self| ... } ⇒ 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 |
# File 'lib/raven/event.rb', line 29 def initialize(init = {}) @configuration = Raven.configuration @interfaces = {} @context = Raven.context @id = generate_event_id @message = nil @timestamp = Time.now.utc @time_spent = nil @level = :error @logger = 'root' @culprit = nil @server_name = @configuration.server_name || get_hostname @release = @configuration.release @modules = get_modules if @configuration.send_modules @user = {} @extra = {} @tags = {} 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.merge!(@context.user) @extra.merge!(@context.extra) @tags.merge!(@configuration.) @tags.merge!(@context.) # 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
#configuration ⇒ Object
Returns the value of attribute configuration.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def configuration @configuration end |
#context ⇒ Object
Returns the value of attribute context.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def context @context end |
#culprit ⇒ Object
Returns the value of attribute culprit.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def culprit @culprit end |
#extra ⇒ Object
Returns the value of attribute extra.
26 27 28 |
# File 'lib/raven/event.rb', line 26 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.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def logger @logger end |
#message ⇒ Object
Returns the value of attribute message.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def @message end |
#modules ⇒ Object
Returns the value of attribute modules.
26 27 28 |
# File 'lib/raven/event.rb', line 26 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 |
#release ⇒ Object
Returns the value of attribute release.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def release @release end |
#server_name ⇒ Object
Returns the value of attribute server_name.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def server_name @server_name end |
#tags ⇒ Object
Returns the value of attribute tags.
26 27 28 |
# File 'lib/raven/event.rb', line 26 def @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 end |
Class Method Details
._source_lines(_path, _from, _to) ⇒ Object
Because linecache can go to hell
206 207 |
# File 'lib/raven/event.rb', line 206 def self._source_lines(_path, _from, _to) end |
.add_exception_interface(evt, exc) ⇒ Object
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/raven/event.rb', line 161 def self.add_exception_interface(evt, exc) evt.interface(:exception) do |exc_int| exceptions = [exc] while exc.respond_to?(:cause) && exc.cause exceptions << exc.cause exc = exc.cause end exceptions.reverse! exc_int.values = exceptions.map do |exc| SingleExceptionInterface.new do |int| int.type = exc.class.to_s int.value = exc.to_s int.module = exc.class.to_s.split('::')[0...-1].join('::') int.stacktrace = if exc.backtrace StacktraceInterface.new do |stacktrace| stacktrace_interface_from(stacktrace, evt, exc.backtrace) end end end end end end |
.from_exception(exc, options = {}, &block) ⇒ Object Also known as: captureException, capture_exception
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/raven/event.rb', line 118 def self.from_exception(exc, = {}, &block) notes = exc.instance_variable_get(:@__raven_context) || {} = notes.merge() configuration = [: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() do |evt| evt.configuration = configuration evt. = "#{exc.class}: #{exc.}" evt.level = [:level] || :error add_exception_interface(evt, exc) block.call(evt) if block end end |
.from_message(message, options = {}) ⇒ Object Also known as: captureMessage, capture_message
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 |
# File 'lib/raven/event.rb', line 144 def self.(, = {}) configuration = [:configuration] || Raven.configuration new() do |evt| evt.configuration = configuration evt. = evt.level = [:level] || :error evt.interface :message do |int| int. = end if [:backtrace] evt.interface(:stacktrace) do |int| stacktrace_interface_from(int, evt, [:backtrace]) end end end end |
.stacktrace_interface_from(int, evt, backtrace) ⇒ Object
186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 |
# File 'lib/raven/event.rb', line 186 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 frame.function = line.method frame.lineno = line.number frame.in_app = line.in_app 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 { |f| f.filename } evt.culprit = evt.get_culprit(int.frames) end |
Instance Method Details
#[](key) ⇒ Object
86 87 88 |
# File 'lib/raven/event.rb', line 86 def [](key) interface(key) end |
#[]=(key, value) ⇒ Object
90 91 92 |
# File 'lib/raven/event.rb', line 90 def []=(key, value) interface(key, value) end |
#get_culprit(frames) ⇒ Object
216 217 218 219 |
# File 'lib/raven/event.rb', line 216 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
209 210 211 212 213 214 |
# File 'lib/raven/event.rb', line 209 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
68 69 70 71 72 |
# File 'lib/raven/event.rb', line 68 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
74 75 76 77 |
# File 'lib/raven/event.rb', line 74 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
79 80 81 82 83 84 |
# File 'lib/raven/event.rb', line 79 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
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/raven/event.rb', line 94 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[:release] = @release if @release 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.to_sym] = int_data.to_hash end data end |