hatchet 0.2.9 → 0.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e793530225b72cad969ca6ff304f764b79342362
-  data.tar.gz: 31f388e0a9b3304f57c9c9bb0ab0c372aef1fdd9
+  metadata.gz: 813a27c38ca53b1f1e669f206c7ba049473b4896
+  data.tar.gz: f805a3480f1075f27109d9063ab37bc6f277b77d
 SHA512:
-  metadata.gz: 1d690faeaa1369d6d29b9fc78c194793de3f22124a1d287f21dba0ac39bc55a03ad8fc158b912dcb1cc06073e628fd0b10a7ebfdda7d54055694251487983d61
-  data.tar.gz: 30bde7326ac9c50ca3a885c49487647aafbb93915418645fbed0b2099553fbf030f015cd210db34c29edf6884a4c85bb7033c4b58e910d6c82f0250f657a89a5
+  metadata.gz: 6dfe4975156aa901ce3fca6a9664b8cc105d2a7ad104c73da53bf60acc9ded2fa567d989f9ec42d91f78d9796ae574efd6b0946c55eca179364df17930f1f2d5
+  data.tar.gz: b2bfbabbd0073e546894474efeff7d7aec1d0c9e0c2e30078870be7fb345fbc49b301539a44f0f505f898732847ef4036fc664a1a2b882bf46f4ee9be09567bb

data/RELEASE.md

@@ -1,5 +1,23 @@
 # Release notes
 
+## 0.2.10
+
+* Introduced the ability to filter backtraces
+
+Example:
+
+    configuration.configure do |config|
+      config.backtrace_filter '/applications/my_app/releases/current' => '[ROOT]'
+    end
+
+Will filter a backtrace line like:
+
+    /applications/my_app/releases/current/lib/example.rb:42:in `main'
+
+Into:
+
+    [ROOT]/lib/example.rb:42:in `main'
+
 ## 0.2.9
 
  * Fixed a bug where if you specified appender-specific log levels without

data/lib/hatchet.rb

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-
 require_relative 'hatchet/level_manager'
 require_relative 'hatchet/backtrace_formatter'
 require_relative 'hatchet/thread_name_formatter'

data/lib/hatchet/configuration.rb

@@ -20,6 +20,34 @@ module Hatchet
       reset!
     end
 
+    # Public: Adds backtrace filters provided in the form of a Hash.
+    #
+    # Each line of the backtrace starting with a key is replaced by its
+    # corresponding value.
+    #
+    # Example
+    #
+    #   configuration.configure do |config|
+    #     config.backtrace_filter '/applications/my_app/releases/current' => '$ROOT'
+    #   end
+    #
+    # Will filter a backtrace line like:
+    #
+    #   /applications/my_app/releases/current/lib/example.rb:42:in `main'
+    #
+    # Into:
+    #
+    #   $ROOT/lib/example.rb:42:in `main'
+    #
+    # Returns nothing.
+    #
+    def backtrace_filter(filters = nil)
+      @backtrace_filters.merge!(filters) if filters
+      @backtrace_filters
+    end
+
+    alias_method :backtrace_filters, :backtrace_filter
+
     # Public: Returns the default formatter given to the appenders that have not
     # had their formatter explicitly set.
     #
@@ -39,6 +67,7 @@ module Hatchet
     # Public: Resets the configuration's internal state to the defaults.
     #
     def reset!
+      @backtrace_filters = {}
       @levels = { nil => :info }
       @appenders = []
 

data/lib/hatchet/hatchet_logger.rb

@@ -388,15 +388,15 @@ module Hatchet
       @configuration ||= Hatchet.configuration
       @ndc ||= Hatchet::NestedDiagnosticContext.current
 
-      msg = Message.new(ndc: @ndc.context.clone, message: message, error: error, &block)
+      msg = Message.new(ndc: @ndc.context.clone, message: message, error: error, backtrace_filters: @configuration.backtrace_filters, &block)
 
       @configuration.appenders.each do |appender|
         if appender.enabled?(level, @context)
           begin
             appender.add(level, @context, msg)
           rescue => e
-            puts "Failed to log message for #{@context} with appender #{appender} - #{level} - #{msg}\n"
-            puts "#{e}\n"
+            STDERR.puts "Failed to log message for #{@context} with appender #{appender} - #{level} - #{msg}\n"
+            STDERR.puts "#{e}\n"
           end
         end
       end

data/lib/hatchet/message.rb

@@ -1,5 +1,7 @@
 # -*- encoding: utf-8 -*-
 
+require 'delegate'
+
 module Hatchet
 
   # Public: Class for wrapping message strings and blocks in a way that means
@@ -15,6 +17,28 @@ module Hatchet
   #
   class Message
 
+    class ErrorDecorator < SimpleDelegator
+      def initialize(error, backtrace_filters)
+        super(error)
+        @error = error
+        @backtrace_filters = backtrace_filters
+      end
+
+      def backtrace
+        @backtrace ||= @error.backtrace.map { |line| __filtered_line(line) }
+      end
+
+      def __filtered_line(line)
+        @backtrace_filters.each do |prefixes, replacement|
+          Array[*prefixes].each do |prefix|
+            return replacement + line[prefix.length..-1] if line.start_with?(prefix)
+          end
+        end
+
+        line
+      end
+    end
+
     # Public: Gets the error associated with this message, if given.
     #
     attr_reader :error
@@ -65,12 +89,13 @@ module Hatchet
         @message = args[:message] unless block
       else
         # Otherwise assume the old format and coerce args accordingly.
-        @ndc = []
-        @error = error
+        @ndc     = []
+        @error   = error
         @message = args unless block
       end
 
-      @block   = block
+      @error = ErrorDecorator.new(@error, args[:backtrace_filters]) if @error && args[:backtrace_filters]
+      @block = block
     end
 
     # Public: Returns the String representation of the message.

data/lib/hatchet/version.rb

@@ -4,6 +4,6 @@ module Hatchet
 
   # Public: The version of Hatchet.
   #
-  VERSION = '0.2.9'
+  VERSION = '0.2.10'
 
 end

data/spec/logger_spec.rb

@@ -60,7 +60,8 @@ describe HatchetLogger do
           subject.send level, message, error
           received = appender.messages.last
 
-          assert error == received.message.error
+          # Use __getobj__ as wrapped by delegator
+          assert error == received.message.error.__getobj__
         end
       end
     end

data/spec/message_spec.rb

@@ -105,6 +105,58 @@ describe Message do
     end
   end
 
+  describe 'filtering backtraces' do
+    def generate_error
+      raise 'Example failure'
+    rescue => e
+      e
+    end
+
+    let(:dirname) { File.dirname(__FILE__) }
+    let(:error) { generate_error }
+
+    let(:subject) do
+      Message.new(error: generate_error, backtrace_filters: backtrace_filters)
+    end
+
+    require 'rbconfig'
+
+    describe 'string keys' do
+      let(:backtrace_filters) do
+        {
+          dirname => '$DIRNAME',
+          RbConfig::CONFIG['rubylibdir'] => '$RUBYLIBDIR',
+        }
+      end
+
+      it 'replaces the matching keys' do
+        backtrace = subject.error.backtrace
+
+        backtrace_filters.each do |prefix, replacement|
+          refute backtrace.find { |line| line.start_with? prefix }, "Backtrace should not have a line starting '#{prefix}'\n\t#{backtrace.join("\n\t")}"
+        end
+      end
+    end
+
+    describe 'array keys' do
+      let(:backtrace_filters) do
+        {
+          [dirname, RbConfig::CONFIG['rubylibdir']] => '$REPLACEMENT',
+        }
+      end
+
+      it 'replaces the matching keys' do
+        backtrace = subject.error.backtrace
+
+        backtrace_filters.each do |prefixes, replacement|
+          prefixes.each do |prefix|
+            refute backtrace.find { |line| line.start_with? prefix }, "Backtrace should not have a line starting '#{prefix}'\n\t#{backtrace.join("\n\t")}"
+          end
+        end
+      end
+    end
+  end
+
   if ENV["BENCH"] then
     describe 'benchmarks' do
       let(:subject) { Message.new(ndc: [], message: 'Evaluated') }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hatchet
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
 platform: ruby
 authors:
 - Garry Shutler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-15 00:00:00.000000000 Z
+date: 2014-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Logging library that provides the ability to add class/module specific
   filters