semantic_logger 4.6.1 → 4.10.0

data/lib/semantic_logger/formatters/syslog_cee.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 SyslogCee < Raw
-      attr_accessor :level_map, :facility
+      attr_accessor :level_map, :facility, :max_size
 
       # CEE JSON Syslog format
       #   Untested prototype code. Based on documentation only.
@@ -23,9 +24,10 @@ module SemanticLogger
       # Example:
       #   # Log via udp to a remote syslog server on host: `server1` and port `8514`, using the CEE format.
       #   SemanticLogger.add_appender(appender: :syslog, formatter: syslog_cee, url: 'udp://server1:8514')
-      def initialize(facility: ::Syslog::LOG_USER, level_map: SemanticLogger::Formatters::Syslog::LevelMap.new)
+      def initialize(facility: ::Syslog::LOG_USER, level_map: SemanticLogger::Formatters::Syslog::LevelMap.new, max_size: Integer)
         @facility  = facility
         @level_map = level_map.is_a?(SemanticLogger::Formatters::Syslog::LevelMap) ? level_map : SemanticLogger::Formatters::Syslog::LevelMap.new(level_map)
+        @max_size = max_size
         super()
       end
 
@@ -45,11 +47,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

data/lib/semantic_logger/formatters.rb

@@ -1,16 +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'
-    # @formatter:on
+    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 :Logfmt,   "semantic_logger/formatters/logfmt"
 
     # Return formatter that responds to call.
     #
@@ -22,10 +21,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/jruby/garbage_collection_logger.rb

@@ -12,7 +12,9 @@ module SemanticLogger
       # Must leave the method name as-is so that it can be found by Java
       def handleNotification(notification, _)
         # Only care about GARBAGE_COLLECTION_NOTIFICATION notifications
-        return unless notification.get_type == Java::ComSunManagement::GarbageCollectionNotificationInfo::GARBAGE_COLLECTION_NOTIFICATION
+        unless notification.get_type == Java::ComSunManagement::GarbageCollectionNotificationInfo::GARBAGE_COLLECTION_NOTIFICATION
+          return
+        end
 
         info     = Java::ComSunManagement::GarbageCollectionNotificationInfo.from(notification.user_data)
         gc_info  = info.gc_info
@@ -20,7 +22,7 @@ module SemanticLogger
 
         return unless duration >= @min_microseconds
 
-        SemanticLogger['GarbageCollector'].measure_warn(
+        SemanticLogger["GarbageCollector"].measure_warn(
           "Garbage Collection completed: #{info.gc_name} ##{gc_info.id}",
           duration: duration.to_f / 1000
         )

data/lib/semantic_logger/levels.rb

@@ -16,17 +16,19 @@ module SemanticLogger
           LEVELS.index(level)
         elsif level.is_a?(Integer) && defined?(::Logger::Severity)
           # Mapping of Rails and Ruby Logger levels to SemanticLogger levels
-          @map_levels ||= begin
-            levels = []
-            ::Logger::Severity.constants.each do |constant|
-              levels[::Logger::Severity.const_get(constant)] =
-                LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error)
+          @map_levels ||=
+            begin
+              levels = []
+              ::Logger::Severity.constants.each do |constant|
+                levels[::Logger::Severity.const_get(constant)] =
+                  LEVELS.find_index(constant.downcase.to_sym) || LEVELS.find_index(:error)
+              end
+              levels
             end
-            levels
-          end
           @map_levels[level]
         end
       raise "Invalid level:#{level.inspect} being requested. Must be one of #{LEVELS.inspect}" unless index
+
       index
     end
 

data/lib/semantic_logger/log.rb

@@ -47,6 +47,12 @@ module SemanticLogger
   # context [Hash]
   #   Named contexts that were captured when the log entry was created.
   class Log
+    # Keys passed in without a payload that will be extracted and the remainder passed into the payload.
+    NON_PAYLOAD_KEYS = %i[message exception backtrace exception
+                          duration min_duration
+                          log_exception on_exception_level
+                          metric metric_amount dimensions].freeze
+
     attr_accessor :level, :level_index, :name, :message, :time, :duration,
                   :payload, :exception, :thread_name, :backtrace,
                   :tags, :named_tags, :context,
@@ -79,20 +85,13 @@ module SemanticLogger
                log_exception: :full,
                on_exception_level: nil,
                dimensions: nil)
-      # Elastic logging: Log when :duration exceeds :min_duration
-      # Except if there is an exception when it will always be logged
-      if duration
-        self.duration = duration
-        return false if (duration < min_duration) && exception.nil?
-      end
 
-      self.message = message
-      if payload && payload.is_a?(Hash)
-        self.payload = payload
-      elsif payload
-        self.message = message.nil? ? payload.to_s : "#{message} -- #{payload}"
-        self.payload = nil
-      end
+      self.message       = message
+      self.payload       = payload
+      self.duration      = duration
+      self.metric        = metric
+      self.metric_amount = metric_amount
+      self.dimensions    = dimensions
 
       if exception
         case log_exception
@@ -113,57 +112,43 @@ module SemanticLogger
         end
       end
 
+      # Elastic logging: Log when :duration exceeds :min_duration
+      # Except if there is an exception when it will always be logged
+      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
-      end
-
-      if metric
-        self.metric        = metric
-        self.metric_amount = metric_amount
-        self.dimensions    = dimensions
+        self.backtrace = Utils.extract_backtrace(caller)
       end
 
       true
     end
 
-    # Assign positional arguments to this log entry, supplying defaults where applicable
-    #
-    # Returns [true|false] whether this log entry should be logged
-    #
-    # Example:
-    #   logger.info('value', :debug, 0, "hello world")
-    def assign_positional(message = nil, payload = nil, exception = nil)
-      # Exception being logged?
-      # Under JRuby a java exception is not a Ruby Exception
-      #   Java::JavaLang::ClassCastException.new.is_a?(Exception) => false
-      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
-
-      # Add result of block as message or payload if not nil
-      if block_given? && (result = yield)
-        if result.is_a?(String)
-          message = message.nil? ? result : "#{message} -- #{result}"
-          assign(message: message, payload: payload, exception: exception)
-        elsif message.nil? && result.is_a?(Hash) && %i[message payload exception].any? { |k| result.key? k }
-          assign(result)
-        elsif payload&.respond_to?(:merge)
-          assign(message: message, payload: payload.merge(result), exception: exception)
+    # Assign known keys to self, all other keys to the payload.
+    def assign_hash(hash)
+      self.payload ||= {}
+      hash.each_pair do |key, value|
+        if respond_to?("#{key}=".to_sym)
+          public_send("#{key}=".to_sym, value)
         else
-          assign(message: message, payload: result, exception: exception)
+          payload[key] = value
         end
-      else
-        assign(message: message, payload: payload, exception: exception)
       end
+      self.payload = nil if payload.empty?
+      self
+    end
+
+    # Extract the arguments from a Hash Payload
+    def extract_arguments(payload)
+      raise(ArgumentError, "payload must be a Hash") unless payload.is_a?(Hash)
+
+      return payload if payload.key?(:payload)
+
+      args = {}
+      payload.each_key { |key| args[key] = payload.delete(key) if NON_PAYLOAD_KEYS.include?(key) }
+      args[:payload] = payload unless payload.empty?
+      args
     end
 
     MAX_EXCEPTIONS_TO_UNWRAP = 5
@@ -191,7 +176,7 @@ module SemanticLogger
 
     # Returns [String] the exception backtrace including all of the child / caused by exceptions
     def backtrace_to_s
-      trace = ''
+      trace = ""
       each_exception do |exception, i|
         if i.zero?
           trace = (exception.backtrace || []).join("\n")
@@ -212,6 +197,7 @@ module SemanticLogger
     else
       def duration_to_s
         return unless duration
+
         duration < 10.0 ? "#{format('%.3f', duration)}ms" : "#{format('%.1f', duration)}ms"
       end
     end
@@ -219,13 +205,14 @@ module SemanticLogger
     # Returns [String] the duration in human readable form
     def duration_human
       return nil unless duration
+
       seconds = duration / 1000
       if seconds >= 86_400.0 # 1 day
         "#{(seconds / 86_400).to_i}d #{Time.at(seconds).strftime('%-Hh %-Mm')}"
       elsif seconds >= 3600.0 # 1 hour
-        Time.at(seconds).strftime('%-Hh %-Mm')
+        Time.at(seconds).strftime("%-Hh %-Mm")
       elsif seconds >= 60.0 # 1 minute
-        Time.at(seconds).strftime('%-Mm %-Ss')
+        Time.at(seconds).strftime("%-Mm %-Ss")
       elsif seconds >= 1.0 # 1 second
         "#{format('%.3f', seconds)}s"
       else
@@ -238,9 +225,7 @@ module SemanticLogger
       level.to_s[0..0].upcase
     end
 
-    # Returns [String] the available process info
-    # Example:
-    #    18934:thread 23 test_logging.rb:51
+    # DEPRECATED
     def process_info(thread_name_length = 30)
       file, line = file_name_and_line(true)
       file_name  = " #{file}:#{line}" if file
@@ -248,7 +233,7 @@ module SemanticLogger
       "#{$$}:#{format("%.#{thread_name_length}s", thread_name)}#{file_name}"
     end
 
-    CALLER_REGEXP = /^(.*):(\d+).*/
+    CALLER_REGEXP = /^(.*):(\d+).*/.freeze
 
     # Extract the filename and line number from the last entry in the supplied backtrace
     def extract_file_and_line(stack, short_name = false)
@@ -265,7 +250,7 @@ module SemanticLogger
 
     # Strip the standard Rails colorizing from the logged message
     def cleansed_message
-      message.to_s.gsub(/(\e(\[([\d;]*[mz]?))?)?/, '').strip
+      message.to_s.gsub(/(\e(\[([\d;]*[mz]?))?)?/, "").strip
     end
 
     # Return the payload in text form
@@ -279,6 +264,11 @@ module SemanticLogger
       !(payload.nil? || (payload.respond_to?(:empty?) && payload.empty?))
     end
 
+    def to_h(host = SemanticLogger.host, application = SemanticLogger.application, environment = SemanticLogger.environment)
+      logger = Struct.new(:host, :application, :environment).new(host, application, environment)
+      SemanticLogger::Formatters::Raw.new.call(self, logger)
+    end
+
     # Lazy initializes the context hash and assigns a key value pair.
     def set_context(key, value)
       (self.context ||= {})[key] = value

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

@@ -1,4 +1,4 @@
-require 'concurrent'
+require "concurrent"
 module SemanticLogger
   # Logger stores the class name to be used for all log messages so that every
   # log message written by this instance will include the class name
@@ -9,7 +9,7 @@ module SemanticLogger
       subscriber = block || object
 
       unless subscriber.is_a?(Proc) || subscriber.respond_to?(:call)
-        raise('When supplying an on_log subscriber, it must support the #call method')
+        raise("When supplying an on_log subscriber, it must support the #call method")
       end
 
       subscribers = (@subscribers ||= Concurrent::Array.new)
@@ -21,7 +21,19 @@ module SemanticLogger
     end
 
     def self.processor
-      @processor
+      @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
@@ -63,20 +75,16 @@ module SemanticLogger
       Logger.processor.log(log)
     end
 
-    private
-
-    @processor   = Processor.new
+    @processor   = nil
     @subscribers = nil
 
     def self.call_subscribers(log)
       return unless @subscribers
 
       @subscribers.each do |subscriber|
-        begin
-          subscriber.call(log)
-        rescue Exception => exc
-          self.class.processor.logger.error('Exception calling :on_log subscriber', exc)
-        end
+        subscriber.call(log)
+      rescue Exception => e
+        processor.logger.error("Exception calling :on_log subscriber", e)
       end
     end
   end

data/lib/semantic_logger/metric/new_relic.rb

@@ -1,7 +1,7 @@
 begin
-  require 'newrelic_rpm'
+  require "newrelic_rpm"
 rescue LoadError
-  raise LoadError.new('Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.')
+  raise LoadError, 'Gem newrelic_rpm is required for logging to New Relic. Please add the gem "newrelic_rpm" to your Gemfile.'
 end
 
 # Send Metrics to NewRelic
@@ -37,7 +37,7 @@ module SemanticLogger
       #     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.
-      def initialize(prefix: 'Custom', **args, &block)
+      def initialize(prefix: "Custom", **args, &block)
         @prefix = prefix
         super(**args, &block)
       end

data/lib/semantic_logger/metric/signalfx.rb

@@ -10,7 +10,7 @@ module SemanticLogger
     class Signalfx < SemanticLogger::Appender::Http
       attr_reader :full_url
 
-      END_POINT = 'v2/datapoint'.freeze
+      END_POINT = "v2/datapoint".freeze
 
       # Create SignalFx metrics appender.
       #
@@ -75,7 +75,7 @@ module SemanticLogger
       #   end
       def initialize(token:,
                      dimensions: nil,
-                     url: 'https://ingest.signalfx.com',
+                     url: "https://ingest.signalfx.com",
                      formatter: nil,
                      **args,
                      &block)
@@ -84,7 +84,7 @@ module SemanticLogger
 
         super(url: url, formatter: formatter, **args, &block)
 
-        @header['X-SF-TOKEN'] = token
+        @header["X-SF-TOKEN"] = token
         @full_url             = "#{url}/#{END_POINT}"
       end
 

data/lib/semantic_logger/metric/statsd.rb

@@ -1,8 +1,8 @@
-require 'uri'
+require "uri"
 begin
-  require 'statsd-ruby'
+  require "statsd-ruby"
 rescue LoadError
-  raise LoadError.new('Gem statsd-ruby is required for logging metrics. Please add the gem "statsd-ruby" to your Gemfile.')
+  raise LoadError, 'Gem statsd-ruby is required for logging metrics. Please add the gem "statsd-ruby" to your Gemfile.'
 end
 
 module SemanticLogger
@@ -26,17 +26,17 @@ module SemanticLogger
       #     metric: :statsd,
       #     url:    'localhost:8125'
       #   )
-      def initialize(url: 'udp://localhost:8125')
+      def initialize(url: "udp://localhost:8125")
         @url = url
       end
 
       def reopen
         uri = URI.parse(@url)
-        raise('Statsd only supports udp. Example: "udp://localhost:8125"') if uri.scheme != 'udp'
+        raise('Statsd only supports udp. Example: "udp://localhost:8125"') if uri.scheme != "udp"
 
         @statsd           = ::Statsd.new(uri.host, uri.port)
-        path              = uri.path.chomp('/')
-        @statsd.namespace = path.sub('/', '') if path != ''
+        path              = uri.path.chomp("/")
+        @statsd.namespace = path.sub("/", "") if path != ""
       end
 
       def log(log)

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,13 +11,14 @@ 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.name = name
-        l
-      end
+      @logger ||=
+        begin
+          l      = SemanticLogger::Appender::IO.new($stderr, level: :warn)
+          l.name = name
+          l
+        end
     end
 
     attr_reader :appenders
@@ -30,6 +31,7 @@ module SemanticLogger
     # Start the appender thread
     def start
       return false if active?
+
       thread
       true
     end

data/lib/semantic_logger/reporters/minitest.rb

@@ -23,7 +23,7 @@ module SemanticLogger
     class Minitest < ::Minitest::AbstractReporter
       include SemanticLogger::Loggable
 
-      logger.name = 'Minitest'
+      logger.name = "Minitest"
 
       attr_accessor :io
 
@@ -33,11 +33,11 @@ module SemanticLogger
 
       def after_test(test)
         if test.error?
-          logger.benchmark_error("FAIL #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: 'minitest/fail')
+          logger.benchmark_error("FAIL #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: "minitest/fail")
         elsif test.skipped?
-          logger.benchmark_warn("SKIP #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: 'minitest/skip')
+          logger.benchmark_warn("SKIP #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: "minitest/skip")
         else
-          logger.benchmark_info("PASS #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: 'minitest/pass')
+          logger.benchmark_info("PASS #{test.class_name} #{test.name}", duration: test.time * 1_000, metric: "minitest/pass")
         end
       end
     end