semantic_logger 4.6.1 → 4.10.0

data/lib/semantic_logger/appenders.rb

@@ -10,59 +10,63 @@ module SemanticLogger
 
     def add(**args, &block)
       appender = SemanticLogger::Appender.factory(**args, &block)
+
+      if appender.respond_to?(:console_output?) && appender.console_output? && console_output?
+        logger.warn "Ignoring attempt to add a second console appender: #{appender.class.name} since it would result in duplicate console output."
+        return
+      end
+
       self << appender
       appender
     end
 
+    # Whether any of the existing appenders already output to the console?
+    # I.e. Writes to stdout or stderr.
+    def console_output?
+      any? { |appender| appender.respond_to?(:console_output?) && appender.console_output? }
+    end
+
     def log(log)
       each do |appender|
-        begin
-          appender.log(log) if appender.should_log?(log)
-        rescue Exception => exc
-          logger.error "Failed to log to appender: #{appender.name}", exc
-        end
+        appender.log(log) if appender.should_log?(log)
+      rescue Exception => e
+        logger.error "Failed to log to appender: #{appender.name}", e
       end
     end
 
     def flush
       each do |appender|
-        begin
-          logger.trace "Flushing appender: #{appender.name}"
-          appender.flush
-        rescue Exception => exc
-          logger.error "Failed to flush appender: #{appender.name}", exc
-        end
+        logger.trace "Flushing appender: #{appender.name}"
+        appender.flush
+      rescue Exception => e
+        logger.error "Failed to flush appender: #{appender.name}", e
       end
-      logger.trace 'All appenders flushed'
+      logger.trace "All appenders flushed"
     end
 
     def close
-      each do |appender|
-        begin
-          logger.trace "Closing appender: #{appender.name}"
-          appender.flush
-          appender.close
-          delete(appender)
-        rescue Exception => exc
-          logger.error "Failed to close appender: #{appender.name}", exc
-        end
+      to_a.each do |appender|
+        logger.trace "Closing appender: #{appender.name}"
+        delete(appender)
+        appender.flush
+        appender.close
+      rescue Exception => e
+        logger.error "Failed to close appender: #{appender.name}", e
       end
-      logger.trace 'All appenders closed and removed from appender list'
+      logger.trace "All appenders closed and removed from appender list"
     end
 
     # After a fork the appender thread is not running, start it if it is not running.
     def reopen
       each do |appender|
-        begin
-          next unless appender.respond_to?(:reopen)
+        next unless appender.respond_to?(:reopen)
 
-          logger.trace "Reopening appender: #{appender.name}"
-          appender.reopen
-        rescue Exception => exc
-          logger.error "Failed to re-open appender: #{appender.name}", exc
-        end
+        logger.trace "Reopening appender: #{appender.name}"
+        appender.reopen
+      rescue Exception => e
+        logger.error "Failed to re-open appender: #{appender.name}", e
       end
-      logger.trace 'All appenders re-opened'
+      logger.trace "All appenders re-opened"
     end
   end
 end

data/lib/semantic_logger/base.rb

@@ -63,7 +63,7 @@ module SemanticLogger
     #    SemanticLogger.default_level = :info
     #
     #    # Log to screen
-    #    SemanticLogger.add_appender(io: STDOUT, formatter: :color)
+    #    SemanticLogger.add_appender(io: $stdout, formatter: :color)
     #
     #    # And log to a file at the same time
     #    SemanticLogger.add_appender(file_name: 'application.log', formatter: :color)
@@ -126,7 +126,7 @@ module SemanticLogger
     # Log a thread backtrace
     def backtrace(thread: Thread.current,
                   level: :warn,
-                  message: 'Backtrace:',
+                  message: "Backtrace:",
                   payload: nil,
                   metric: nil,
                   metric_amount: nil)
@@ -136,7 +136,7 @@ module SemanticLogger
 
       backtrace =
         if thread == Thread.current
-          Utils.extract_backtrace
+          Utils.extract_backtrace(caller)
         else
           log.thread_name = thread.name
           log.tags        = (thread[:semantic_logger_tags] || []).clone
@@ -188,9 +188,11 @@ module SemanticLogger
     # - For better performance with clean tags, see `SemanticLogger.tagged`.
     def tagged(*tags, &block)
       # Allow named tags to be passed into the logger
-      if tags.size == 1
+      # Rails::Rack::Logger passes logs as an array with a single argument
+      if tags.size == 1 && !tags.first.is_a?(Array)
         tag = tags[0]
-        return yield if tag.nil? || tag == ''
+        return yield if tag.nil? || tag == ""
+
         return tag.is_a?(Hash) ? SemanticLogger.named_tagged(tag, &block) : SemanticLogger.fast_tag(tag.to_s, &block)
       end
 
@@ -240,7 +242,7 @@ module SemanticLogger
 
     # Write log data to underlying data storage
     def log(_log_)
-      raise NotImplementedError, 'Logging Appender must implement #log(log)'
+      raise NotImplementedError, "Logging Appender must implement #log(log)"
     end
 
     # Whether this log entry meets the criteria to be logged by this appender.
@@ -262,14 +264,22 @@ module SemanticLogger
     #    For example if set to :warn, this appender would only log :warn and :fatal
     #    log messages when other appenders could be logging :info and lower
     #
-    #  filter [Regexp|Proc]
+    #  filter [Regexp|Proc|Module]
     #    RegExp: Only include log messages where the class name matches the supplied
     #    regular expression. All other messages will be ignored
     #    Proc: Only include log messages where the supplied Proc returns true
     #          The Proc must return true or false
+    #    Module: A module that implements `.call`. For example:
+    #      module ComplexFilter
+    #        def self.call(log)
+    #          (/\AExclude/ =~ log.message).nil?
+    #        end
+    #      end
     def initialize(klass, level = nil, filter = nil)
-      # Support filtering all messages to this logger using a Regular Expression or Proc
-      raise ':filter must be a Regexp or Proc' unless filter.nil? || filter.is_a?(Regexp) || filter.is_a?(Proc)
+      # Support filtering all messages to this logger instance.
+      unless filter.nil? || filter.is_a?(Regexp) || filter.is_a?(Proc) || filter.respond_to?(:call)
+        raise ":filter must be a Regexp, Proc, or implement :call"
+      end
 
       @filter = filter.is_a?(Regexp) ? filter.freeze : filter
       @name   = klass.is_a?(String) ? klass : klass.name
@@ -302,23 +312,42 @@ module SemanticLogger
     end
 
     # Log message at the specified level
-    def log_internal(level, index, message = nil, payload = nil, exception = nil, &block)
-      log        = Log.new(name, level, index)
+    def log_internal(level, index, message = nil, payload = nil, exception = nil)
+      # Handle variable number of arguments by detecting exception object and payload hash.
+      if exception.nil? && payload.nil? && message.respond_to?(:backtrace) && message.respond_to?(:message)
+        exception = message
+        message   = nil
+      elsif exception.nil? && payload && payload.respond_to?(:backtrace) && payload.respond_to?(:message)
+        exception = payload
+        payload   = nil
+      elsif payload && !payload.is_a?(Hash)
+        message = message.nil? ? payload : "#{message} -- #{payload}"
+        payload = nil
+      end
+
+      log = Log.new(name, level, index)
       should_log =
         if payload.nil? && exception.nil? && message.is_a?(Hash)
-          # Check if someone just logged a hash payload instead of meaning to call semantic logger
-          if message.key?(:message) || message.key?(:payload) || message.key?(:exception) || message.key?(:metric)
-            log.assign(message)
-          else
-            log.assign_positional(nil, message, nil, &block)
-          end
-        elsif exception.nil? && message && payload && payload.is_a?(Hash) &&
-          (payload.key?(:payload) || payload.key?(:exception) || payload.key?(:metric))
-          log.assign(message: message, **payload)
+          # Everything as keyword arguments.
+          log.assign(**log.extract_arguments(message))
+        elsif exception.nil? && message && payload && payload.is_a?(Hash)
+          # Message with keyword arguments as the rest.
+          log.assign(message: message, **log.extract_arguments(payload))
         else
-          log.assign_positional(message, payload, exception, &block)
+          # No keyword arguments.
+          log.assign(message: message, payload: payload, exception: exception)
         end
 
+      # Add result of block to message or payload if not nil
+      if block_given?
+        result = yield(log)
+        if result.is_a?(String)
+          log.message = log.message.nil? ? result : "#{log.message} -- #{result}"
+        elsif result.is_a?(Hash)
+          log.assign_hash(result)
+        end
+      end
+
       # Log level may change during assign due to :on_exception_level
       self.log(log) if should_log && should_log?(log)
     end
@@ -344,18 +373,18 @@ module SemanticLogger
               yield(params)
             end
         end
-      rescue Exception => exc
-        exception = exc
+      rescue Exception => e
+        exception = e
       ensure
         # Must use ensure block otherwise a `return` in the yield above will skip the log entry
-        log       = Log.new(name, level, index)
+        log = Log.new(name, level, index)
         exception ||= params[:exception]
         message   = params[:message] if params[:message]
         duration  =
           if block_given?
             1_000.0 * (Process.clock_gettime(Process::CLOCK_MONOTONIC) - start)
           else
-            params[:duration] || raise('Mandatory block missing when :duration option is not supplied')
+            params[:duration] || raise("Mandatory block missing when :duration option is not supplied")
           end
 
         # Extract options after block completes so that block can modify any of the options
@@ -377,6 +406,7 @@ module SemanticLogger
         # Log level may change during assign due to :on_exception_level
         self.log(log) if should_log && should_log?(log)
         raise exception if exception
+
         result
       end
     end
@@ -395,8 +425,8 @@ module SemanticLogger
       start     = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       begin
         yield
-      rescue Exception => exc
-        exception = exc
+      rescue Exception => e
+        exception = e
       ensure
         log = Log.new(name, level, index)
         # May return false due to elastic logging

data/lib/semantic_logger/formatters/base.rb

@@ -1,8 +1,8 @@
-require 'time'
+require "time"
 module SemanticLogger
   module Formatters
     class Base
-      attr_accessor :time_format, :log_host, :log_application, :log_environment, :precision
+      attr_accessor :log, :logger, :time_format, :log_host, :log_application, :log_environment, :precision
 
       # Time precision varies by Ruby interpreter
       # JRuby 9.1.8.0 supports microseconds
@@ -61,10 +61,16 @@ module SemanticLogger
         format_time(log.time) if time_format
       end
 
+      # Process ID
+      def pid
+        $$
+      end
+
       private
 
       # Return the Time as a formatted string
       def format_time(time)
+        time = time.dup
         case time_format
         when :rfc_3339
           time.utc.to_datetime.rfc3339
@@ -77,7 +83,7 @@ module SemanticLogger
         when :seconds
           time.to_f
         when nil
-          ''
+          ""
         else
           time.strftime(time_format)
         end

data/lib/semantic_logger/formatters/color.rb

@@ -1,8 +1,12 @@
-# Load AwesomePrint if available
+# Load Amazing Print, or Awesome Print if available
 begin
-  require 'awesome_print'
+  require "amazing_print"
 rescue LoadError
-  nil
+  begin
+    require "awesome_print"
+  rescue LoadError
+    nil
+  end
 end
 
 module SemanticLogger
@@ -61,9 +65,9 @@ module SemanticLogger
       #
       # Parameters:
       #  ap: [Hash]
-      #    Any valid AwesomePrint option for rendering data.
+      #    Any valid Amazing Print option for rendering data.
       #    These options can also be changed be creating a `~/.aprc` file.
-      #    See: https://github.com/michaeldv/awesome_print
+      #    See: https://github.com/amazing-print/amazing_print
       #
       #    Note: The option :multiline is set to false if not supplied.
       #    Note: Has no effect if Awesome Print is not installed.
@@ -105,14 +109,14 @@ module SemanticLogger
       def payload
         return unless log.payload?
 
-        if !defined?(AwesomePrint) || !log.payload.respond_to?(:ai)
-          super
-        else
+        if log.payload.respond_to?(:ai)
           begin
             "-- #{log.payload.ai(@ai_options)}"
           rescue StandardError
             super
           end
+        else
+          super
         end
       end
 

data/lib/semantic_logger/formatters/default.rb

@@ -2,8 +2,6 @@ module SemanticLogger
   module Formatters
     # Default non-colored text log output
     class Default < Base
-      attr_accessor :log, :logger
-
       # Formatting methods, must return nil, or a string
       # Nil values are ignored
 
@@ -12,9 +10,24 @@ module SemanticLogger
         log.level_to_s
       end
 
-      # Process info
+      # Name of the thread that logged the message.
+      def thread_name
+        format("%.30s", log.thread_name)
+      end
+
+      # Ruby file name and line number that logged the message.
+      def file_name_and_line
+        file, line = log.file_name_and_line(true)
+        "#{file}:#{line}" if file
+      end
+
+      # Returns [String] the available process info
+      # Example:
+      #    [18934:thread_name test_logging.rb:51]
       def process_info
-        "[#{log.process_info}]"
+        process_id = "#{pid}:" if pid
+        fname      = file_name_and_line
+        fname ? "[#{process_id}#{thread_name} #{fname}]" : "[#{process_id}#{thread_name}]"
       end
 
       # Tags
@@ -67,7 +80,7 @@ module SemanticLogger
         self.log    = log
         self.logger = logger
 
-        [time, level, process_info, tags, named_tags, duration, name, message, payload, exception].compact.join(' ')
+        [time, level, process_info, tags, named_tags, duration, name, message, payload, exception].compact.join(" ")
       end
     end
   end

data/lib/semantic_logger/formatters/fluentd.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 
 module SemanticLogger
   module Formatters
@@ -13,8 +13,8 @@ module SemanticLogger
       end
 
       def level
-        hash['severity']       = log.level
-        hash['severity_index'] = log.level_index
+        hash["severity"]       = log.level
+        hash["severity_index"] = log.level_index
       end
 
       def process_info

data/lib/semantic_logger/formatters/json.rb

@@ -1,4 +1,4 @@
-require 'json'
+require "json"
 module SemanticLogger
   module Formatters
     class Json < Raw

data/lib/semantic_logger/formatters/logfmt.rb

@@ -0,0 +1,72 @@
+require "json"
+
+module SemanticLogger
+  module Formatters
+    # Produces logfmt formatted messages
+    #
+    # The following fields are extracted from the raw log and included in the formatted message:
+    #   :timestamp, :level, :name, :message, :duration, :tags, :named_tags
+    #
+    # E.g.
+    #   timestamp="2020-07-20T08:32:05.375276Z" level=info name="DefaultTest" base="breakfast" spaces="second breakfast" double_quotes="\"elevensies\"" single_quotes="'lunch'" tag="success"
+    #
+    # All timestamps are ISO8601 formatteed
+    # All user supplied values are escaped and surrounded by double quotes to avoid ambiguious message delimeters
+    # `tags` are treated as keys with boolean values. Tag names are not formatted or validated, ensure you use valid logfmt format for tag names.
+    # `named_tags` are flattened are merged into the top level message field. Any conflicting fields are overridden.
+    # `payload` values take precedence over `tags` and `named_tags`. Any conflicting fields are overridden.
+    #
+    # Futher Reading https://brandur.org/logfmt
+    class Logfmt < Raw
+      def initialize(time_format: :iso_8601, time_key: :timestamp, **args)
+        super(time_format: time_format, time_key: time_key, **args)
+      end
+
+      def call(log, logger)
+        @raw = super(log, logger)
+
+        raw_to_logfmt
+      end
+
+      private
+
+      def raw_to_logfmt
+        @parsed = @raw.slice(time_key, :level, :name, :message, :duration).merge(tag: "success")
+        handle_tags
+        handle_payload
+        handle_exception
+
+        flatten_log
+      end
+
+      def handle_tags
+        tags = @raw.fetch(:tags){ [] }
+                    .each_with_object({}){ |tag, accum| accum[tag] = true }
+
+        @parsed = @parsed.merge(tags)
+                         .merge(@raw.fetch(:named_tags){ {} })
+      end
+
+      def handle_payload
+        return unless @raw.key? :payload
+
+        @parsed = @parsed.merge(@raw[:payload])
+      end
+
+      def handle_exception
+        return unless @raw.key? :exception
+
+        @parsed[:tag] = "exception"
+        @parsed = @parsed.merge(@raw[:exception])
+      end
+
+      def flatten_log
+        flattened = @parsed.map do |key, value|
+          "#{key}=#{value.to_json}"
+        end
+
+        flattened.join(" ")
+      end
+    end
+  end
+end

data/lib/semantic_logger/formatters/raw.rb

@@ -1,9 +1,9 @@
-require 'json'
+require "json"
 module SemanticLogger
   module Formatters
     class Raw < Base
       # Fields are added by populating this hash.
-      attr_accessor :hash, :log, :logger, :time_key
+      attr_accessor :hash, :time_key
 
       # By default Raw formatter does not reformat the time
       def initialize(time_format: :none, time_key: :time, **args)
@@ -37,11 +37,18 @@ module SemanticLogger
         hash[:level_index] = log.level_index
       end
 
-      # Process info
-      def process_info
-        hash[:pid]    = $$
+      # Process ID
+      def pid
+        hash[:pid] = super
+      end
+
+      # Name of the thread that logged the message.
+      def thread_name
         hash[:thread] = log.thread_name
+      end
 
+      # Ruby file name and line number that logged the message.
+      def file_name_and_line
         file, line = log.file_name_and_line
         return unless file
 
@@ -85,6 +92,7 @@ module SemanticLogger
       # Exception
       def exception
         return unless log.exception
+
         root = hash
         log.each_exception do |exception, i|
           name       = i.zero? ? :exception : :cause
@@ -93,7 +101,7 @@ module SemanticLogger
             message:     exception.message,
             stack_trace: exception.backtrace
           }
-          root       = root[name]
+          root = root[name]
         end
       end
 
@@ -109,7 +117,23 @@ module SemanticLogger
         self.log    = log
         self.logger = logger
 
-        host; application; environment; time; level; process_info; duration; tags; named_tags; name; message; payload; exception; metric
+        host
+        application
+        environment
+        time
+        level
+        pid
+        thread_name
+        file_name_and_line
+        duration
+        tags
+        named_tags
+        name
+        message
+        payload
+        exception
+        metric
+
         hash
       end
     end

data/lib/semantic_logger/formatters/signalfx.rb

@@ -1,13 +1,13 @@
-require 'json'
+require "json"
 module SemanticLogger
   module Formatters
     class Signalfx < Base
-      attr_accessor :token, :dimensions, :hash, :log, :logger, :gauge_name, :counter_name
+      attr_accessor :token, :dimensions, :hash, :gauge_name, :counter_name
 
       def initialize(token:,
                      dimensions: nil,
-                     gauge_name: 'Application.average',
-                     counter_name: 'Application.counter',
+                     gauge_name: "Application.average",
+                     counter_name: "Application.counter",
                      time_format: :ms,
                      **args)
 
@@ -23,19 +23,19 @@ module SemanticLogger
       #   Strip leading '/'
       #   Convert remaining '/' to '.'
       def metric
-        name = log.metric.to_s.sub(/\A\/+/, '')
+        name = log.metric.to_s.sub(%r{\A/+}, "")
         if log.dimensions
-          name.tr!('/', '.')
+          name.tr!("/", ".")
           hash[:metric] = name
         else
           # Extract class and action from metric name
-          names = name.split('/')
+          names = name.split("/")
           h     = (hash[:dimensions] ||= {})
           if names.size > 1
             h[:action] = names.pop
-            h[:class]  = names.join('::')
+            h[:class]  = names.join("::")
           else
-            h[:class]  = 'Unknown'
+            h[:class]  = "Unknown"
             h[:action] = names.first || log.metric
           end
 
@@ -67,6 +67,7 @@ module SemanticLogger
             name  = name.to_sym
             value = value.to_s
             next if value.empty?
+
             h[name] = value if dimensions&.include?(name)
           end
         end

data/lib/semantic_logger/formatters/syslog.rb

@@ -1,13 +1,14 @@
 begin
-  require 'syslog_protocol'
+  require "syslog_protocol"
 rescue LoadError
-  raise LoadError.new('Gem syslog_protocol is required for remote logging using the Syslog protocol. Please add the gem "syslog_protocol" to your Gemfile.')
+  raise LoadError,
+        'Gem syslog_protocol is required for remote logging using the Syslog protocol. Please add the gem "syslog_protocol" to your Gemfile.'
 end
 
 module SemanticLogger
   module Formatters
     class Syslog < Default
-      attr_accessor :level_map, :facility
+      attr_accessor :level_map, :facility, :max_size
 
       # Default level map for every log level
       #
@@ -50,9 +51,10 @@ module SemanticLogger
       #   Example:
       #     # Change the warn level to LOG_NOTICE level instead of a the default of LOG_WARNING.
       #     SemanticLogger.add_appender(appender: :syslog, level_map: {warn: ::Syslog::LOG_NOTICE})
-      def initialize(facility: ::Syslog::LOG_USER, level_map: LevelMap.new)
+      def initialize(facility: ::Syslog::LOG_USER, level_map: LevelMap.new, max_size: Integer)
         @facility  = facility
         @level_map = level_map.is_a?(LevelMap) ? level_map : LevelMap.new(level_map)
+        @max_size = max_size
         super()
       end
 
@@ -73,11 +75,11 @@ module SemanticLogger
         packet          = SyslogProtocol::Packet.new
         packet.hostname = logger.host
         packet.facility = facility
-        packet.tag      = logger.application.delete(' ')
+        packet.tag      = logger.application.delete(" ")
         packet.content  = message
         packet.time     = log.time
         packet.severity = level_map[log.level]
-        packet.to_s
+        packet.assemble(@max_size)
       end
     end
   end