semantic_logger 4.7.2 → 4.10.0

data/lib/semantic_logger/log.rb

@@ -114,14 +114,12 @@ module SemanticLogger
 
       # Elastic logging: Log when :duration exceeds :min_duration
       # Except if there is an exception when it will always be logged
-      if duration
-        return false if (duration < min_duration) && exception.nil?
-      end
+      return false if duration && ((duration < min_duration) && exception.nil?)
 
       if backtrace
         self.backtrace = Utils.extract_backtrace(backtrace)
       elsif level_index >= SemanticLogger.backtrace_level_index
-        self.backtrace = Utils.extract_backtrace
+        self.backtrace = Utils.extract_backtrace(caller)
       end
 
       true

data/lib/semantic_logger/loggable.rb

@@ -8,7 +8,7 @@
 # Example:
 #   require 'semantic_logger'
 #   SemanticLogger.default_level = :debug
-#   SemanticLogger.add_appender(io: STDOUT, formatter: :color)
+#   SemanticLogger.add_appender(io: $stdout, formatter: :color)
 #
 #   class ExternalSupplier
 #     # Create class and instance logger methods
@@ -32,7 +32,14 @@ module SemanticLogger
   module Loggable
     def self.included(base)
       base.extend ClassMethods
+      base.singleton_class.class_eval do
+        undef_method :logger if method_defined?(:logger)
+        undef_method :logger= if method_defined?(:logger=)
+      end
       base.class_eval do
+        undef_method :logger if method_defined?(:logger)
+        undef_method :logger= if method_defined?(:logger=)
+
         # Returns [SemanticLogger::Logger] class level logger
         def self.logger
           @semantic_logger ||= SemanticLogger[self]

data/lib/semantic_logger/logger.rb

@@ -21,7 +21,19 @@ module SemanticLogger
     end
 
     def self.processor
-      @processor ||= SemanticLogger.sync? ? SyncProcessor.new : Processor.new
+      @processor ||= Processor.new
+    end
+
+    # Switch to the synchronous processor
+    def self.sync!
+      return if @processor.is_a?(SyncProcessor)
+
+      @processor = SyncProcessor.new(@processor&.appenders)
+    end
+
+    # Running without the background logging thread?
+    def self.sync?
+      processor.is_a?(SyncProcessor)
     end
 
     # Returns a Logger instance
@@ -70,11 +82,9 @@ module SemanticLogger
       return unless @subscribers
 
       @subscribers.each do |subscriber|
-        begin
-          subscriber.call(log)
-        rescue Exception => e
-          processor.logger.error("Exception calling :on_log subscriber", e)
-        end
+        subscriber.call(log)
+      rescue Exception => e
+        processor.logger.error("Exception calling :on_log subscriber", e)
       end
     end
   end

data/lib/semantic_logger/processor.rb

@@ -1,7 +1,7 @@
 module SemanticLogger
   # Thread that submits and processes log requests
   class Processor < Appender::Async
-    # Allow the internal logger to be overridden from its default of STDERR
+    # Allow the internal logger to be overridden from its default of $stderr
     #   Can be replaced with another Ruby logger or Rails logger, but never to
     #   SemanticLogger::Logger itself since it is for reporting problems
     #   while trying to log to the various appenders
@@ -11,11 +11,11 @@ module SemanticLogger
 
     # Internal logger for SemanticLogger
     #   For example when an appender is not working etc..
-    #   By default logs to STDERR
+    #   By default logs to $stderr
     def self.logger
       @logger ||=
         begin
-          l      = SemanticLogger::Appender::File.new(io: STDERR, level: :warn)
+          l      = SemanticLogger::Appender::IO.new($stderr, level: :warn)
           l.name = name
           l
         end

data/lib/semantic_logger/semantic_logger.rb

@@ -101,7 +101,7 @@ module SemanticLogger
   #   Or,
   #   io: [IO]
   #     An IO Stream to log to.
-  #     For example STDOUT, STDERR, etc.
+  #     For example $stdout, $stderr, etc.
   #
   #   Or,
   #   appender: [Symbol|SemanticLogger::Subscriber]
@@ -122,7 +122,7 @@ module SemanticLogger
   #     Default: SemanticLogger.default_level
   #
   #   formatter: [Symbol|Object|Proc]
-  #     Any of the following symbol values: :default, :color, :json
+  #     Any of the following symbol values: :default, :color, :json, :logfmt, etc...
   #       Or,
   #     An instance of a class that implements #call
   #       Or,
@@ -138,14 +138,14 @@ module SemanticLogger
   # Examples:
   #
   #   # Send all logging output to Standard Out (Screen)
-  #   SemanticLogger.add_appender(io: STDOUT)
+  #   SemanticLogger.add_appender(io: $stdout)
   #
   #   # Send all logging output to a file
   #   SemanticLogger.add_appender(file_name: 'logfile.log')
   #
   #   # Send all logging output to a file and only :info and above to standard output
   #   SemanticLogger.add_appender(file_name: 'logfile.log')
-  #   SemanticLogger.add_appender(io: STDOUT, level: :info)
+  #   SemanticLogger.add_appender(io: $stdout, level: :info)
   #
   # Log to log4r, Logger, etc.:
   #
@@ -154,7 +154,7 @@ module SemanticLogger
   #   require 'semantic_logger'
   #
   #   # Built-in Ruby logger
-  #   log = Logger.new(STDOUT)
+  #   log = Logger.new($stdout)
   #   log.level = Logger::DEBUG
   #
   #   SemanticLogger.default_level = :debug
@@ -164,7 +164,7 @@ module SemanticLogger
   #   logger.info "Hello World"
   #   logger.debug("Login time", user: 'Joe', duration: 100, ip_address: '127.0.0.1')
   def self.add_appender(**args, &block)
-    appender = Logger.processor.appenders.add(**args, &block)
+    appender = appenders.add(**args, &block)
     # Start appender thread if it is not already running
     Logger.processor.start
     appender
@@ -173,7 +173,15 @@ module SemanticLogger
   # Remove an existing appender
   # Currently only supports appender instances
   def self.remove_appender(appender)
-    Logger.processor.appenders.delete(appender)
+    return unless appender
+
+    appenders.delete(appender)
+    appender.close
+  end
+
+  # Clear out all previously registered appenders
+  def self.clear_appenders!
+    Logger.processor.close
   end
 
   # Returns [SemanticLogger::Subscriber] a copy of the list of active
@@ -181,7 +189,7 @@ module SemanticLogger
   # Use SemanticLogger.add_appender and SemanticLogger.remove_appender
   # to manipulate the active appenders list
   def self.appenders
-    Logger.processor.appenders.to_a
+    Logger.processor.appenders
   end
 
   # Flush all queued log entries disk, database, etc.
@@ -494,12 +502,12 @@ module SemanticLogger
   # I.e. Instead of logging messages in a separate thread for better performance,
   # log them using the current thread.
   def self.sync!
-    @sync = true
+    Logger.sync!
   end
 
   # Running in synchronous mode?
   def self.sync?
-    @sync
+    Logger.sync?
   end
 
   # Initial default Level for all new instances of SemanticLogger::Logger

data/lib/semantic_logger/subscriber.rb

@@ -22,6 +22,11 @@ module SemanticLogger
       # NOOP
     end
 
+    # Method called to log an event
+    def log(log)
+      raise NotImplementedError
+    end
+
     # Returns [SemanticLogger::Formatters::Default] default formatter for this subscriber.
     def default_formatter
       SemanticLogger::Formatters::Default.new
@@ -68,6 +73,11 @@ module SemanticLogger
       super(log) && (log.metric_only? ? metrics? : true)
     end
 
+    # Whether this appender is logging to stdout or stderror
+    def console_output?
+      false
+    end
+
     private
 
     # Initializer for Abstract Class SemanticLogger::Subscriber

data/lib/semantic_logger/sync_processor.rb

@@ -10,7 +10,7 @@ module SemanticLogger
     def_delegator :@appenders, :close
     def_delegator :@appenders, :reopen
 
-    # Allow the internal logger to be overridden from its default of STDERR
+    # Allow the internal logger to be overridden from its default of $stderr
     #   Can be replaced with another Ruby logger or Rails logger, but never to
     #   SemanticLogger::Logger itself since it is for reporting problems
     #   while trying to log to the various appenders
@@ -20,11 +20,11 @@ module SemanticLogger
 
     # Internal logger for SemanticLogger
     #   For example when an appender is not working etc..
-    #   By default logs to STDERR
+    #   By default logs to $stderr
     def self.logger
       @logger ||=
         begin
-          l      = SemanticLogger::Appender::File.new(io: STDERR, level: :warn)
+          l      = SemanticLogger::Appender::IO.new($stderr, level: :warn)
           l.name = name
           l
         end
@@ -32,8 +32,8 @@ module SemanticLogger
 
     attr_reader :appenders
 
-    def initialize
-      @appenders = Appenders.new(self.class.logger.dup)
+    def initialize(appenders = nil)
+      @appenders = appenders || Appenders.new(self.class.logger.dup)
     end
 
     def start

data/lib/semantic_logger/test/capture_log_events.rb

@@ -0,0 +1,34 @@
+module SemanticLogger
+  module Test
+    # Logging class to captures all logging events in memory.
+    #
+    # Example:
+    #
+    # class UserTest < ActiveSupport::TestCase
+    #   describe User do
+    #     let(:capture_logger) { SemanticLogger::Test::CaptureLogEvents.new }
+    #     let(:user) { User.new }
+    #
+    #     it "logs message" do
+    #       user.stub(:logger, capture_logger) do
+    #         user.enable!
+    #       end
+    #       assert_equal "Hello World", capture_logger.events.last.message
+    #       assert_equal :info, capture_logger.events.last.level
+    #     end
+    #   end
+    # end
+    class CaptureLogEvents < SemanticLogger::Subscriber
+      attr_accessor :events
+
+      # By default collect all log levels, and collect metric only log events.
+      def initialize(level: :trace, metrics: true)
+        super(level: level, metrics: true)
+      end
+
+      def log(log)
+        (@events ||= []) << log
+      end
+    end
+  end
+end

data/lib/semantic_logger/utils.rb

@@ -32,29 +32,48 @@ module SemanticLogger
       end
     end
 
-    SELF_PATTERN = File.join("lib", "semantic_logger")
-
-    # Extract the backtrace leaving out the last few Semantic Logger lines.
+    # Extract the backtrace stripping off the leading semantic logger entries.
+    # Leaves all other system and gem path entries in place.
     def self.extract_backtrace(stack = caller)
-      while (first = stack.first) && first.include?(SELF_PATTERN)
+      while (first = stack.first) && extract_path?(first)
         stack.shift
       end
       stack
     end
 
-    # Strips off all gems and built-in ruby code paths from the top of the stack until application code is found.
+    def self.extract_paths
+      @extract_paths ||= %w[lib/semantic_logger lib/rails_semantic_logger]
+    end
+
+    # Whether this path should be excluded from any cleansed backtrace
+    def self.extract_path?(path)
+      extract_paths.any? { |exclude| path.include?(exclude) }
+    end
+
+    # Try to strip everything off of the supplied backtrace, until the first application stack entry is at the top.
+    # For example all leading gem paths and built-in ruby code paths are removed from the top.
+    # Once the first application entry is found, the remaining stack is returned.
     def self.strip_backtrace(stack = caller)
-      while (first = stack.first) && system_path?(first)
+      while (first = stack.first) && (strip_path?(first) || extract_path?(first))
         stack.shift
       end
       stack
     end
 
-    GEM_ROOT = File.expand_path("../../..", __dir__) + "/"
+    # Paths to exclude in the stripped backtrace
+    # Includes Gems and built-in Ruby code paths
+    def self.strip_paths
+      @strip_paths ||=
+        begin
+          paths = Gem.path | [Gem.default_dir]
+          paths << RbConfig::CONFIG["rubylibdir"]
+          paths
+        end
+    end
 
-    def self.system_path?(path)
-      path.start_with?(GEM_ROOT) ||
-        path.start_with?(RbConfig::CONFIG["rubylibdir"])
+    # Whether this path should be excluded from any cleansed backtrace
+    def self.strip_path?(path)
+      strip_paths.any? { |exclude| path.start_with?(exclude) }
     end
   end
 end

data/lib/semantic_logger/version.rb

@@ -1,3 +1,3 @@
 module SemanticLogger
-  VERSION = "4.7.2".freeze
+  VERSION = "4.10.0".freeze
 end

data/lib/semantic_logger.rb

@@ -32,6 +32,10 @@ module SemanticLogger
     autoload :Minitest,          "semantic_logger/reporters/minitest"
   end
 
+  module Test
+    autoload :CaptureLogEvents,  "semantic_logger/test/capture_log_events"
+  end
+
   if defined?(JRuby)
     module JRuby
       autoload :GarbageCollectionLogger, "semantic_logger/jruby/garbage_collection_logger"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: semantic_logger
 version: !ruby/object:Gem::Version
-  version: 4.7.2
+  version: 4.10.0
 platform: ruby
 authors:
 - Reid Morrison
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2022-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -24,9 +24,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: 
+description:
 email:
-- reidmo@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -46,11 +45,13 @@ files:
 - lib/semantic_logger/appender/graylog.rb
 - lib/semantic_logger/appender/honeybadger.rb
 - lib/semantic_logger/appender/http.rb
+- lib/semantic_logger/appender/io.rb
 - lib/semantic_logger/appender/kafka.rb
 - lib/semantic_logger/appender/mongodb.rb
 - lib/semantic_logger/appender/new_relic.rb
 - lib/semantic_logger/appender/rabbitmq.rb
 - lib/semantic_logger/appender/sentry.rb
+- lib/semantic_logger/appender/sentry_ruby.rb
 - lib/semantic_logger/appender/splunk.rb
 - lib/semantic_logger/appender/splunk_http.rb
 - lib/semantic_logger/appender/syslog.rb
@@ -68,6 +69,7 @@ files:
 - lib/semantic_logger/formatters/default.rb
 - lib/semantic_logger/formatters/fluentd.rb
 - lib/semantic_logger/formatters/json.rb
+- lib/semantic_logger/formatters/logfmt.rb
 - lib/semantic_logger/formatters/one_line.rb
 - lib/semantic_logger/formatters/raw.rb
 - lib/semantic_logger/formatters/signalfx.rb
@@ -87,13 +89,14 @@ files:
 - lib/semantic_logger/subscriber.rb
 - lib/semantic_logger/sync.rb
 - lib/semantic_logger/sync_processor.rb
+- lib/semantic_logger/test/capture_log_events.rb
 - lib/semantic_logger/utils.rb
 - lib/semantic_logger/version.rb
-homepage: https://github.com/rocketjob/semantic_logger
+homepage: https://logger.rocketjob.io
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,15 +104,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Feature rich logging framework, and replacement for existing Ruby & Rails
   loggers.