class Exception

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Public Class Methods

details(message = nil, details = {}) click to toggle source

begin

raise StandardError.details("ALARM!", :a=>1)

rescue => ex

puts ex.view

end

# File lib/workety/extensions/exception.rb, line 29
def self.details message = nil, details = {}
  if message.kind_of? Hash
    message, details = nil, message
  end
  
  ex = new message
  ex.details.merge! details
  ex
end

Public Instance Methods

backtrace_view() click to toggle source

# File lib/workety/extensions/exception.rb, line 61
def backtrace_view
  ((bt = backtrace) && bt.collect{|line|"\t#{line}\n"}.join("") || "\tBacktrace undefined")
rescue ScriptError, StandardError => ex
  "\tERROR CREATING BACKTRACE VIEW: #{ex.summary_view}"
end

details() click to toggle source

# File lib/workety/extensions/exception.rb, line 19
def details
  @details ||= {}
end

details_view() click to toggle source

# File lib/workety/extensions/exception.rb, line 53
def details_view
  "Details: #{details.inspect}" if details.any?
rescue ScriptError, StandardError => ex
  "Details: ERROR CREATING DETAILS VIEW:\n" \
  "#{ex.summary_view}\n" \
  "#{ex.backtrace_view}"
end

log!() click to toggle source

# File lib/workety/extensions/exception.rb, line 84
def log!
  logger.error view
  logger.flush if logger.respond_to? :flush
rescue ScriptError, StandardError => ex
  STDERR.write "ERROR: LOGGING ANOTHER EXCEPTION THE FOLLOWING EXCEPTION OCCURED:\n" \
               "#{ex.view}\n" \
               "THE FOLLOWING EXCEPTION WAS NOT STORED IN LOG:\n" \
               "#{view}\n"
end

logger() click to toggle source

The following methods should not be called before Rails initialization.

# File lib/workety/extensions/exception.rb, line 70
def logger
  Rails.logger
end

report!() click to toggle source

# File lib/workety/extensions/exception.rb, line 74
def report!
  log!
  report_to_trackers! if Rails.env == "production"
end

report_to_airbrake!() click to toggle source

Airbrake API requires the following elements to be present:

/notice/error/class
/notice/error/backtrace/line
/notice/server-environment/environment-name

# File lib/workety/extensions/exception.rb, line 108
def report_to_airbrake!
  File.readable?(file = Rails.root + 'config' + 'airbrake.yml') &&
    (yaml = YAML.load_file file).kind_of?(Hash) &&
    (api_key = yaml["api-key"]).kind_of?(String) ||
    raise("Unable to read Airbrake api-key from #{file}")
  
  options = if details[:request].kind_of? Hash
    params = details.dup
    request = params.delete :request
    
    { url:           request[:url],
      component:     request[:controller],
      action:        request[:action],
      params:        (request[:params] || {}).merge(params),
      session:       request[:session],
      framework_env: Rails.env }
    
  else
    { params:        details,
      framework_env: Rails.env }
  end
  
  response = Toadhopper(api_key).post!(self, options)
  
  if response.status != 200
    raise StandardError.details("Tracker responded with status #{response.status}", body: response.body)
  end
  
rescue ScriptError, StandardError => ex
  ex.log!
end

report_to_exceptional!() click to toggle source

# File lib/workety/extensions/exception.rb, line 95
def report_to_exceptional!
  Exceptional::Remote.error Exceptional::DetailsExceptionData.new(self)
  Exceptional.context.clear!
rescue ScriptError, StandardError => ex
  ex.log!
end

report_to_trackers!() click to toggle source

# File lib/workety/extensions/exception.rb, line 79
def report_to_trackers!
  report_to_exceptional! if defined?(Exceptional)
  report_to_airbrake! if defined?(Toadhopper)
end

summary_view() click to toggle source

# File lib/workety/extensions/exception.rb, line 49
def summary_view
  "#{self.class.name}: #{message}"
end

view() click to toggle source

# File lib/workety/extensions/exception.rb, line 43
def view
  [summary_view, details_view, backtrace_view].compact.join("\n")
rescue ScriptError, StandardError
  "ERROR CREATING EXCEPTION VIEW"
end

view!() click to toggle source

# File lib/workety/extensions/exception.rb, line 39
def view!
  STDERR.write "#{view}\n"
end