errplane 0.4.12 → 0.5.0

data/README.md

@@ -21,7 +21,7 @@ Start by adding the gem to your Gemfile:
 Then, issue the following commands in your application's root directory:
 
     bundle
-    rails g errplane --api-key your-api-key-goes-here
+    rails g errplane your-api-key-goes-here
 
 This will create `config/initializers/errplane.rb` for you automatically. If you want to make sure that everything's working correctly, just run:
 

data/Rakefile

@@ -3,7 +3,6 @@
 if ENV["BUNDLE_GEMFILE"] == File.expand_path("Gemfile")
   ENV["BUNDLE_GEMFILE"] = "gemfiles/Gemfile.rails-3.2.x"
 end
-puts "RAKEFILE"
 
 require 'bundler'
 Bundler::GemHelper.install_tasks

data/lib/errplane.rb

@@ -1,6 +1,7 @@
-require 'net/http'
-require 'net/https'
-require 'rubygems'
+require "net/http"
+require "net/https"
+require "rubygems"
+require "socket"
 
 require "json" unless Hash.respond_to?(:to_json)
 
@@ -30,6 +31,32 @@ module Errplane
       @configuration ||= Configuration.new
     end
 
+    def report(name, params = {})
+      Errplane::Relay.queue.push({
+        :name => name,
+        :source => "custom",
+        :timestamp => current_timestamp
+      }.merge(params))
+    end
+
+    def heartbeat(name, interval)
+      log :debug, "Starting heartbeat '#{name}' on a #{interval} second interval."
+      Thread.new do
+        while true do
+          log :debug, "Sleeping '#{name}' for #{interval} seconds."
+          sleep(interval)
+          report(name)
+        end
+      end
+    end
+
+    def time(name = nil)
+      start_time = Time.now
+      yield
+      elapsed_time = Time.now - start_time
+      report("timed_blocks/#{(name || Socket.gethostname)}", :value => (elapsed_time*1000).ceil)
+    end
+
     def transmit_unless_ignorable(e, env)
       begin
         black_box = assemble_black_box_for(e, env)
@@ -61,6 +88,10 @@ module Errplane
       end
     end
 
+    def current_timestamp
+      Time.now.utc.to_i
+    end
+
     def ignorable_exception?(e)
       configuration.ignore_current_environment? || configuration.ignored_exceptions.include?(e.class.to_s)
     end
@@ -95,4 +126,5 @@ module Errplane
   end
 end
 
+require "errplane/instrumentation"
 require "errplane/sinatra" if defined?(Sinatra::Request)

data/lib/errplane/black_box.rb

@@ -40,7 +40,7 @@ module Errplane
 
       Errplane.configuration.add_custom_exception_data(self)
 
-      payload[:request_data] = request_data if @controller || @action || !params.empty?
+      payload[:request_data] = request_data if @controller || @action || !@params.blank?
       payload[:hash] = hash if hash
 
       payload.to_json

data/lib/errplane/configuration.rb

@@ -20,6 +20,7 @@ module Errplane
 
     attr_accessor :environment_variables
 
+    attr_accessor :instrumentation_enabled
     attr_accessor :debug
     attr_accessor :reraise_global_exceptions
 
@@ -54,12 +55,17 @@ module Errplane
       @backtrace_filters = DEFAULTS[:backtrace_filters].dup
       @debug = false
       @rescue_global_exceptions = false
+      @instrumentation_enabled = true
     end
 
     def debug?
       !!@debug
     end
 
+    def instrumentation_enabled?
+      !!@instrumentation_enabled
+    end
+
     def reraise_global_exceptions?
       !!@reraise_global_exceptions
     end

data/lib/errplane/instrumentation.rb

@@ -0,0 +1,101 @@
+require 'thread'
+require "net/http"
+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
+
+      def indent_lines(lines, num)
+        lines.split("\n").map {|line| (" " * num) + line}.join("\n")
+      end
+
+      def post_data(data)
+        if Errplane.configuration.ignore_current_environment?
+          log :debug, "Current environment is ignored, skipping POST."
+        else
+          log :info, "Posting data:\n#{indent_lines(data, 13)}"
+          http = Net::HTTP.new("api1.errplane.com", "8086")
+          url = "/api/v2/time_series/applications/#{Errplane.configuration.application_id}/environments/#{Errplane.configuration.rails_environment}?api_key=ignored"
+          response = http.post(url, data)
+          log :info, "Posting to: #{url}"
+          log :info, "Response code: #{response.code}"
+        end
+      end
+
+      def spawn_thread()
+        Thread.new do
+          log :debug, "Spawning background thread."
+          while true
+            log :debug, "Checking background queue."
+            sleep 5
+            begin
+              data = [].tap do |line|
+                while !Errplane::Relay.queue.empty?
+                  log :debug, "Found data in the queue."
+                  n = Errplane::Relay.queue.pop
+
+                  case n[:source]
+                  when "active_support"
+                    case n[:name].to_s
+                    when "process_action.action_controller"
+                      timediff = n[:finish] - n[:start]
+                      line << "controllers/#{n[:payload][:controller]}/#{n[:payload][:action]} #{(timediff*1000).ceil} #{n[:finish].utc.to_i}"
+                      line << "views #{n[:payload][:view_runtime].ceil} #{n[:finish].utc.to_i }"
+                      line << "db #{n[:payload][:db_runtime].ceil} #{n[:finish].utc.to_i }"
+                    end
+                  when "custom"
+                    s = "#{n[:name]} #{n[:value] || 1} #{n[:timestamp]}"
+                    s << " #{Base64.encode64(n[:message])}" if n[:message]
+                    line << s
+                  end
+                end
+              end
+              post_data(data.join("\n")) unless data.empty?
+            rescue => e
+              log :info, "Instrumentation Error! #{e.inspect}"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  if defined?(ActiveSupport::Notifications) #&& Errplane.configuration.instrumentation_enabled?
+    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
+    end
+  end
+
+  if defined?(PhusionPassenger)
+    PhusionPassenger.on_event(:starting_worker_process) do |forked|
+      if forked
+        Errplane::Relay.initialize
+        Errplane::Instrumentation.spawn_thread()
+      end
+    end
+  else
+    Errplane::Relay.initialize
+    Errplane::Instrumentation.spawn_thread()
+  end
+end

data/lib/errplane/rails/air_traffic_controller.rb

@@ -2,8 +2,12 @@ module Errplane
   module Rails
     module AirTrafficController
       def errplane_request_data
+        use_params = params.to_hash
+        if respond_to?(:filter_parameters)
+          use_params = filter_parameters(use_params)
+        end
         {
-          :params => params.to_hash,
+          :params => use_params,
           :session_data => errplane_session_data,
           :controller => params[:controller],
           :action => params[:action],

data/lib/errplane/railtie.rb

@@ -42,7 +42,13 @@ module Errplane
           response = ::Rails.application.call(env)
 
           if response.try(:first) == 500
-            puts "Done. Check your email or http://errplane.com for the exception notice."
+            if Errplane.transmitter.last_response.nil?
+              puts "Uh oh. Your app threw an exception, but we didn't get a response. Check your network connection and try again."
+            elsif Errplane.transmitter.last_response.code == "201"
+              puts "Done. Check your email or http://errplane.com for the exception notice."
+            else
+              puts "That didn't work. The Errplane API said: #{Errplane.transmitter.last_response.body}"
+            end
           else
             puts "Request failed: #{response}"
 
@@ -51,7 +57,13 @@ module Errplane
             response = ::Rails.application.call(env)
 
             if response.try(:first) == 500
-              puts "Done. Check your email or http://errplane.com for the exception notice."
+              if Errplane.transmitter.last_response.nil?
+                puts "Uh oh. Your app threw an exception, but we didn't get a response. Check your network connection and try again."
+              elsif Errplane.transmitter.last_response.code == "201"
+                puts "Done. Check your email or http://errplane.com for the exception notice."
+              else
+                puts "That didn't work. The Errplane API said: #{Errplane.transmitter.last_response.body}"
+              end
             else
               puts "Request failed: #{response}"
               puts "We didn't get the exception we were expecting. Contact support@errplane.com and send them all of this output."

data/lib/errplane/transmitter.rb

@@ -2,6 +2,8 @@ module Errplane
   class Transmitter
     include Errplane::Logger
 
+    attr_reader :last_response
+
     HTTP_ERRORS = [ EOFError,
                     Errno::ECONNREFUSED,
                     Errno::ECONNRESET,
@@ -12,6 +14,7 @@ module Errplane
                     Timeout::Error ].freeze
 
     def initialize(params = {})
+      @last_response = nil
     end
 
     def relay(black_box, deployment = false)
@@ -26,6 +29,7 @@ module Errplane
                    log :error, "HTTP error contacting Errplane API! #{e.class}: #{e.message}"
                  end
 
+      @last_response = response
       if response.is_a?(Net::HTTPSuccess)
         log :info, "Request Succeeded: #{response.inspect}"
       else

data/lib/errplane/version.rb

@@ -1,3 +1,3 @@
 module Errplane
-  VERSION = "0.4.12"
+  VERSION = "0.5.0"
 end

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 ENV["RAILS_ENV"] ||= "test"
 
-puts "CALLING"
 require 'rails/version'
 
 if Rails::VERSION::MAJOR > 2

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: errplane
 version: !ruby/object:Gem::Version
-  version: 0.4.12
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-06 00:00:00.000000000 Z
+date: 2012-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70275484338460 !ruby/object:Gem::Requirement
+  requirement: &70165371262220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70275484338460
+  version_requirements: *70165371262220
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70275484337800 !ruby/object:Gem::Requirement
+  requirement: &70165371261120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70275484337800
+  version_requirements: *70165371261120
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70275484337140 !ruby/object:Gem::Requirement
+  requirement: &70165371260600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: 2.3.14
   type: :runtime
   prerelease: false
-  version_requirements: *70275484337140
+  version_requirements: *70165371260600
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70275484336380 !ruby/object:Gem::Requirement
+  requirement: &70165371259960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70275484336380
+  version_requirements: *70165371259960
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70275484335580 !ruby/object:Gem::Requirement
+  requirement: &70165371259200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484335580
+  version_requirements: *70165371259200
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70275484335060 !ruby/object:Gem::Requirement
+  requirement: &70165371258360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484335060
+  version_requirements: *70165371258360
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70275484334340 !ruby/object:Gem::Requirement
+  requirement: &70165371257800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484334340
+  version_requirements: *70165371257800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70275484349900 !ruby/object:Gem::Requirement
+  requirement: &70165371257320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484349900
+  version_requirements: *70165371257320
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70275484349140 !ruby/object:Gem::Requirement
+  requirement: &70165371256800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484349140
+  version_requirements: *70165371256800
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70275484348380 !ruby/object:Gem::Requirement
+  requirement: &70165371256240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -120,10 +120,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484348380
+  version_requirements: *70165371256240
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70275484347640 !ruby/object:Gem::Requirement
+  requirement: &70165371255740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -131,7 +131,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70275484347640
+  version_requirements: *70165371255740
 description: This gem provides exception reporting with Errplane for Rails 3.x applications.
 email:
 - todd@errplane.com
@@ -159,6 +159,7 @@ files:
 - lib/errplane/capistrano.rb
 - lib/errplane/configuration.rb
 - lib/errplane/errplane_chef_handler.rb
+- lib/errplane/instrumentation.rb
 - lib/errplane/logger.rb
 - lib/errplane/rack.rb
 - lib/errplane/rails.rb