errplane 0.3.7 → 0.4.0

data/lib/errplane.rb

@@ -2,10 +2,14 @@ require 'net/http'
 require 'net/https'
 require 'rubygems'
 
+require "json" unless Hash.respond_to?(:to_json)
+
 require "errplane/version"
+require "errplane/logger"
 require "errplane/black_box"
 require "errplane/configuration"
 require "errplane/transmitter"
+require "errplane/backtrace"
 require "errplane/rack"
 
 require "errplane/railtie" if defined? Rails::Railtie
@@ -13,6 +17,8 @@ require "errplane/sinatra" if defined? Sinatra::Request
 
 module Errplane
   class << self
+    include Logger
+
     attr_writer :configuration
     attr_accessor :transmitter
 
@@ -28,14 +34,14 @@ module Errplane
     def transmit_unless_ignorable(e, env)
       begin
         black_box = assemble_black_box_for(e, env)
-        configuration.logger.info("\nTransmitter: #{transmitter.inspect}") if configuration.debug?
-        configuration.logger.info("\nBlack Box: #{black_box.to_json}") if configuration.debug?
-        configuration.logger.info("\nIgnorable Exception? #{ignorable_exception?(e)}") if configuration.debug?
-        configuration.logger.info("\nEnvironment: #{ENV.to_hash}") if configuration.debug?
+        log :info, "Transmitter: #{transmitter.inspect}"
+        log :info, "Black Box: #{black_box.to_json}"
+        log :info, "Ignorable Exception? #{ignorable_exception?(e)}"
+        log :info, "Environment: #{ENV.to_hash}"
 
         transmitter.relay(black_box) unless ignorable_exception?(e)
       rescue => e
-        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off. 2-" + e.inspect)
+        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off! #{e.class}: #{e.message}")
       end
     end
 
@@ -47,13 +53,12 @@ module Errplane
           assemble_black_box_for(e, env)
         end
 
-        configuration.logger.info("\nTransmitter: #{transmitter.inspect}") if configuration.debug?
-        configuration.logger.info("\nBlack Box: #{black_box.to_json}") if configuration.debug?
-        configuration.logger.info("\nIgnorable Exception? #{ignorable_exception?(e)}") if configuration.debug?
-        configuration.logger.info("\nEnvironment: #{ENV.to_hash}") if configuration.debug?
+        log :info, "Transmitter: #{transmitter.inspect}"
+        log :info, "Black Box: #{black_box.to_json}"
+        log :info, "Environment: #{ENV.to_hash}"
         transmitter.relay(black_box)
       rescue => e
-        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off. 1-" + e.inspect)
+        configuration.logger.info("[Errplane] Something went terribly wrong. Exception failed to take off! #{e.class}: #{e.message}")
       end
     end
 

data/lib/errplane/backtrace.rb

@@ -0,0 +1,38 @@
+module Errplane
+  class Backtrace
+    class Line
+      FORMAT = %r{^((?:[a-zA-Z]:)?[^:]+):(\d+)(?::in `([^']+)')?$}.freeze
+
+      attr_reader :file
+      attr_reader :number
+      attr_reader :method
+
+      def initialize(line)
+        _, @file, @number, @method = line.match(FORMAT).to_a
+      end
+
+      def to_s
+        "#{file}:#{number} in `#{method}'"
+      end
+
+      def inspect
+        "<Line: #{to_s}>"
+      end
+    end
+
+    attr_reader :lines
+
+    def initialize(backtrace)
+      @lines = backtrace.each.collect do |line|
+        Errplane.configuration.backtrace_filters.each do |filter|
+          line = filter.call(line)
+        end
+        Line.new(line)
+      end
+    end
+
+    def inspect
+      "<Backtrace: " + lines.collect { |line| line.to_s }.join(", ") + ">"
+    end
+  end
+end

data/lib/errplane/black_box.rb

@@ -7,6 +7,7 @@ module Errplane
     attr_reader :controller
     attr_reader :action
     attr_reader :request_url
+    attr_reader :user_agent
     attr_reader :custom_data
 
     def initialize(params = {})
@@ -16,11 +17,12 @@ module Errplane
       @controller = params[:controller]
       @action = params[:action]
       @request_url = params[:request_url]
+      @user_agent = params[:user_agent]
       @custom_data = params[:custom_data] || {}
     end
 
     def to_json
-      paylaod = {
+      payload = {
         :time => Time.now.to_i,
         :application_name => Errplane.configuration.application_name,
         :application_root => Errplane.configuration.application_root,
@@ -38,10 +40,10 @@ module Errplane
 
       Errplane.configuration.add_custom_exception_data(self)
 
-      paylaod[:request_data] = request_data if @controller || @action || !params.empty?
-      paylaod[:hash] = hash if hash
+      payload[:request_data] = request_data if @controller || @action || !params.empty?
+      payload[:hash] = hash if hash
 
-      paylaod.to_json
+      payload.to_json
     end
 
     def reporter
@@ -58,7 +60,8 @@ module Errplane
         :session_data => @session_data,
         :controller => @controller,
         :action => @action,
-        :request_url => @request_url
+        :request_url => @request_url,
+        :user_agent => @user_agent
       }
     end
   end

data/lib/errplane/capistrano.rb

@@ -1,5 +1,4 @@
 require 'errplane'
-require 'json'
 
 Capistrano::Configuration.instance(:must_exist).load do
   after 'deploy',            'deploy:notify_errplane'

data/lib/errplane/configuration.rb

@@ -6,7 +6,6 @@ module Errplane
     attr_accessor :application_id
     attr_accessor :application_name
     attr_accessor :application_root
-    attr_accessor :syslogd_port
 
     attr_accessor :logger
     attr_accessor :rails_environment
@@ -16,16 +15,34 @@ module Errplane
     attr_accessor :language_version
     attr_accessor :ignored_exceptions
     attr_accessor :ignored_environments
+    attr_accessor :ignored_user_agents
+    attr_accessor :backtrace_filters
+
     attr_accessor :environment_variables
 
     attr_accessor :debug
+    attr_accessor :reraise_global_exceptions
 
     DEFAULTS = {
       :api_host => "api.errplane.com",
       :app_host => "app.errplane.com",
       :ignored_exceptions => %w{ActiveRecord::RecordNotFound
                                 ActionController::RoutingError},
-      :ignored_environments => %w{development test cucumber selenium}
+      :ignored_environments => %w{development test cucumber selenium},
+      :ignored_user_agents => %w{GoogleBot},
+      :backtrace_filters => [
+        lambda { |line| line.gsub(/^\.\//, "") },
+        lambda { |line|
+          return line if Errplane.configuration.application_root.to_s.empty?
+          line.gsub(/#{Errplane.configuration.application_root}/, "[APP_ROOT]")
+        },
+        lambda { |line|
+          if defined?(Gem) && !Gem.path.nil? && !Gem.path.empty?
+            Gem.path.each { |path| line = line.gsub(/#{path}/, "[GEM_ROOT]") }
+          end
+          line
+        }
+      ]
     }
 
     def initialize
@@ -33,36 +50,27 @@ module Errplane
       @app_host = DEFAULTS[:app_host]
       @ignored_exceptions = DEFAULTS[:ignored_exceptions].dup
       @ignored_environments = DEFAULTS[:ignored_environments].dup
+      @ignored_user_agents = DEFAULTS[:ignored_user_agents].dup
+      @backtrace_filters = DEFAULTS[:backtrace_filters].dup
       @debug = false
+      @rescue_global_exceptions = false
     end
 
     def debug?
       !!@debug
     end
 
-    def ignore_current_environment?
-      self.ignored_environments.include?(self.rails_environment)
+    def reraise_global_exceptions?
+      !!@reraise_global_exceptions
     end
 
-    def get_logport
-      puts "Acquiring port information from errplane"
-      http = initialize_http_connection
-      response = begin
-                   url = "/api/v1/syslogds.txt?api_key=#{@api_key}"
-                   http.get(url)
-                 rescue Exception => e
-                   puts e
-                 end
-
+    def ignore_user_agent?(incoming_user_agent)
+      return false if self.ignored_user_agents.nil?
+      self.ignored_user_agents.any? {|agent| incoming_user_agent =~ /#{agent}/}
+    end
 
-      case response
-      when Net::HTTPSuccess
-        # Success
-        response.body
-      else
-        # Failure
-        ""
-      end
+    def ignore_current_environment?
+      self.ignored_environments.include?(self.rails_environment)
     end
 
     def define_custom_exception_data(&block)

data/lib/errplane/errplane_chef_handler.rb

@@ -50,16 +50,14 @@ class ErrplaneChefHandler < Chef::Handler
   end
 
   def setup_errplane
-    raise ArgumentError.new("You must specify Errplane api key") unless api_key    
+    raise ArgumentError.new("You must provide an Errplane API key") unless api_key
     Errplane.configure do |config|
       config.api_key = api_key
       config.application_id = "chef"
       config.application_name = "chef"
-      # config.syslogd_port = "4445"
       config.logger = Chef::Log
-      #config.logger = Logger.new(STDOUT)
       config.debug = false
       config.rails_environment = @environment
     end
   end
-end
+end

data/lib/errplane/logger.rb

@@ -0,0 +1,11 @@
+module Errplane
+  module Logger
+    PREFIX = "[Errplane] "
+
+    private
+    def log(level, message)
+      return if level != :error && !Errplane.configuration.debug?
+      Errplane.configuration.logger.send(level, PREFIX + message) if Errplane.configuration.logger
+    end
+  end
+end

data/lib/errplane/rails/air_traffic_controller.rb

@@ -7,7 +7,8 @@ module Errplane
           :session_data => errplane_session_data,
           :controller => params[:controller],
           :action => params[:action],
-          :request_url => errplane_request_url
+          :request_url => errplane_request_url,
+          :user_agent => request.env["HTTP_USER_AGENT"]
         }
       end
 

data/lib/errplane/rails/middleware/hijack_render_exception.rb

@@ -9,8 +9,11 @@ module Errplane
         def render_exception_with_errplane(env, e)
           controller = env["action_controller.instance"]
           Errplane.configuration.logger.info("Controller: #{controller}")
-          Errplane.configuration.logger.info("Request Data: #{controller.try(:errplane_request_data)}")
-          Errplane.transmit_unless_ignorable(e,  controller.try(:errplane_request_data))
+          request_data = controller.try(:errplane_request_data) || {}
+          Errplane.configuration.logger.info("Request Data: #{request_data}")
+          unless Errplane.configuration.ignore_user_agent?(request_data[:user_agent])
+            Errplane.transmit_unless_ignorable(e, request_data)
+          end
           render_exception_without_errplane(env, e)
         end
       end

data/lib/errplane/railtie.rb

@@ -11,11 +11,6 @@ module Errplane
             exit
           end
 
-          Errplane.configuration.syslogd_port =  Errplane.configuration.get_logport
-          if(Errplane.configuration.syslogd_port && Errplane.configuration.syslogd_port.to_s != "") 
-            require 'errplane/rails/udp_logger'
-          end
-
           Errplane.configure do |config|
             config.ignored_environments = []
           end
@@ -80,10 +75,6 @@ module Errplane
         config.framework_version       = ::Rails::VERSION::STRING
       end
 
-      if(Errplane.configuration.syslogd_port && Errplane.configuration.syslogd_port.to_s != "") 
-        require 'errplane/rails/udp_logger'
-      end
-
       ActiveSupport.on_load(:action_controller) do
         require 'errplane/rails/air_traffic_controller'
         include Errplane::Rails::AirTrafficController

data/lib/errplane/transmitter.rb

@@ -1,5 +1,16 @@
 module Errplane
   class Transmitter
+    include Errplane::Logger
+
+    HTTP_ERRORS = [ EOFError,
+                    Errno::ECONNREFUSED,
+                    Errno::ECONNRESET,
+                    Errno::EINVAL,
+                    Net::HTTPBadResponse,
+                    Net::HTTPHeaderSyntaxError,
+                    Net::ProtocolError,
+                    Timeout::Error ].freeze
+
     def initialize(params = {})
     end
 
@@ -8,20 +19,17 @@ module Errplane
       data = black_box.to_json
       response = begin
                    url = "/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/#{Errplane.configuration.rails_environment}#{"/deploy" if deployment}?api_key=#{Errplane.configuration.api_key}"
-                   Errplane.configuration.logger.info("\nURL: #{url}") if Errplane.configuration.debug?
-                   Errplane.configuration.logger.info("\nData: #{data.inspect}") if Errplane.configuration.debug?
-                   response = http.post(url, data)
-                   Errplane.configuration.logger.info("\nException Response: #{response.inspect}") if Errplane.configuration.debug?
-                   response
-                 rescue Exception => e
-                   # e
+                   log :info, "URL: #{url}"
+                   log :info, "Data: #{data.inspect}"
+                   http.post(url, data)
+                 rescue *HTTP_ERRORS => e
+                   log :error, "HTTP error contacting Errplane API! #{e.class}: #{e.message}"
                  end
 
-      case response
-      when Net::HTTPSuccess
-        # Success
+      if response.is_a?(Net::HTTPSuccess)
+        log :info, "Request Succeeded: #{response.inspect}"
       else
-        # Failure
+        log :error, "Request Failed: #{response.inspect}"
       end
     end
 

data/lib/errplane/version.rb

@@ -1,3 +1,3 @@
 module Errplane
-  VERSION = "0.3.7"
+  VERSION = "0.4.0"
 end

data/lib/rails/generators/errplane/templates/initializer.rb

@@ -1,7 +1,4 @@
 Errplane.configure do |config|
   config.api_key = "<%= api_key %>"
   config.application_id = "<%= application_id %>"
-  #uncomment this if you want to push rails logs to errplane also
-  #config.syslogd_port = "<%= Errplane.configuration.get_logport %>"
 end
-

data/spec/app/rails2.rb

@@ -0,0 +1,38 @@
+RAILS_ROOT = File.dirname(__FILE__)
+
+module Rails
+  class << self
+    def vendor_rails?; return false; end
+  end
+end
+
+Rails::Initializer.run do |config|
+  # config.time_zone = 'UTC'
+  # config.cache_classes = true
+  # config.whiny_nils = true
+  # config.action_controller.consider_all_requests_local = true
+  # config.action_controller.perform_caching             = false
+  # config.action_view.cache_template_loading            = true
+  # config.action_controller.allow_forgery_protection    = false
+  # config.action_mailer.delivery_method = :test
+  config.frameworks = [ :action_controller, :active_resource ]
+  config.action_controller.session = { :key => "_myapp_session", :secret => "1234567890abcdef1234567890abcdef" }
+end
+
+ActionController::Base.cookie_verifier_secret = '1234567890abcdef1234567890abcdef'
+ActionController::Base.session = {
+  :key         => '_myapp_session',
+  :secret      => '1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef'
+}
+
+Errplane.configure do |config|
+  config.api_key = "f123-e456-d789c012"
+  config.application_id = "b12r8c72"
+  config.ignored_environments = []
+end
+
+class ApplicationController < ActionController::Base; end
+class WidgetsController < ApplicationController
+  def index; render :nothing => true; end
+  def new; return 1/0; end
+end

data/spec/app/{rails.rb → rails3.rb}

@@ -15,9 +15,6 @@ end
 Errplane.configure do |config|
   config.api_key = "f123-e456-d789c012"
   config.application_id = "b12r8c72"
-  config.logger = Logger.new(STDOUT)
-  config.debug = true
-  config.ignored_environments = []
 end
 
 class ApplicationController < ActionController::Base; end

data/spec/integration/exceptions_spec.rb

@@ -1,24 +1,42 @@
-require File.dirname(__FILE__) + "/integration_helper"
+require File.expand_path(File.dirname(__FILE__) + "/integration_helper")
 
-feature "exception handling" do
+describe "exception handling" do
   before do
     Errplane.configure do |config|
       config.ignored_environments = %w{development}
     end
+
+    FakeWeb.last_request = nil
+    FakeWeb.clean_registry
+    @request_path = "/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    @request_url = "http://api.errplane.com#{@request_path}"
+    FakeWeb.register_uri(:post, @request_url, :body => "", :status => ["200", "OK"])
   end
 
   describe "in an action that raises an exception" do
-    scenario "should make an HTTP call to the API" do
-      stub_request(:post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012").to_return(status: 200)
-      visit new_widget_path
-      assert_requested :post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    it "should make an HTTP call to the API" do
+      get "/widgets/new"
+      FakeWeb.last_request.should_not be_nil
+      FakeWeb.last_request.path.should == @request_path
+      FakeWeb.last_request.method.should == "POST"
     end
   end
 
   describe "in an action that does not raise an exception" do
-    scenario "should not make an HTTP call to the API" do
-      visit widgets_path
-      assert_not_requested :post, "#{Errplane.configuration.api_host}/api/v1/applications/#{Errplane.configuration.application_id}/exceptions/test?api_key=f123-e456-d789c012"
+    it "should not make an HTTP call to the API" do
+      get "/widgets"
+      FakeWeb.last_request.should be_nil
+    end
+  end
+
+  describe "for an ignored user agent" do
+    it "should not make an HTTP call to the API" do
+      Errplane.configure do |config|
+        config.ignored_user_agents = %w{Googlebot}
+      end
+      get "/widgets/new", {}, { "HTTP_USER_AGENT" => "Googlebot/2.1" }
+      FakeWeb.last_request.should be_nil
     end
   end
 end
+