semantic_logger 4.5.0 → 4.7.1

data/lib/semantic_logger/appender/udp.rb

@@ -1,4 +1,4 @@
-require 'socket'
+require "socket"
 module SemanticLogger
   module Appender
     # UDP log appender.
@@ -74,7 +74,7 @@ module SemanticLogger
       def reopen
         close
         @socket    = UDPSocket.new
-        host, port = server.split(':')
+        host, port = server.split(":")
         @socket.connect(host, port.to_i)
       end
 

data/lib/semantic_logger/appenders.rb

@@ -8,9 +8,8 @@ module SemanticLogger
       @logger.name = self.class.name
     end
 
-    def add(options, deprecated_level = nil, &block)
-      options  = options.is_a?(Hash) ? options.dup : convert_old_appender_args(options, deprecated_level)
-      appender = SemanticLogger::Appender.factory(options, &block)
+    def add(**args, &block)
+      appender = SemanticLogger::Appender.factory(**args, &block)
       self << appender
       appender
     end
@@ -19,8 +18,8 @@ module SemanticLogger
       each do |appender|
         begin
           appender.log(log) if appender.should_log?(log)
-        rescue Exception => exc
-          logger.error "Failed to log to appender: #{appender.inspect}", exc
+        rescue Exception => e
+          logger.error "Failed to log to appender: #{appender.name}", e
         end
       end
     end
@@ -30,11 +29,11 @@ module SemanticLogger
         begin
           logger.trace "Flushing appender: #{appender.name}"
           appender.flush
-        rescue Exception => exc
-          logger.error "Failed to flush appender: #{appender.inspect}", exc
+        rescue Exception => e
+          logger.error "Failed to flush appender: #{appender.name}", e
         end
       end
-      logger.trace 'All appenders flushed'
+      logger.trace "All appenders flushed"
     end
 
     def close
@@ -44,11 +43,11 @@ module SemanticLogger
           appender.flush
           appender.close
           delete(appender)
-        rescue Exception => exc
-          logger.error "Failed to close appender: #{appender.inspect}", exc
+        rescue Exception => e
+          logger.error "Failed to close appender: #{appender.name}", e
         end
       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.
@@ -59,31 +58,11 @@ module SemanticLogger
 
           logger.trace "Reopening appender: #{appender.name}"
           appender.reopen
-        rescue Exception => exc
-          logger.error "Failed to re-open appender: #{appender.inspect}", exc
+        rescue Exception => e
+          logger.error "Failed to re-open appender: #{appender.name}", e
         end
       end
-      logger.trace 'All appenders re-opened'
-    end
-
-    private
-
-    # Backward compatibility
-    def convert_old_appender_args(appender, level)
-      options         = {}
-      options[:level] = level if level
-
-      if appender.is_a?(String)
-        options[:file_name] = appender
-      elsif appender.is_a?(IO)
-        options[:io] = appender
-      elsif appender.is_a?(Symbol) || appender.is_a?(Subscriber)
-        options[:appender] = appender
-      else
-        options[:logger] = appender
-      end
-      warn "[DEPRECATED] SemanticLogger.add_appender parameters have changed. Please use: #{options.inspect}"
-      options
+      logger.trace "All appenders re-opened"
     end
   end
 end

data/lib/semantic_logger/base.rb

@@ -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)
@@ -190,7 +190,8 @@ module SemanticLogger
       # Allow named tags to be passed into the logger
       if tags.size == 1
         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
 
@@ -233,26 +234,14 @@ module SemanticLogger
       SemanticLogger.silence(new_level, &block)
     end
 
-    # Deprecated. Use `SemanticLogger.tagged`
+    # :nodoc:
     def fast_tag(tag, &block)
       SemanticLogger.fast_tag(tag, &block)
     end
 
-    # :nodoc:
-    def with_payload(payload, &block)
-      warn '#with_payload is deprecated, use SemanticLogger.named_tagged'
-      SemanticLogger.named_tagged(payload, &block)
-    end
-
-    # :nodoc:
-    def payload
-      warn '#payload is deprecated, use SemanticLogger.named_tags'
-      SemanticLogger.named_tags
-    end
-
     # 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.
@@ -281,7 +270,7 @@ module SemanticLogger
     #          The Proc must return true or false
     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)
+      raise ":filter must be a Regexp or Proc" unless filter.nil? || filter.is_a?(Regexp) || filter.is_a?(Proc)
 
       @filter = filter.is_a?(Regexp) ? filter.freeze : filter
       @name   = klass.is_a?(String) ? klass : klass.name
@@ -314,20 +303,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
+          # 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
@@ -353,8 +364,8 @@ 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)
@@ -364,7 +375,7 @@ module SemanticLogger
           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
@@ -386,6 +397,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
@@ -404,8 +416,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.rb

@@ -1,15 +1,15 @@
 module SemanticLogger
   module Formatters
     # @formatter:off
-    autoload :Base,             'semantic_logger/formatters/base'
-    autoload :Color,            'semantic_logger/formatters/color'
-    autoload :Default,          'semantic_logger/formatters/default'
-    autoload :Json,             'semantic_logger/formatters/json'
-    autoload :Raw,              'semantic_logger/formatters/raw'
-    autoload :OneLine,          'semantic_logger/formatters/one_line'
-    autoload :Signalfx,         'semantic_logger/formatters/signalfx'
-    autoload :Syslog,           'semantic_logger/formatters/syslog'
-    autoload :Fluentd,          'semantic_logger/formatters/fluentd'
+    autoload :Base,             "semantic_logger/formatters/base"
+    autoload :Color,            "semantic_logger/formatters/color"
+    autoload :Default,          "semantic_logger/formatters/default"
+    autoload :Json,             "semantic_logger/formatters/json"
+    autoload :Raw,              "semantic_logger/formatters/raw"
+    autoload :OneLine,          "semantic_logger/formatters/one_line"
+    autoload :Signalfx,         "semantic_logger/formatters/signalfx"
+    autoload :Syslog,           "semantic_logger/formatters/syslog"
+    autoload :Fluentd,          "semantic_logger/formatters/fluentd"
     # @formatter:on
 
     # Return formatter that responds to call.
@@ -22,10 +22,10 @@ module SemanticLogger
     # - Any object that responds to :call
     def self.factory(formatter)
       if formatter.is_a?(Symbol)
-        SemanticLogger::Utils.constantize_symbol(formatter, 'SemanticLogger::Formatters').new
+        SemanticLogger::Utils.constantize_symbol(formatter, "SemanticLogger::Formatters").new
       elsif formatter.is_a?(Hash) && formatter.size.positive?
         fmt, options = formatter.first
-        SemanticLogger::Utils.constantize_symbol(fmt.to_sym, 'SemanticLogger::Formatters').new(options)
+        SemanticLogger::Utils.constantize_symbol(fmt.to_sym, "SemanticLogger::Formatters").new(**options)
       elsif formatter.respond_to?(:call)
         formatter
       else

data/lib/semantic_logger/formatters/base.rb

@@ -1,12 +1,12 @@
-require 'time'
+require "time"
 module SemanticLogger
   module Formatters
     class Base
-      attr_accessor :time_format, :log_host, :log_application, :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
-      PRECISION   =
+      PRECISION =
         if defined?(JRuby)
           if JRUBY_VERSION.to_f >= 9.1
             maint = JRUBY_VERSION.match(/\A\d+\.\d+\.(\d+)\./)[1].to_i
@@ -34,11 +34,15 @@ module SemanticLogger
       #   precision: [Integer]
       #     How many fractional digits to log times with.
       #     Default: PRECISION (6, except on older JRuby, where 3)
-      def initialize(time_format: nil, log_host: true, log_application: true,
+      def initialize(time_format: nil,
+                     log_host: true,
+                     log_application: true,
+                     log_environment: true,
                      precision: PRECISION)
         @time_format     = time_format || self.class.build_time_format(precision)
         @log_host        = log_host
         @log_application = log_application
+        @log_environment = log_environment
         @precision       = precision
       end
 
@@ -48,7 +52,7 @@ module SemanticLogger
       #   precision: [Integer]
       #     How many fractional digits to log times with.
       #     Default: PRECISION (6, except on older JRuby, where 3)
-      def self.build_time_format(precision=PRECISION)
+      def self.build_time_format(precision = PRECISION)
         "%Y-%m-%d %H:%M:%S.%#{precision}N"
       end
 
@@ -57,6 +61,11 @@ module SemanticLogger
         format_time(log.time) if time_format
       end
 
+      # Process ID
+      def pid
+        $$
+      end
+
       private
 
       # Return the Time as a formatted string
@@ -73,7 +82,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,24 +65,19 @@ 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.
       #
       #  color_map: [Hash | SemanticLogger::Formatters::Color::ColorMap]
       #    ColorMaps each of the log levels to a color
-      def initialize(ap: {multiline: false},
-                     color_map: ColorMap.new,
-                     time_format: nil,
-                     log_host: false,
-                     log_application: false,
-                     precision: PRECISION)
+      def initialize(ap: {multiline: false}, color_map: ColorMap.new, **args)
         @ai_options = ap
         @color_map  = color_map.is_a?(ColorMap) ? color_map : ColorMap.new(color_map)
-        super(time_format: time_format, log_host: log_host, log_application: log_application, precision: precision)
+        super(**args)
       end
 
       def level
@@ -110,7 +109,7 @@ module SemanticLogger
       def payload
         return unless log.payload?
 
-        if !defined?(AwesomePrint) || !log.payload.respond_to?(:ai)
+        if !log.payload.respond_to?(:ai)
           super
         else
           begin

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,37 +1,26 @@
-require 'json'
+require "json"
 
 module SemanticLogger
   module Formatters
-    # Fluentd is similar to SemanticLogger::Formatters::Json but with log level that are recongnized
+    # Fluentd is similar to SemanticLogger::Formatters::Json but with log levels that are recognized
     # by kubernetes fluentd.
     class Fluentd < Json
       attr_reader :need_process_info
 
-      def initialize(log_host: true, log_application: true, need_process_info: false)
+      def initialize(time_format: :rfc_3339, time_key: :time, need_process_info: false, **args)
         @need_process_info = need_process_info
-        super(log_host: log_host, log_application: log_application, time_key: 'time', time_format: :rfc_3339)
+        super(time_format: time_format, time_key: time_key, **args)
       end
 
-      def severity
-        hash['severity'] = log.level
-        hash['severity_index'] = log.level_index
+      def level
+        hash["severity"]       = log.level
+        hash["severity_index"] = log.level_index
       end
 
       def process_info
         # Ignore fields: pid, thread, file and line by default
         super() if need_process_info
       end
-
-      def call(log, logger)
-        self.hash   = {}
-        self.log    = log
-        self.logger = logger
-
-        host; application; time; severity; process_info; duration; tags; named_tags; name; message; payload; exception; metric
-        hash
-
-        hash.to_json
-      end
     end
   end
 end