unified_logger 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1182b4653c380d8b35b55733c0ba47fa4c5eff722178765dfe6b2f1fddaf8c
-  data.tar.gz: 7b94cd76f7288dffa0004f69a57e633ffa2342cfb67969031e8822f02a96aab6
+  metadata.gz: f34d66cc38e92a52e408550171eee1d6ceae0986add635943f295647ddcdb514
+  data.tar.gz: 33b16e4caff961adee468add42c01d4a40b304285bd669470510b6b749c3ba44
 SHA512:
-  metadata.gz: 3a6090da5a5deb10ad56cf57c475342517dc854658bd23934b4a4c7bf247060cb0851a96af50698b8dd1ca268c8f2a147a4e7478df05931fd3cf0c7e2a3093f6
-  data.tar.gz: 23df148c3859f4e42f1646ddc94d774de39ed9908e74660035ebbe618f8b81d709d9fc5dbe96a0454d71ae4058c2df0ec2a65799d6d3e68caee49883d5d88b8e
+  metadata.gz: ec774f89b414ea15af8bf6f1c0493aaeff2ea1f41364ff9bf16913a7c468d5f7ce1baf8fffea17f6880ff514082d68e1c80483f14af949ad8df84e3547035525
+  data.tar.gz: c956c43f2eeca0cc91f9438cab02a579445f07e64952f0bc54157a237e5600e0d921e0e03a2de72ee05a8ff12655c89cdc645127d19e687137bf52ea6e0a286a

data/lib/unified_logger/job_logger.rb

@@ -16,6 +16,7 @@ module UnifiedLogger
       def log_execution(job)
         log = {
           log_type:             :job,
+          timestamp:            UnifiedLogger.formatted_time,
           class_name:           job.class.name,
           id:                   job.job_id,
           queue:                job.queue_name,

data/lib/unified_logger/logger.rb

@@ -17,40 +17,38 @@ module UnifiedLogger
       self.formatter = proc {}
     end
 
-    def debug(message = nil, params = {})
-      add(::Logger::DEBUG, message, params)
+    def debug(message = nil, &block)
+      message = block.call if message.nil? && block
+      add(::Logger::DEBUG, message)
     end
 
-    def info(message = nil, params = {})
-      add(::Logger::INFO, message, params)
+    def info(message = nil, &block)
+      message = block.call if message.nil? && block
+      add(::Logger::INFO, message)
     end
 
-    def warn(message = nil, params = {})
-      add(::Logger::WARN, message, params)
+    def warn(message = nil, &block)
+      message = block.call if message.nil? && block
+      add(::Logger::WARN, message)
     end
 
-    def error(message = nil, params = {})
-      add(::Logger::ERROR, message, params)
+    def error(message = nil, &block)
+      message = block.call if message.nil? && block
+      add(::Logger::ERROR, message)
     end
 
-    def fatal(message = nil, params = {})
-      add(::Logger::FATAL, message, params)
+    def fatal(message = nil, &block)
+      message = block.call if message.nil? && block
+      add(::Logger::FATAL, message)
     end
 
-    def unknown(message = nil, params = {})
-      add(::Logger::UNKNOWN, message, params)
-    end
-
-    def add(severity, message = nil, params = {})
-      return true if message.blank?
-      return true unless severity >= level
-
-      severity_symbol = SEVERITY_MAP[severity] || :unknown
-      self.class.append_custom_log(severity_symbol, message, params)
+    def unknown(message = nil, &block)
+      message = block.call if message.nil? && block
+      add(::Logger::UNKNOWN, message)
     end
 
     def <<(message)
-      add(::Logger::UNKNOWN, message.to_s.chomp, {})
+      add(::Logger::UNKNOWN, message.to_s.chomp)
       self
     end
 
@@ -103,41 +101,57 @@ module UnifiedLogger
         end
       end
 
+      def format(log)
+        filtered_log = filter(log)
+        formatter = UnifiedLogger.log_transformer
+        formatter.present? ? formatter.call(filtered_log) : filtered_log.to_json
+      end
+
+      private
+
       def filter(content)
         return content unless content.respond_to?(:each)
 
         filter_class = if defined?(ActiveSupport::ParameterFilter)
                          ActiveSupport::ParameterFilter
-                       else
+                       elsif defined?(ActionDispatch::Http::ParameterFilter)
                          ActionDispatch::Http::ParameterFilter
                        end
+        return content unless filter_class
+
         filter_class.new(UnifiedLogger.config[:filter_params]).filter(content)
       end
+    end
 
-      def format(log)
-        filtered_log = filter(log)
-        formatter = UnifiedLogger.log_transformer
-        formatter.present? ? formatter.call(filtered_log) : filtered_log.to_json
+    def add(severity, message = nil, progname = nil, &block)
+      if message.nil?
+        message = block ? block.call : progname
       end
 
-      def append_custom_log(severity, message, params)
-        clean_message = clean_log_message(message)
-        log_hash = { timestamp: UnifiedLogger.current_time, severity: severity,
-                     message: clean_message, params: params }.compact_blank
+      return true if message.blank?
+      return true unless severity >= level
 
-        CUSTOM_LOGS.value = CUSTOM_LOGS.value + [log_hash]
-        true
-      end
+      severity_symbol = SEVERITY_MAP[severity] || :unknown
+      append_custom_log(severity_symbol, message)
+    end
 
-      def clean_log_message(text)
-        return text unless text.is_a?(String)
+    private
 
-        text = text.gsub(/\e\[[0-9;]*m/, "")
-        text = text.gsub(%r{[^a-zA-Z0-9\s.,;:!?'"()\[\]{}\-_@#$%&*+=<>|~`/]}, "")
-        text = text.gsub('"', "'")
-        text = text.gsub(/\s+/, " ")
-        text.strip
-      end
+    def append_custom_log(severity, message)
+      message = sanitize_log_message(message) if message.is_a?(String)
+      log_hash = { timestamp: UnifiedLogger.formatted_time, severity: severity, message: message }
+
+      CUSTOM_LOGS.value = CUSTOM_LOGS.value + [log_hash]
+    end
+
+    def sanitize_log_message(text)
+      return text unless text.is_a?(String)
+
+      text = text.gsub(/\e\[[0-9;]*m/, "")
+      text = text.gsub(%r{[^a-zA-Z0-9\s.,;:!?'"()\[\]{}\-_@#$%&*+=<>|~`/]}, "")
+      text = text.gsub('"', "'")
+      text = text.gsub(/\s+/, " ")
+      text.strip
     end
   end
 end

data/lib/unified_logger/railtie.rb

@@ -1,7 +1,12 @@
+# frozen_string_literal: true
+
 module UnifiedLogger
   class Railtie < Rails::Railtie
     initializer "unified_logger.middleware", after: :load_config_initializers do |app|
-      app.middleware.insert_after ActionDispatch::DebugExceptions, UnifiedLogger::RequestLogger if UnifiedLogger.config[:auto_insert_middleware]
+      if UnifiedLogger.config[:auto_insert_middleware]
+        app.middleware.insert_after ActionDispatch::DebugExceptions,
+                                    UnifiedLogger::RequestLogger
+      end
     end
   end
 end

data/lib/unified_logger/request_logger.rb

@@ -37,6 +37,7 @@ module UnifiedLogger
       query_string = env["QUERY_STRING"]
       log = {
         log_type:   :request,
+        timestamp:  UnifiedLogger.formatted_time,
         id:         env["action_dispatch.request_id"],
         ip:         env["action_dispatch.remote_ip"].to_s,
         controller: path_parameters[:controller],
@@ -80,7 +81,7 @@ module UnifiedLogger
       return nil if content_type&.exclude?("application/") && content_type.exclude?("text/plain")
       return response_body(response.body, content_type) if response.respond_to?(:body)
 
-      body = response.respond_to?(:map) ? response.map(&:to_s).join : response.to_s
+      body = response.respond_to?(:map) ? response.join : response.to_s
 
       parse_body(body, content_type)
     ensure

data/lib/unified_logger/version.rb

@@ -1,3 +1,3 @@
 module UnifiedLogger
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.2".freeze
 end

data/lib/unified_logger.rb

@@ -1,7 +1,11 @@
 require "concurrent"
 require "active_support/core_ext/object/blank"
 require "active_support/core_ext/enumerable"
-require "active_support/parameter_filter"
+begin
+  require "active_support/parameter_filter"
+rescue LoadError
+  # ActiveSupport < 6.0; falls back to ActionDispatch::Http::ParameterFilter at runtime
+end
 require "active_support/backtrace_cleaner"
 require "json"
 require "logger"
@@ -50,8 +54,7 @@ module UnifiedLogger
       @log_transformer = callable
     end
 
-    delegate :trim, :filter, :format, :format_exception,
-             :clean_log_message, :append_custom_log,
+    delegate :trim, :format, :format_exception,
              :custom_logs, :fetch_and_reset_custom_logs, :reset_thread_logs,
              to: :"UnifiedLogger::Logger"
   end
@@ -76,6 +79,10 @@ module UnifiedLogger
   def self.current_time
     Time.zone&.now || Time.now.utc
   end
+
+  def self.formatted_time
+    current_time.iso8601(3)
+  end
 end
 
 require "unified_logger/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unified_logger
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Marcovecchio