errlog 0.2.3 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65181ee001218bc27b39fad26a4d7ae78dbcd476
-  data.tar.gz: a8e2ad45e7a803b646c0dd373121bae6993330ac
+  metadata.gz: 742e90a6c45ef372d95f07e88a6842095748d109
+  data.tar.gz: 515ee1ca2103aee10a0fec3036dba273f62f9bd3
 SHA512:
-  metadata.gz: b08bb5fd56db25996b049920aa008179bbf4aa19483797d0cdc46d80d02426be77bf7c29401fa603ad301de9cf1b13e355ffe61c3a1bf3da418ffd98b28e7ebd
-  data.tar.gz: 4973a36a2aa8f8ef7ead6f0520cb901721d31081e4cf841f1b46492579fba7e5eb2cc0d3d1cda852bf16d249aa8bbe4e128e9e85500f397799f7a06849c7be6e
+  metadata.gz: 5e7ed76719a32f26a44ba923c456e100203c3b772d9f66fb423c92b59d65a19498920c50399302e0af96b857869c351f691552543447ccfbaff2432b26ca6219
+  data.tar.gz: 12be1679456863fa78013bdf145e3bafe0394e1b27f94ec2abfaa48200669d0c124fafc90e4127a62a613562221e01b31e5bbdab8af0086d0c1bbc6e220f5eae

data/bin/errlogr

@@ -66,7 +66,7 @@ begin
         id = ARGV[n]
         n += 1
       when /^--local/
-        host = "http://localhost:3000"
+        host = "http://localhost:8080"
       when /^--warn/
         severity = Errlog::WARNING
       when /^--trace/

data/errlog.gemspec

@@ -22,7 +22,8 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'boss-protocol', '>= 0.1.3'
   gem.add_dependency 'hashie', '>= 1.2.0'
-  gem.add_dependency 'httpclient', '>= 2.3'
+  gem.add_dependency 'httpclient', '>= 2.3.3'
+  gem.add_dependency 'httpclient-uploadio', '>=1.0'
   gem.add_dependency 'colorize'
   gem.add_development_dependency "rspec"
 end

data/lib/errlog.rb

@@ -8,6 +8,8 @@ require 'hashie'
 require 'thread'
 require 'httpclient'
 require 'weakref'
+require 'stringio'
+require 'httpclient/uploadio'
 
 if defined?(Rails)
   require 'errlog/rails_controller_extensions'
@@ -32,21 +34,53 @@ module Errlog
     return Packager.new id, key
   end
 
+  @@configured = false
+
   def self.configure id, key, opts={}
+    @@configured                     = true
     @@app_id, @@app_secret, @options = id, key, opts
-    @@app_name                       = opts[:app_name]
+    @@application                    = opts[:application] || ''
     @@packager                       = packager @@app_id, @@app_secret
     @@host                           = opts[:host] || "http://errorlog.co"
     @@client                         = HTTPClient.new
-    @@rails = defined?(Rails)
+    @@opts                           = opts
+    @@rails                          = defined?(Rails)
+    @@loggers_ready                  = false
+    @@component                      = nil
+
+    if @@rails && !opts[:no_catch_logs]
+      @@logger                      = Rails.logger = ChainLogger.new Rails.logger
+      ActionController::Base.logger = ChainLogger.new ActionController::Base.logger
+      if defined?(ActiveRecord)
+        ActiveRecord::Base.logger = ChainLogger.new ActiveRecord::Base.logger
+      end
+      @@loggers_ready = true
+
+      # Delayed job
+      if defined?(Delayed)
+        require 'errlog/dj'
+      end
+    end
   end
 
-  def self.app_name
-    @@app_name #rescue nil
+  def self.logger
+    @@logger ||= ChainLogger.new
+  end
+
+  def self.use_logging?
+    !@@opts[:no_logs]
+  end
+
+  def self.application
+    @@application #rescue nil
   end
 
   def self.configured?
-    defined?(@@app_id) && @@app_id && @@app_secret
+    if @@configured
+      (@@rails && Rails.env == 'test') || defined?(@@app_id) && @@app_id && @@app_secret
+    else
+      false
+    end
   end
 
   def self.default_platform
@@ -61,20 +95,28 @@ module Errlog
     @@packager.pack(data)
   end
 
-  def self.create_logger with_logger=nil
-    self.context.create_logger with_logger
-  end
-
   def self.protect component_name=nil, options={}, &block
-     context.protect component_name, options, &block
+    context.protect component_name, options, &block
   end
 
   def self.protect_rethrow component_name=nil, &block
     context.protect_rethrow component_name, &block
   end
 
-  def self.report_exception e, &block
-    self.context.report_exception e, &block
+  def self.exception e, &block
+    self.context.exception e, &block
+  end
+
+  def self.trace text, details=nil, severity=Errlog::TRACE, &block
+    self.context.trace text, details, severity, &block
+  end
+
+  def self.error text, details=nil, severity=Errlog::TRACE, &block
+    self.context.error text, details, severity, &block
+  end
+
+  def self.warning text, details=nil, severity=Errlog::TRACE, &block
+    self.context.warning text, details, severity, &block
   end
 
   def self.report text, severity = Errlog::ERROR, &block
@@ -82,7 +124,7 @@ module Errlog
   end
 
   def self.clear_context
-    ctx                              = Errlog::Context.new
+    ctx                             = Errlog::Context.new
     Thread.current[:errlog_context] = ctx
     ctx
   end
@@ -94,18 +136,24 @@ module Errlog
   private
 
   def self.post src
-    data = pack(src)
+    if @@rails && Rails.env == 'test'
+      Rails.logger.info "Errlog: sending: #{src[:text]}"
+      return
+    end
+    data           = pack(src)
     @@send_threads ||= []
 
     t = Thread.start {
-      #puts "sending to #{@@host}"
       error = nil
       begin
-        res = @@client.post "#{@@host}/reports/log", app_id: @@app_id, data: Base64::encode64(data)
+        fio = HTTPClient::UploadIO.new(StringIO.new(data), "data.bin")
+        res = @@client.post "#{@@host}/reports/log", app_id: @@app_id, :file => fio
         error = "report refused: #{res.status}" if res.status != 200
       rescue Exception => e
         error = e
       end
+      STDERR.puts "Error sending errlog: #{error}" if error
+      #puts "sent" unless error
       yield error if block_given?
     }
     @@send_threads << WeakRef.new(t)
@@ -117,3 +165,7 @@ module Errlog
   end
 
 end
+
+if defined?(Rails) && Rails.env == 'test'
+  Errlog.configure 'test id', 'test key', application: 'test app'
+end

data/lib/errlog/chain_loggger.rb

@@ -4,26 +4,25 @@ module Errlog
 
   class ChainLogger < Logger
 
-    attr_reader :buffer, :prev_logger
+    attr_reader :prev_logger
 
-    def initialize prev
-      @buffer      = []
+    def initialize prev=nil
       @prev_logger = prev
       super(nil)
     end
 
     def level= l
-      @prev_logger.level = l
+      @prev_logger and @prev_logger.level = l
     end
 
     def level
-      @prev_logger.level
+      @prev_logger and @prev_logger.level
     end
 
     def add severity, message = nil, progname = nil
       message = yield if block_given?
       @prev_logger and @prev_logger.add(severity, message, progname)
-      @buffer << [severity, Time.now, message, progname]
+      Errlog.context.add_log_record [severity, Time.now, message, progname]
     end
 
   end

data/lib/errlog/context.rb

@@ -8,7 +8,7 @@ module Errlog
       begin
         yield self
       rescue Exception => e
-        report_exception e
+        exception e
         options[:retrhow] and raise
       end
     end
@@ -17,36 +17,62 @@ module Errlog
       self.protect component_name, retrhow: true, &block
     end
 
-    def report_exception e, &block
+    def exception e, severity=Errlog::ERROR, &block
+      raise unless Errlog.configured?
       self.stack = e.backtrace
-      report "#{e.class.name}: #{e.to_s}", Errlog::ERROR
+      self.exception_class = e.class.name
+      report e.to_s, severity
     end
 
-    def report_warning text, &block
-      report text, Errlog::WARNING, &block
+    def trace text, details=nil, severity=Errlog::TRACE, &block
+      details and self.details = details
+      report text, severity
     end
 
-    def report_trace text, &block
-      report text, Errlog::TRACE, &block
+    def warning text, details=nil, severity=Errlog::WARNING, &block
+      details and self.details = details
+      report text, severity
+    end
+
+    def error text, details=nil, severity=Errlog::ERROR, &block
+      details and self.details = details
+      report text, severity
+    end
+
+    def before_report &block
+      (@before_handlers ||= []) << block
     end
 
     def report text, severity = Errlog::ERROR, &block
       raise 'Errlog is not configured. Use Errlog.config' unless Errlog.configured?
-      !self.app_name and self.app_name = Errlog.app_name
+      self.application ||= Errlog.application
       self.time     = Time.now
       self.severity = severity
       self.platform ||= Errlog.default_platform
       self.stack    ||= caller
       self.text = text
-      @loggers and self.log = @loggers.reduce([]){ |all,x| all + x.buffer }.sort { |x,y| x[1] <=> y[1] }
+
+      if @before_handlers
+        @before_handlers.each { |h|
+          h.call self
+        }
+      end
+
+      @log_records and self.log = @log_records.inject([]){ |all,x| all << x; all}.sort { |x,y| x[1] <=> y[1] }
       Errlog.rails? and self.rails_root = Rails.root.to_s
       Errlog.post(self.to_hash, &block)
     end
 
-    def create_logger with_logger=nil
-      l = Errlog::ChainLogger.new(with_logger)
-      (@loggers ||= []) << l
-      l
+    MAX_LOG_LINES = 100
+
+    def add_log_record record
+      @log_records ||= []
+      @log_records << record
+      if @log_records.length > MAX_LOG_LINES
+        @log_records.delete_at(0)
+        self.log_truncated = true
+      end
     end
+
   end
 end

data/lib/errlog/dj.rb

@@ -0,0 +1,22 @@
+
+begin
+  class Delayed::Worker
+    def handle_failed_job_with_errlog(job, error)
+      Errlog.context.component = 'DJ'
+      Errlog.exception error
+      Errlog.clear_context
+      handle_failed_job_without_errlog(job, error)
+    end
+    alias_method_chain :handle_failed_job, :errlog
+
+    def run_with_errlog job
+      Errlog.clear_context
+      run_without_errlog job
+    end
+    alias_method_chain :run, :errlog
+  end
+rescue => e
+  STDERR.puts "Problem starting Exceptional for Delayed-Job. Your app will run as normal\n#{e}"
+  Errlog.context.component = 'DJ'
+  Errlog.exception e
+end

data/lib/errlog/rails_controller_extensions.rb

@@ -2,61 +2,85 @@ module Errlog
   module ControllerFilter
 
     def self.included base
-      base.send :prepend_around_filter, :errlog_exceptions_trap
+      base.send :prepend_before_filter, :errlog_connect_context
+      base.send :rescue_from, Exception, :with => :errlog_report_exceptons
       base.send :helper_method, :errlog_context
-      base.send :helper_method, :errlog_report
-      base.send :helper_method, :errlog_collect_context
-      base.send :helper_method, :errlog_exception
-      true
-    end
-
-    def errlog_context
-      @errlog_context || Errlog.clear_context
+      base.send :helper_method, :errlog_not_found
     end
 
-    def errlog_exceptions_trap
-      ctx = @errlog_context = Errlog.clear_context
 
-      rl  = Rails.logger = ctx.create_logger Rails.logger
-      acl = ActionController::Base.logger = ctx.create_logger ActionController::Base.logger
-      arl = nil
-      if defined?(ActiveRecord)
-        arl = ActiveRecord::Base.logger = ctx.create_logger ActiveRecord::Base.logger
+    # Get the context that is linked to the current request and will
+    # pass all its data if reporting will be called.
+    # Dafault Loggerr.context might not always be connected to the request.
+    #
+    def errlog_context
+      unless @errlog_context
+        errlog_connect_context
       end
+      @errlog_context
+    end
 
-      yield
+    # Helper for 404's or like. Can be used as the trap.
+    #
+    # The argument may be either an Exception object or a text message.
+    # Can be used as the rescue_from catcher:
+    #
+    #    rescue_from :ActiveRecord::NotFound, :with => :errlog_not_found
+    #
+    # or manually:
+    #
+    #    def load_item
+    #      item = Item.find_by_id(params[:id]) or errlog_not_found
+    #
+    # Reports and rethrows rails standard ActionController::RoutingError to
+    # activate default 404 processing
+    def errlog_not_found text = 'Resource not found'
+      ex = ActionController::RoutingError.new text
+      errlog_context.exception ex
+      raise ex
+    end
 
-    rescue Exception => e
-      if Errlog.configured?
-        errlog_collect_context ctx
-        ctx.report_exception e
-      else
-        rl.prev_logger.error 'Errlog is not configured, can not report an exception'
-      end
-      raise
+    private
 
-    ensure
-      Rails.logger                  = rl.prev_logger
-      ActionController::Base.logger = acl.prev_logger
-      arl and ActiveRecord::Base.logger = arl.prev_logger
+    def errlog_connect_context
+      @errlog_context = Errlog.context
+      @errlog_context.before_report {
+        errlog_collect_context
+      }
       true
     end
 
-    def errlog_exception e, context = nil
-      errlog_collect_context(context).report_exception e
+    def errlog_report_exceptons e
+      errlog_context.exception e, e.is_a?(ActionController::RoutingError) ? Errlog::ERROR : Errlog::WARNING
+      raise
     end
 
-    def errlog_report text, severity = Errlog::ERROR, context=nil
-      errlog_collect_context(context).report text, severity
+    def parametrize obj
+      case obj
+        when String
+          obj
+        when Array
+          obj.map { |x| parametrize(x) }
+        when ActionDispatch::Http::UploadedFile
+          obj.inspect
+        when Hash
+          obj.inject({}) { |all, kv| all[kv[0].to_s] = parametrize(kv[1]); all }
+        else
+          obj.to_s
+      end
     end
 
+    @@headers_exclusion_keys = %w|async. action_dispatch. cookie rack. rack-cache. warden action_controller.|
+
+    public
+
     def errlog_collect_context ctx=nil
-      ctx ||= errlog_context
-      ctx.component = request.path
-      ctx.params    = params
+      ctx           ||= errlog_context
+      ctx.component = "#{self.class.name}##{params[:action]}"
+      ctx.params    = parametrize(params)
       headers       = {}
       request.headers.to_hash.each { |k, v|
-        next if k =~ /cookie/i || v.class.name =~ /cookie/i
+        next if @@headers_exclusion_keys.any? { |s| k.starts_with?(s) }
         res = nil
         case v
           when Hash
@@ -82,15 +106,33 @@ module Errlog
                              "not logged in"
                            end
       end
-      ctx.url = request.url
-      ctx.remote_ip = request.remote_ip
-      if request.url =~ %r|^https?://(.+?)[/:]|
+      ctx.url         = request.url
+      ctx.remote_ip   = request.remote_ip
+      ctx.application = Errlog.application
+      if ctx.application.blank? && request.url =~ %r|^https?://(.+?)[/:]|
         ctx.application = $1
       end
       ctx
     end
+  end
+
+  class ContextMiddleware
+    def initialize(app)
+      @app = app
+    end
 
+    def call(env)
+      Errlog.clear_context
+      status, headers, body = @app.call(env)
+      [status, headers, body]
+    end
+  end
+
+  class Railtie < Rails::Railtie
+    initializer "Errlog.insert_middleware" do |app|
+      app.config.middleware.use 'Errlog::ContextMiddleware'
+    end
   end
 end
 
-ActionController::Base.send :include, Errlog::ControllerFilter
+ActionController::Base.send :include, Errlog::ControllerFilter

data/lib/errlog/version.rb

@@ -1,3 +1,3 @@
 module Errlog
-  VERSION = "0.2.3"
+  VERSION = "0.3.2"
 end

data/spec/errlog_spec.rb

@@ -7,6 +7,7 @@ require 'stringio'
 
 describe Errlog do
 
+  context 'configured' do
   before :each do
     Errlog.configure 'TheTestId', '1234567890123456'
     @packager = Errlog.packager 'TheTestId', '1234567890123456'
@@ -19,13 +20,13 @@ describe Errlog do
     Errlog.context.value.should == nil
   end
 
-  # This spec checks the whole chain - protect, report_exception, report, but does not check post
+  # This spec checks the whole chain - protect, exception, report, but does not check post
   it 'should provide protection' do
     Errlog.should_receive(:post).exactly(3).times do |payload|
       payload = Hashie::Mash.new payload
       payload.should_not be_nil
       payload.stack[0].should =~ /errlog_spec/
-      payload.text.should == 'RuntimeError: TestError'
+      payload.text.should == 'TestError'
       payload.time.should be_within(5000).of(Time.now)
       payload.component_name.should == 'test'
       payload.test.should == '123'
@@ -45,7 +46,7 @@ describe Errlog do
     }.should raise_error
 
     Errlog.context.test = '123'
-    Errlog.report 'RuntimeError: TestError'
+    Errlog.report 'TestError'
   end
 
   it 'should provide logs' do
@@ -57,8 +58,8 @@ describe Errlog do
       payload.log[1][3].should == 'test warning'
     end
     sio = StringIO.new
-    l1 = Errlog.create_logger
-    l2 = Errlog.create_logger Logger.new(sio)
+    l1 = Errlog::ChainLogger.new
+    l2 = Errlog::ChainLogger.new Logger.new(sio)
     l1.info 'test info'
     l2.warn 'test warning'
     Errlog.report 'LogTest', Errlog::TRACE
@@ -86,4 +87,15 @@ describe Errlog do
     Errlog.severity_name(Errlog::TRACE).should == 'trace'
   end
 
+  end
+
+  it 'should work fine when not configured' do
+    expect { Errlog.error "Some error" }.to raise_error(StandardError, 'Errlog is not configured. Use Errlog.config')
+    expect {
+      Errlog.protect_rethrow {
+        raise "test"
+      }
+    }.to raise_error(StandardError, "test")
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: errlog
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.2
 platform: ruby
 authors:
 - sergeych
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-01 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: boss-protocol
@@ -44,14 +44,28 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.3.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 2.3.3
+- !ruby/object:Gem::Dependency
+  name: httpclient-uploadio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +115,7 @@ files:
 - lib/errlog/chain_loggger.rb
 - lib/errlog/constants.rb
 - lib/errlog/context.rb
+- lib/errlog/dj.rb
 - lib/errlog/packager.rb
 - lib/errlog/rails_controller_extensions.rb
 - lib/errlog/version.rb