errplane 0.5.5 → 0.5.6

data/.travis.yml

@@ -10,7 +10,6 @@ gemfile:
   - gemfiles/Gemfile.rails-3.2.x
   - gemfiles/Gemfile.rails-3.1.x
   - gemfiles/Gemfile.rails-3.0.x
-  - gemfiles/Gemfile.rails-2.3.x
 notifications:
   email:
     - mechanics@errplane.com

data/lib/errplane.rb

@@ -2,6 +2,7 @@ require "net/http"
 require "net/https"
 require "rubygems"
 require "socket"
+require "thread"
 
 require "json" unless Hash.respond_to?(:to_json)
 
@@ -15,12 +16,26 @@ require "errplane/rack"
 
 require "errplane/railtie" if defined?(Rails::Railtie)
 
+class SafeQueue < Queue
+  attr_accessor :max_depth
+
+  def initialize(max_depth = 10_000)
+    @max_depth = max_depth
+    super()
+  end
+
+  def push_safely(data)
+    push(data) if size < @max_depth
+  end
+end
+
 module Errplane
   class << self
     include Logger
 
     attr_writer :configuration
     attr_accessor :transmitter
+    attr_accessor :queue
 
     def configure(silent = false)
       yield(configuration)
@@ -31,8 +46,12 @@ module Errplane
       @configuration ||= Configuration.new
     end
 
+    def queue
+      @queue ||= SafeQueue.new(configuration.queue_maximum_depth)
+    end
+
     def report(name, params = {})
-      Errplane::Relay.queue.push({
+      Errplane.queue.push_safely({
         :name => name,
         :source => "custom",
         :timestamp => current_timestamp

data/lib/errplane/black_box.rb

@@ -42,6 +42,9 @@ module Errplane
 
       payload[:request_data] = request_data if @controller || @action || !@params.blank?
       payload[:hash] = hash if hash
+      if Errplane.configuration.aggregated_exception_classes.include?(@exception.class.to_s)
+        payload[:hash] = Digest::SHA1.hexdigest(@exception.class.to_s)
+      end
 
       payload.to_json
     end

data/lib/errplane/configuration.rb

@@ -17,7 +17,7 @@ module Errplane
     attr_accessor :ignored_environments
     attr_accessor :ignored_user_agents
     attr_accessor :backtrace_filters
-
+    attr_accessor :aggregated_exception_classes
     attr_accessor :environment_variables
 
     attr_accessor :instrumentation_enabled
@@ -26,7 +26,6 @@ module Errplane
 
     attr_accessor :queue_worker_threads
     attr_accessor :queue_worker_polling_interval
-    attr_accessor :queue_sweeper_polling_interval
     attr_accessor :queue_maximum_depth
     attr_accessor :queue_maximum_post
 
@@ -59,12 +58,12 @@ module Errplane
       @ignored_environments = DEFAULTS[:ignored_environments].dup
       @ignored_user_agents = DEFAULTS[:ignored_user_agents].dup
       @backtrace_filters = DEFAULTS[:backtrace_filters].dup
+      @aggregated_exception_classes = []
       @debug = false
       @rescue_global_exceptions = false
       @instrumentation_enabled = true
       @queue_worker_threads = 3
       @queue_worker_polling_interval = 5
-      @queue_sweeper_polling_interval = 0.25
       @queue_maximum_depth = 10_000
       @queue_maximum_post = 500
     end

data/lib/errplane/instrumentation.rb

@@ -4,18 +4,6 @@ require "uri"
 require "base64"
 
 module Errplane
-  class Relay
-    @@queue = Queue.new
-
-    def self.queue
-      return @@queue
-    end
-
-    def self.initialize
-      @@queue = Queue.new
-    end
-  end
-
   class Instrumentation
     class << self
       include Errplane::Logger
@@ -49,17 +37,6 @@ module Errplane
         end
       end
 
-      def spawn_sweeper_thread()
-        log :debug, "Spawning background sweeper thread."
-        Thread.new do
-          while true
-            sleep Errplane.configuration.queue_sweeper_polling_interval
-            while Errplane::Relay.queue.size > Errplane.configuration.queue_maximum_depth
-              Errplane::Relay.queue.pop
-            end
-          end
-        end
-      end
       def spawn_worker_threads()
         Errplane.configuration.queue_worker_threads.times do
           log :debug, "Spawning background worker thread."
@@ -69,9 +46,9 @@ module Errplane
               sleep Errplane.configuration.queue_worker_polling_interval
 
               data = [].tap do |line|
-                while !Errplane::Relay.queue.empty?
+                while !Errplane.queue.empty?
                   log :debug, "Found data in the queue."
-                  n = Errplane::Relay.queue.pop
+                  n = Errplane.queue.pop
 
                   begin
                     case n[:source]

data/lib/errplane/rails/instrumentation.rb

@@ -0,0 +1,28 @@
+module Errplane
+  module Rails
+    module Instrumentation
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def instrument(methods = [])
+          methods = [methods] unless methods.is_a?(Array)
+          methods.each do |method|
+            ::Rails.logger.debug "OVERRIDING METHOD: #{method}"
+
+            class_eval <<-EVAL_METHOD
+              def #{method}_with_instrumentation
+                Errplane.report(\"instrumentation/#{self.class}##{method}\")
+                #{method}_without_instrumentation
+              end
+            EVAL_METHOD
+
+            alias_method "#{method}_without_instrumentation", method
+            alias_method method, "#{method}_with_instrumentation"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/errplane/railtie.rb

@@ -100,30 +100,28 @@ module Errplane
         ::ActionDispatch::ShowExceptions.send(:include, Errplane::Rails::Middleware::HijackRenderException)
       end
 
-      if defined?(ActiveSupport::Notifications) && Errplane.configuration.instrumentation_enabled?
+      if defined?(ActiveSupport::Notifications)
         ActiveSupport::Notifications.subscribe do |name, start, finish, id, payload|
-          h = { :name => name,
-                :start => start,
-                :finish => finish,
-                :nid => id,
-                :payload => payload,
-                :source => "active_support"}
-          Errplane::Relay.queue.push h
+          if Errplane.configuration.instrumentation_enabled?
+            h = { :name => name,
+                  :start => start,
+                  :finish => finish,
+                  :nid => id,
+                  :payload => payload,
+                  :source => "active_support"}
+            Errplane.queue.push_safely(h)
+          end
         end
       end
 
       if defined?(PhusionPassenger)
         PhusionPassenger.on_event(:starting_worker_process) do |forked|
           if forked
-            Errplane::Relay.initialize
             Errplane::Instrumentation.spawn_worker_threads()
-            Errplane::Instrumentation.spawn_sweeper_thread()
           end
         end
       else
-        Errplane::Relay.initialize
         Errplane::Instrumentation.spawn_worker_threads()
-        Errplane::Instrumentation.spawn_sweeper_thread()
       end
     end
   end

data/lib/errplane/transmitter.rb

@@ -24,7 +24,7 @@ module Errplane
                     :url => url,
                     :source => "exception" }
 
-      Errplane::Relay.queue.push exception
+      Errplane.queue.push_safely(exception)
     end
 
     def deliver(data, url)

data/lib/errplane/version.rb

@@ -1,3 +1,3 @@
 module Errplane
-  VERSION = "0.5.5"
+  VERSION = "0.5.6"
 end

data/spec/integration/exceptions_spec.rb

@@ -4,6 +4,7 @@ describe "exception handling" do
   before do
     Errplane.configure do |config|
       config.ignored_environments = %w{development}
+      config.instrumentation_enabled = false
     end
 
     FakeWeb.last_request = nil
@@ -11,21 +12,22 @@ describe "exception handling" do
     @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"])
+
+    Errplane.queue.clear
   end
 
   describe "in an action that raises an exception" do
-    it "should make an HTTP call to the API" do
+    it "should add an exception to the queue" do
+      Errplane.queue.size.should be_zero
       get "/widgets/new"
-      FakeWeb.last_request.should_not be_nil
-      FakeWeb.last_request.path.should == @request_path
-      FakeWeb.last_request.method.should == "POST"
+      Errplane.queue.size.should == 1
     end
   end
 
   describe "in an action that does not raise an exception" do
-    it "should not make an HTTP call to the API" do
+    it "should not add anything to the queue" do
       get "/widgets"
-      FakeWeb.last_request.should be_nil
+      Errplane.queue.size.should be_zero
     end
   end
 
@@ -35,7 +37,7 @@ describe "exception handling" do
         config.ignored_user_agents = %w{Googlebot}
       end
       get "/widgets/new", {}, { "HTTP_USER_AGENT" => "Googlebot/2.1" }
-      FakeWeb.last_request.should be_nil
+      Errplane.queue.size.should be_zero
     end
   end
 end

data/spec/suite.sh

@@ -14,26 +14,25 @@ function build_version() {
   BUNDLE_GEMFILE=gemfiles/Gemfile.rails-$1 bundle exec rake -t spec
 }
 
-function versions() {
+function build_versions() {
   build_version "3.2.x"
   build_version "3.1.x"
   build_version "3.0.x"
-  build_version "2.3.x"
 }
 
-function use_ruby() {
+function build_with_ruby() {
   rvm use ruby-$1@errplane_gem --create
-  versions
+  build_versions
 }
 
-function run() {
-  use_ruby "1.9.3-p194"
-  use_ruby "1.9.2-p290"
-  use_ruby "1.8.7-p357"
+function build() {
+  build_with_ruby "1.9.3-p194"
+  build_with_ruby "1.9.2-p290"
+  build_with_ruby "1.8.7-p357"
 }
 
 function clean() {
   rvm gemset empty errplane_gem --force
 }
 
-run
+build

data/spec/unit/errplane_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 
 describe Errplane do
   before do
+    Errplane.configure { |config| config.ignored_environments = [] }
+
     FakeWeb.last_request = nil
     FakeWeb.clean_registry
 
@@ -34,17 +36,18 @@ describe Errplane do
 
   describe 'rescue' do
     it "should transmit an exception when passed" do
-      Errplane.configure { |config| config.ignored_environments = [] }
+      Errplane.queue.clear
 
-      FakeWeb.register_uri(:post, @request_url, :body => "", :status => ["200", "OK"])
+      Errplane.configure do |config|
+        config.ignored_environments = []
+        config.instrumentation_enabled = false
+      end
 
       Errplane.rescue do
         raise ArgumentError.new('wrong')
       end
 
-      FakeWeb.last_request.should_not be_nil
-      FakeWeb.last_request.method.should == "POST"
-      FakeWeb.last_request.path.should == @request_path
+      Errplane.queue.size.should == 1
     end
 
     it "should also raise the exception when in an ignored environment" do
@@ -59,20 +62,15 @@ describe Errplane do
   end
 
   describe "rescue_and_reraise" do
-    before do
-      Errplane.configure { |config| config.ignored_environments = [] }
-    end
-
     it "should transmit an exception when passed" do
-      FakeWeb.register_uri(:post, @request_url, :body => "", :status => ["200", "OK"])
+      Errplane.configure { |config| config.ignored_environments = [] }
+      Errplane.queue.clear
 
       expect {
         Errplane.rescue_and_reraise { raise ArgumentError.new('wrong') }
       }.to raise_error(ArgumentError)
 
-      FakeWeb.last_request.should_not be_nil
-      FakeWeb.last_request.method.should == "POST"
-      FakeWeb.last_request.path.should == @request_path
+      Errplane.queue.size.should == 1
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errplane
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.5.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70156446180960 !ruby/object:Gem::Requirement
+  requirement: &70113630104640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70156446180960
+  version_requirements: *70113630104640
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70156446180420 !ruby/object:Gem::Requirement
+  requirement: &70113630104100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70156446180420
+  version_requirements: *70113630104100
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70156446179840 !ruby/object:Gem::Requirement
+  requirement: &70113630103560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70156446179840
+  version_requirements: *70113630103560
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70156446174660 !ruby/object:Gem::Requirement
+  requirement: &70113630103020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70156446174660
+  version_requirements: *70113630103020
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70156446174100 !ruby/object:Gem::Requirement
+  requirement: &70113630095780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446174100
+  version_requirements: *70113630095780
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70156446173560 !ruby/object:Gem::Requirement
+  requirement: &70113630095220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446173560
+  version_requirements: *70113630095220
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70156446173020 !ruby/object:Gem::Requirement
+  requirement: &70113630094680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446173020
+  version_requirements: *70113630094680
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70156446172540 !ruby/object:Gem::Requirement
+  requirement: &70113630094140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446172540
+  version_requirements: *70113630094140
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70156446171940 !ruby/object:Gem::Requirement
+  requirement: &70113630093660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446171940
+  version_requirements: *70113630093660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70156446171220 !ruby/object:Gem::Requirement
+  requirement: &70113630093040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446171220
+  version_requirements: *70113630093040
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70156446170460 !ruby/object:Gem::Requirement
+  requirement: &70113630092320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156446170460
+  version_requirements: *70113630092320
 description: This gem provides exception reporting with Errplane for Rails 3.x applications.
 email:
 - todd@errplane.com
@@ -147,12 +147,9 @@ files:
 - Rakefile
 - config.ru
 - errplane.gemspec
-- gemfiles/Gemfile.rails-2.3.x
 - gemfiles/Gemfile.rails-3.0.x
 - gemfiles/Gemfile.rails-3.1.x
 - gemfiles/Gemfile.rails-3.2.x
-- generators/errplane/errplane_generator.rb
-- generators/errplane/templates/initializer.rb
 - lib/errplane.rb
 - lib/errplane/backtrace.rb
 - lib/errplane/black_box.rb
@@ -163,6 +160,7 @@ files:
 - lib/errplane/rack.rb
 - lib/errplane/rails.rb
 - lib/errplane/rails/air_traffic_controller.rb
+- lib/errplane/rails/instrumentation.rb
 - lib/errplane/rails/middleware/hijack_render_exception.rb
 - lib/errplane/rails/middleware/hijack_rescue_action_everywhere.rb
 - lib/errplane/railtie.rb
@@ -172,23 +170,11 @@ files:
 - lib/errplane/version.rb
 - lib/rails/generators/errplane/errplane_generator.rb
 - lib/rails/generators/errplane/templates/initializer.rb
-- rails/init.rb
 - spec/controllers/widgets_controller_spec.rb
 - spec/integration/exceptions_spec.rb
 - spec/integration/integration_helper.rb
 - spec/spec_helper.rb
 - spec/suite.sh
-- spec/support/rails2/app/controllers/application_controller.rb
-- spec/support/rails2/app/controllers/widgets_controller.rb
-- spec/support/rails2/app/helpers/application_helper.rb
-- spec/support/rails2/app/helpers/widgets_helper.rb
-- spec/support/rails2/config/environment.rb
-- spec/support/rails2/config/environments/test.rb
-- spec/support/rails2/config/initializers/cookie_verification_secret.rb
-- spec/support/rails2/config/initializers/errplane.rb
-- spec/support/rails2/config/initializers/new_rails_defaults.rb
-- spec/support/rails2/config/initializers/session_store.rb
-- spec/support/rails2/config/routes.rb
 - spec/support/rails3/app.rb
 - spec/unit/backtrace_spec.rb
 - spec/unit/black_box_spec.rb
@@ -225,17 +211,6 @@ test_files:
 - spec/integration/integration_helper.rb
 - spec/spec_helper.rb
 - spec/suite.sh
-- spec/support/rails2/app/controllers/application_controller.rb
-- spec/support/rails2/app/controllers/widgets_controller.rb
-- spec/support/rails2/app/helpers/application_helper.rb
-- spec/support/rails2/app/helpers/widgets_helper.rb
-- spec/support/rails2/config/environment.rb
-- spec/support/rails2/config/environments/test.rb
-- spec/support/rails2/config/initializers/cookie_verification_secret.rb
-- spec/support/rails2/config/initializers/errplane.rb
-- spec/support/rails2/config/initializers/new_rails_defaults.rb
-- spec/support/rails2/config/initializers/session_store.rb
-- spec/support/rails2/config/routes.rb
 - spec/support/rails3/app.rb
 - spec/unit/backtrace_spec.rb
 - spec/unit/black_box_spec.rb

data/gemfiles/Gemfile.rails-2.3.x

@@ -1,8 +0,0 @@
-source :rubygems
-
-gem 'rails', '~> 2.3.14'
-gem 'rspec', '~> 1.3'
-gem 'rspec-rails', '~> 1.3'
-gem 'test-unit', "1.2.3"
-
-gemspec :path => '../'

data/generators/errplane/errplane_generator.rb

@@ -1,24 +0,0 @@
-class ErrplaneGenerator < Rails::Generator::Base
-  def add_options!(option)
-    option.on("-k", "--api-key=API_KEY", String, "API key for your Errplane organization") {|v| options[:api_key] = v}
-    option.on("-a", "--application-id=APP_ID", String, "Your Errplane application id (optional)") {|v| options[:application_id] = v}
-  end
-
-  def manifest
-    if options[:api_key].blank?
-      puts "You must provide an API key using -k or --api-key."
-      exit
-    end
-    record do |m|
-      m.template "initializer.rb", "config/initializers/errplane.rb",
-        :assigns => {
-          :application_id => options[:application_id] || secure_random.hex(4),
-          :api_key => options[:api_key]
-        }
-    end
-  end
-
-  def secure_random
-    defined?(SecureRandom) ? SecureRandom : ActiveSupport::SecureRandom
-  end
-end

data/generators/errplane/templates/initializer.rb

@@ -1,6 +0,0 @@
-require "errplane"
-
-Errplane.configure do |config|
-  config.api_key = "<%= api_key %>"
-  config.application_id = "<%= application_id %>"
-end

data/rails/init.rb

@@ -1 +0,0 @@
-require "errplane/rails"

data/spec/support/rails2/app/controllers/application_controller.rb

@@ -1,4 +0,0 @@
-class ApplicationController < ActionController::Base
-  helper :all
-  protect_from_forgery
-end

data/spec/support/rails2/app/controllers/widgets_controller.rb

@@ -1,4 +0,0 @@
-class WidgetsController < ApplicationController
-  def index; render :nothing => true; end
-  def new; return 1/0; end
-end

data/spec/support/rails2/app/helpers/application_helper.rb

@@ -1,2 +0,0 @@
-module ApplicationHelper
-end

data/spec/support/rails2/app/helpers/widgets_helper.rb

@@ -1,2 +0,0 @@
-module WidgetsHelper
-end

data/spec/support/rails2/config/environment.rb

@@ -1,4 +0,0 @@
-Rails::Initializer.run do |config|
-  config.frameworks -= [ :active_record, :active_resource, :action_mailer ]
-  config.time_zone = 'UTC'
-end

data/spec/support/rails2/config/initializers/cookie_verification_secret.rb

@@ -1 +0,0 @@
-ActionController::Base.cookie_verifier_secret = '171a91942320ec70c77a53d50cf62835b06a9e9e3ee8e9f045d4fe195965b9d5b30ceed7570ac6d77c20ca561229625be0cf987e8342b14f499033a271480970';

data/spec/support/rails2/config/initializers/errplane.rb

@@ -1,6 +0,0 @@
-Errplane.configure do |config|
-  config.api_key = "f123-e456-d789c012"
-  config.application_id = "b12r8c72"
-end
-
-MissingSourceFile::REGEXPS << [/^cannot load such file -- (.+)$/i, 1]

data/spec/support/rails2/config/initializers/new_rails_defaults.rb

@@ -1,8 +0,0 @@
-if defined?(ActiveRecord)
-  ActiveRecord::Base.include_root_in_json = true
-  ActiveRecord::Base.store_full_sti_class = true
-end
-
-ActionController::Routing.generate_best_match = false
-ActiveSupport.use_standard_json_time_format = true
-ActiveSupport.escape_html_entities_in_json = false

data/spec/support/rails2/config/initializers/session_store.rb

@@ -1,4 +0,0 @@
-ActionController::Base.session = {
-  :key         => '_rails-2.3_session',
-  :secret      => '76cc9f32d38e9b6227bd663076edcf28cc915dc3021da204763a73dbd0d2741f6f7074af21400d4f8f9ef6c4db72487c467edf4a1dfec732835c5674a9846dd7'
-}

data/spec/support/rails2/config/routes.rb

@@ -1,3 +0,0 @@
-ActionController::Routing::Routes.draw do |map|
-  map.resources :widgets
-end