logatron 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3103d9cac1561ecd60127ba26110d18fb0fe720e
-  data.tar.gz: d35300ec7cdc5165ec570f56faf38fc38436bf25
+  metadata.gz: a056f7a08b37ab427b57c039a5d5a9142e94e6a5
+  data.tar.gz: 58393a44fbb79cdf5b85fa6791bccd9ce47e5cc2
 SHA512:
-  metadata.gz: 1fb22c5f504469d354b1dd7a0479ef89a45ecadd52d115c553fade502e33babb4b37c4a8eb507edae756fba59f5d0f89e4ecca17cd065e0ca998b3aca2e7b368
-  data.tar.gz: d3476f1bde8fd841211d40b37697fe5498733a2cb3132102c3c4e27b8f7bebd83501e0cf53ce86e58a285359005b0b4eb60881ba7d18d992dad088ab04de0f30
+  metadata.gz: bdd6dd9bb5269402a9954f1572b6a478335678a7cdf2a2bed58d970b5d1ce72262a5a7dfc5f9b0d8b67ed2903a0b0c6e2bc7288571703d03bc0ba052d8745d76
+  data.tar.gz: 0e1c15b57f5ecf7a0b0bd52c18a81fa9105002270a863ab174fe3e51ddb43c1abeaef45db5922bb61e9c093e8d952a947e768b6338219e72f4407bc3a4c9c25d

data/.gitignore

@@ -1,3 +1,4 @@
 .idea/
 .DS_Store
 *.gem
+Gemfile.lock

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.4.1

data/lib/logatron/backtrace_cleaner.rb

@@ -0,0 +1,46 @@
+module Logatron
+  class BacktraceCleaner
+    # Suppress irrelevant "external" frames. In practice, these are often the frames
+    # leading up to the "entry point" we care about, whether that's a rails controller
+    # or a rabbit_stew handler.
+    #
+    # Algorithm: partition frames into contiguous external/internal chunks.
+    # Starting at the bottom, suppress chunks until we find the entry point chunk.
+
+    def clean(backtrace)
+      all_chunks = backtrace.chunk { |x| external_frame?(x) }.to_a.reverse
+      good_chunks = all_chunks.drop_while { |(is_ext, frames)| !entry_point_chunk?(is_ext, frames) }
+      bad_chunks = all_chunks.take(all_chunks.size - good_chunks.size)
+      good_bt = good_chunks.reverse.map(&:last).flatten
+      bad_bt = bad_chunks.reverse.map(&:last).flatten
+      good_bt + suppress(bad_bt)
+    rescue
+      # if something went wrong, give up on cleaning the backtrace
+      backtrace
+    end
+
+    private
+
+    # heuristic for determining externality of a frame.
+    # Note: bundle/gems does not include git-sourced gems (those go in
+    # bundle/bundler/gems), so git-sourced gems are considered internal.
+    def external_frame?(f)
+      !!(f =~ %r{bundle/gems})
+    end
+
+    # heuristic for finding the entry point
+    def entry_point_chunk?(is_ext, frames)
+      !is_ext && frames.size >= 3
+    end
+
+    def suppress(backtrace)
+      if backtrace.size <= 3
+        backtrace
+      else
+        [ backtrace.first,
+          "... #{backtrace.size - 2} frames suppressed ...",
+          backtrace.last ]
+      end
+    end
+  end
+end

data/lib/logatron/configuration.rb

@@ -1,6 +1,8 @@
 require 'logger'
 require 'logatron/const'
 require 'logatron/basic_formatter'
+require 'logatron/error_formatter'
+require 'logatron/backtrace_cleaner'
 require 'active_support/backtrace_cleaner'
 require 'active_support/json'
 
@@ -21,7 +23,7 @@ module Logatron
   end
 
   class Configuration
-    attr_accessor :logger, :host, :level, :transformer, :app_id
+    attr_accessor :logger, :host, :level, :transformer, :app_id, :error_formatter
     attr_reader :loggable_levels, :backtrace_cleaner
 
     def initialize
@@ -33,10 +35,8 @@ module Logatron
       level_threshold = SEVERITY_MAP[@level]
       levels = Logatron::SEVERITY_MAP.keys
       @loggable_levels = levels.select { |level| SEVERITY_MAP[level] >= level_threshold }
-      bc = ActiveSupport::BacktraceCleaner.new
-      bc.add_filter { |line| line.gsub(Rails.root.to_s, '') } if defined? Rails
-      bc.add_silencer { |line| line =~ /gems/ }
-      @backtrace_cleaner = bc
+      @backtrace_cleaner = Logatron::BacktraceCleaner.new
+      @error_formatter = Logatron::ErrorFormatter.new
     end
 
     def logger=(logger)

data/lib/logatron/error_formatter.rb

@@ -0,0 +1,67 @@
+require 'abstractivator/enumerator_ext'
+
+module Logatron
+  class ErrorFormatter
+    def format_short_message(e)
+      "#{e.class}: #{e.message}"
+    end
+
+    def format_full_message(e, additional_info = nil)
+      format_short_message(e) + format_additional_info(e, additional_info)
+    end
+
+    def format_backtrace(error_or_bt)
+      bt = error_or_bt.is_a?(Exception) ? error_or_bt.backtrace : error_or_bt
+      bt.map { |f| "      #{f.starts_with?('...') ? f : "at #{f}"}\n" }.join
+    end
+
+    def format_additional_info(e, additional_info = nil)
+      info = additional_info || (e.respond_to?(:meta) && e.meta)
+      info ? "; MORE_INFO( #{info.to_s} )" : ''
+    end
+
+    # Returns a human-readable exception report.
+    # Includes nested exception information.
+    # Suppresses duplicate frames in nested exception backtraces.
+    def format_error_report(e, additional_info = nil)
+      error_chain = Enumerator.unfold(e) { |e| [e.cause, e.cause] }.to_a
+      initial_report = format_single_error(e, clean_backtrace(nil, e), additional_info)
+      # starting with the outermost error, reduce the error chain into the formatted report
+      error_chain.reduce([e, initial_report]) do |(prev_e, report), e|
+        new_report = format_single_error(e, clean_backtrace(prev_e, e)) + "  which caused:\n    " + report
+        [e, new_report]
+      end[1]
+    rescue
+      # if something went wrong, fall back to something simpler
+      format_short_message(e) + "\n" + e.backtrace.join("\n")
+    end
+
+    private
+
+    def format_single_error(e, cleaned_backtrace, additional_info = nil)
+      format_full_message(e, additional_info) + "\n" + format_backtrace(cleaned_backtrace)
+    end
+
+    def clean_backtrace(prev, e)
+      base_size = prev ? num_common_base_frames(prev, e) : 0
+      cleaned_backtrace =
+          if base_size > 1
+            num_to_suppress = base_size - 1
+            e.backtrace.take(e.backtrace.size - num_to_suppress) +
+                ["... #{num_to_suppress} frames suppressed ..."]
+          else
+            backtrace_cleaner.clean(e.backtrace)
+          end
+    end
+
+    def backtrace_cleaner
+      Logatron.configuration.backtrace_cleaner
+    end
+
+    def num_common_base_frames(e1, e2)
+      e1.backtrace.reverse.zip(e2.backtrace.reverse)
+          .take_while { |(a, b)| a == b }
+          .size
+    end
+  end
+end

data/lib/logatron/logatron.rb

@@ -2,7 +2,9 @@ require 'active_support/all'
 require 'logatron/version'
 require 'logatron/const'
 require 'logatron/contexts'
+require 'logatron/error_formatter'
 require 'logatron/message_formatting'
+require 'logatron/backtrace_cleaner'
 require 'logatron/basic_scoped_logger'
 require 'logatron/basic_formatter'
 require 'logatron/basic_logger'
@@ -16,10 +18,10 @@ module Logatron
       @log ||= Logatron::BasicLogger.new
     end
 
+    # @param additional_info [Object] Typically a flat hash, but can be anything that responds to '#to_s'
     def log_exception(e, severity, additional_info = {})
-      # 'additional_info' can be a flat hash or anything with '#to_s'
-      message = exception_message(e, additional_info)
-      logger.send(severity.downcase, message)
+      error_report = configuration.error_formatter.format_error_report(e, additional_info)
+      logger.send(severity.downcase, error_report)
     end
 
     def level=(level)
@@ -90,14 +92,5 @@ module Logatron
     def msg_id=(id)
       Logatron::Contexts.msg_id = id
     end
-
-    private
-
-    def exception_message(e, additional)
-      info = additional.is_a?(Hash) ? additional.map { |(k, v)| "#{k}=>#{v}" }.join(', ') : additional
-      info_msg = info.nil? || info.empty? ? '' : "; MORE_INFO( #{info} )"
-      backtrace = configuration.backtrace_cleaner.clean(e.backtrace).join(' -> ')
-      "#{e.class} #{e.message}#{info_msg} -> #{backtrace}"
-    end
   end
 end

data/logatron.gemspec

@@ -5,7 +5,7 @@ require 'logatron/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'logatron'
-  spec.version       = '0.7.0'
+  spec.version       = '0.8.0'
   spec.authors       = ['Justin Grimes']
   spec.email         = ['justin.mgrimes@gmail.com']
 
@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
   spec.add_runtime_dependency 'activesupport', '< 6.0', '>= 4.2.1'
+  spec.add_runtime_dependency 'abstractivator', '~> 0.16.0'
   spec.add_development_dependency 'bundler', '~> 1.10'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3'

data/update_version.sh

@@ -8,7 +8,6 @@ SCRIPT_DIR="$(cd "$(dirname "$0")"; pwd)"
 
 updateVersion(){
     updateGemspec
-    updateLockfile
     commitStagedFiles "Update version to ${VERSION}"
 }
 
@@ -19,13 +18,6 @@ updateGemspec(){
     stageFiles "${gemspecPath}"
 }
 
-updateLockfile(){
-    echo -e "\nUpdating lockfile"
-    bundle package --no-install > /dev/null
-    rm -rf .bundle/ vendor/
-    stageFiles "${SCRIPT_DIR}/Gemfile.lock"
-}
-
 stageAndCommit(){
     local msg="$1"
     shift

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: logatron
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Justin Grimes
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,6 +30,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.1
+- !ruby/object:Gem::Dependency
+  name: abstractivator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -98,18 +112,19 @@ files:
 - CHANGES.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - build.yml
+- lib/logatron/backtrace_cleaner.rb
 - lib/logatron/basic_formatter.rb
 - lib/logatron/basic_logger.rb
 - lib/logatron/basic_scoped_logger.rb
 - lib/logatron/configuration.rb
 - lib/logatron/const.rb
 - lib/logatron/contexts.rb
+- lib/logatron/error_formatter.rb
 - lib/logatron/logatron.rb
 - lib/logatron/message_formatting.rb
 - lib/logatron/railtie.rb
@@ -135,9 +150,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.2
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Logging for ascent
 test_files: []
-has_rdoc: 

data/Gemfile.lock

@@ -1,53 +0,0 @@
-PATH
-  remote: .
-  specs:
-    logatron (0.6.0)
-      activesupport (>= 4.2.1, < 6.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (4.2.7.1)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    builder (3.2.2)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    minitest (5.9.1)
-    rake (10.4.2)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
-    rspec_junit_formatter (0.2.3)
-      builder (< 4)
-      rspec-core (>= 2, < 4, != 2.12.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.10)
-  logatron!
-  rake (~> 10.0)
-  rspec (~> 3)
-  rspec_junit_formatter (~> 0.2.0)
-
-BUNDLED WITH
-   1.13.1