errplane 0.5.6 → 0.5.7

data/lib/errplane.rb

@@ -9,26 +9,15 @@ require "json" unless Hash.respond_to?(:to_json)
 require "errplane/version"
 require "errplane/logger"
 require "errplane/black_box"
+require "errplane/max_queue"
 require "errplane/configuration"
 require "errplane/transmitter"
 require "errplane/backtrace"
+require "errplane/worker"
 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
@@ -47,11 +36,11 @@ module Errplane
     end
 
     def queue
-      @queue ||= SafeQueue.new(configuration.queue_maximum_depth)
+      @queue ||= MaxQueue.new(configuration.queue_maximum_depth)
     end
 
     def report(name, params = {})
-      Errplane.queue.push_safely({
+      Errplane.queue.push_or_discard({
         :name => name,
         :source => "custom",
         :timestamp => current_timestamp
@@ -140,10 +129,10 @@ module Errplane
       e = e.continued_exception if e.respond_to?(:continued_exception)
       e = e.original_exception if e.respond_to?(:original_exception)
       opts = opts.merge(:exception => e)
+      opts[:environment_variables] = ENV.to_hash if configuration.include_environment_variables?
       black_box = BlackBox.new(opts)
     end
   end
 end
 
-require "errplane/instrumentation"
 require "errplane/sinatra" if defined?(Sinatra::Request)

data/lib/errplane/black_box.rb

@@ -19,6 +19,7 @@ module Errplane
       @request_url = params[:request_url]
       @user_agent = params[:user_agent]
       @custom_data = params[:custom_data] || {}
+      @environment_variables = params[:environment_variables] || {}
     end
 
     def to_json
@@ -33,10 +34,10 @@ module Errplane
         :exception_class => @exception.class.to_s,
         :language => "Ruby",
         :language_version => "#{RUBY_VERSION}-p#{RUBY_PATCHLEVEL}",
-        :environment_variables => ENV.to_hash,
         :reporter => reporter,
         :custom_data => @custom_data
       }
+      payload[:environment_variables] = @environment_variables
 
       Errplane.configuration.add_custom_exception_data(self)
 

data/lib/errplane/configuration.rb

@@ -19,6 +19,7 @@ module Errplane
     attr_accessor :backtrace_filters
     attr_accessor :aggregated_exception_classes
     attr_accessor :environment_variables
+    attr_writer   :include_environment_variables
 
     attr_accessor :instrumentation_enabled
     attr_accessor :debug
@@ -36,6 +37,7 @@ module Errplane
                                 ActionController::RoutingError},
       :ignored_environments => %w{test cucumber selenium},
       :ignored_user_agents => %w{GoogleBot},
+      :include_environment_variables => false,
       :backtrace_filters => [
         lambda { |line| line.gsub(/^\.\//, "") },
         lambda { |line|
@@ -58,6 +60,7 @@ module Errplane
       @ignored_environments = DEFAULTS[:ignored_environments].dup
       @ignored_user_agents = DEFAULTS[:ignored_user_agents].dup
       @backtrace_filters = DEFAULTS[:backtrace_filters].dup
+      @include_environment_variables = DEFAULTS[:include_environment_variables]
       @aggregated_exception_classes = []
       @debug = false
       @rescue_global_exceptions = false
@@ -72,6 +75,10 @@ module Errplane
       !!@debug
     end
 
+    def include_environment_variables?
+      @include_environment_variables
+    end
+
     def instrumentation_enabled?
       !!@instrumentation_enabled
     end

data/lib/errplane/max_queue.rb

@@ -0,0 +1,14 @@
+module Errplane
+  class MaxQueue < Queue
+    attr_accessor :max_depth
+
+    def initialize(max_depth = 10_000)
+      @max_depth = max_depth
+      super()
+    end
+
+    def push_or_discard(data)
+      push(data) if size < @max_depth
+    end
+  end
+end

data/lib/errplane/railtie.rb

@@ -109,19 +109,17 @@ module Errplane
                   :nid => id,
                   :payload => payload,
                   :source => "active_support"}
-            Errplane.queue.push_safely(h)
+            Errplane.queue.push_or_discard(h)
           end
         end
       end
 
       if defined?(PhusionPassenger)
         PhusionPassenger.on_event(:starting_worker_process) do |forked|
-          if forked
-            Errplane::Instrumentation.spawn_worker_threads()
-          end
+          Errplane::Worker.spawn_threads() if forked
         end
       else
-        Errplane::Instrumentation.spawn_worker_threads()
+        Errplane::Worker.spawn_threads()
       end
     end
   end

data/lib/errplane/transmitter.rb

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

data/lib/errplane/version.rb

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

data/lib/errplane/{instrumentation.rb → worker.rb}

@@ -4,7 +4,7 @@ require "uri"
 require "base64"
 
 module Errplane
-  class Instrumentation
+  class Worker
     class << self
       include Errplane::Logger
 
@@ -37,7 +37,7 @@ module Errplane
         end
       end
 
-      def spawn_worker_threads()
+      def spawn_threads()
         Errplane.configuration.queue_worker_threads.times do
           log :debug, "Spawning background worker thread."
           Thread.new do

data/spec/spec_helper.rb

@@ -2,23 +2,7 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 ENV["RAILS_ENV"] ||= "test"
 
-require 'rails/version'
-
-if Rails::VERSION::MAJOR > 2
-  require 'rails'
-else
-  module Rails
-    class << self
-      def vendor_rails?; return false; end
-    end
-
-    class Configuration
-      def after_initialize; end
-    end
-    @@configuration = Configuration.new
-  end
-  require 'initializer'
-end
+require 'rails'
 
 require 'bundler/setup'
 Bundler.require
@@ -29,16 +13,9 @@ FakeWeb.allow_net_connect = false
 if defined? Rails
   puts "Loading Rails v#{Rails.version}..."
 
-  if Rails.version.to_f < 3.0
-    RAILS_ROOT = "#{File.dirname(__FILE__)}/support/rails2"
-    require "#{RAILS_ROOT}/config/environment"
-    require "spec/rails"
-  else
-    require "support/rails3/app"
-    require "rspec/rails"
-  end
-end
-
-if defined? Sinatra
-  require 'spec_helper_for_sinatra'
+  require "support/rails3/app"
+  require "rspec/rails"
+else
+  puts "ERROR: Rails could not be loaded."
+  exit
 end

data/spec/unit/max_queue_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Errplane::MaxQueue do
+  it "should inherit from Queue" do
+    Errplane::MaxQueue.new.should be_a(Queue)
+  end
+
+  context "#new" do
+    it "should allow max_depth to be set" do
+      queue = Errplane::MaxQueue.new(500)
+      queue.max_depth.should == 500
+    end
+  end
+
+  context "#push_or_discard" do
+    it "should allow an item to be added if the queue is not full" do
+      queue = Errplane::MaxQueue.new(5)
+      queue.size.should be_zero
+      queue.push_or_discard(1)
+      queue.size.should == 1
+    end
+
+    it "should not allow items to be added if the queue is full" do
+      queue = Errplane::MaxQueue.new(5)
+      queue.size.should be_zero
+      5.times { |n| queue.push_or_discard(n) }
+      queue.size.should == 5
+      queue.push_or_discard(6)
+      queue.size.should == 5
+    end
+  end
+end

data/spec/unit/transmitter_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Errplane::Transmitter do
+end

data/spec/unit/worker_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Errplane::Worker do
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errplane
 version: !ruby/object:Gem::Version
-  version: 0.5.6
+  version: 0.5.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2012-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70113630104640 !ruby/object:Gem::Requirement
+  requirement: &70239459114500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70113630104640
+  version_requirements: *70239459114500
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70113630104100 !ruby/object:Gem::Requirement
+  requirement: &70239459113860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70113630104100
+  version_requirements: *70239459113860
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70113630103560 !ruby/object:Gem::Requirement
+  requirement: &70239459113180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70113630103560
+  version_requirements: *70239459113180
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70113630103020 !ruby/object:Gem::Requirement
+  requirement: &70239459112620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70113630103020
+  version_requirements: *70239459112620
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70113630095780 !ruby/object:Gem::Requirement
+  requirement: &70239459112020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630095780
+  version_requirements: *70239459112020
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70113630095220 !ruby/object:Gem::Requirement
+  requirement: &70239459111420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630095220
+  version_requirements: *70239459111420
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70113630094680 !ruby/object:Gem::Requirement
+  requirement: &70239459110840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630094680
+  version_requirements: *70239459110840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70113630094140 !ruby/object:Gem::Requirement
+  requirement: &70239459110220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630094140
+  version_requirements: *70239459110220
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70113630093660 !ruby/object:Gem::Requirement
+  requirement: &70239459109640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630093660
+  version_requirements: *70239459109640
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70113630093040 !ruby/object:Gem::Requirement
+  requirement: &70239459108840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630093040
+  version_requirements: *70239459108840
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70113630092320 !ruby/object:Gem::Requirement
+  requirement: &70239459107980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70113630092320
+  version_requirements: *70239459107980
 description: This gem provides exception reporting with Errplane for Rails 3.x applications.
 email:
 - todd@errplane.com
@@ -155,8 +155,8 @@ files:
 - lib/errplane/black_box.rb
 - lib/errplane/capistrano.rb
 - lib/errplane/configuration.rb
-- lib/errplane/instrumentation.rb
 - lib/errplane/logger.rb
+- lib/errplane/max_queue.rb
 - lib/errplane/rack.rb
 - lib/errplane/rails.rb
 - lib/errplane/rails/air_traffic_controller.rb
@@ -168,6 +168,7 @@ files:
 - lib/errplane/sinatra.rb
 - lib/errplane/transmitter.rb
 - lib/errplane/version.rb
+- lib/errplane/worker.rb
 - lib/rails/generators/errplane/errplane_generator.rb
 - lib/rails/generators/errplane/templates/initializer.rb
 - spec/controllers/widgets_controller_spec.rb
@@ -180,6 +181,9 @@ files:
 - spec/unit/black_box_spec.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/errplane_spec.rb
+- spec/unit/max_queue_spec.rb
+- spec/unit/transmitter_spec.rb
+- spec/unit/worker_spec.rb
 homepage: http://errplane.com
 licenses:
 - MIT
@@ -201,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: errplane
-rubygems_version: 1.8.15
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Rails exception reporting for Errplane.
@@ -216,3 +220,6 @@ test_files:
 - spec/unit/black_box_spec.rb
 - spec/unit/configuration_spec.rb
 - spec/unit/errplane_spec.rb
+- spec/unit/max_queue_spec.rb
+- spec/unit/transmitter_spec.rb
+- spec/unit/worker_spec.rb