contextual_logger 0.3.1 → 0.4.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2005c27e3db3c69146eeae90c5dd89f75f8ad56c
-  data.tar.gz: b7cb42a1aee422df6e2135d35d67c81202f944b3
+  metadata.gz: 6fd7d8ae966a768ad95020d9dacf6c60a6abc938
+  data.tar.gz: 5251c5e24e99820875dbf83b01dc7ae9390c9ed8
 SHA512:
-  metadata.gz: 877c0ab113f3d220c87670739c7fb1a0a242f5ebd73c54fcc2eb12227747a47d041c222394a1c2485ce22e8d40255362a9956922cd3b0a8328ca4eead73f2c3e
-  data.tar.gz: 3c201cbe9719e9f19c31e7f3f8c3960ba37eb8099df2e808a7704b27a728ca9d2640173bd02afc8165a4cc53ef9a72bda3d5fc3cc3b89ac5933f4680f6c072fd
+  metadata.gz: a0d4e12220c89308677cd1195ec942780d57f11ddab574f11f4fe6a5a6615852cc8f5973f17b99b1fcba9f2c25c953f1bb3492220903b7f5d729f66851d344e9
+  data.tar.gz: baca8317383cf92cc6d9572287877ec42989638af1774465d506e63062125593e7a3dc610779ac564b4175a9ff6e866fc5ca592b2fd94b8ea5d244c737ae1624

data/lib/contextual_logger.rb

@@ -5,94 +5,97 @@ require 'json'
 require_relative './contextual_logger/context/handler'
 
 module ContextualLogger
-  def self.new(logger)
-    logger.extend(self)
+  class << self
+    def new(logger)
+      logger.extend(LoggerMixin)
+    end
   end
 
-  def global_context=(context)
-    ContextualLogger::Context::Handler.new(context).set!
-  end
+  module LoggerMixin
+    def global_context=(context)
+      Context::Handler.new(context).set!
+    end
 
-  def with_context(context)
-    context_handler = ContextualLogger::Context::Handler.new(current_context_for_thread.deep_merge(context))
-    context_handler.set!
-    if block_given?
-      yield
-    else
-      context_handler
+    def with_context(context)
+      context_handler = Context::Handler.new(current_context_for_thread.deep_merge(context))
+      context_handler.set!
+      if block_given?
+        begin
+          yield
+        ensure
+          context_handler.reset!
+        end
+      else
+        # If no block given, the context handler is returned to the caller so they can handle reset! themselves.
+        context_handler
+      end
     end
-  ensure
-    context_handler.reset! if block_given?
-  end
 
-  def current_context_for_thread
-    ContextualLogger::Context::Handler.current_context
-  end
+    def current_context_for_thread
+      Context::Handler.current_context
+    end
 
-  def format_message(severity, timestamp, progname, message, context)
-    message_with_context = message_with_context(context, message, severity, timestamp, progname)
+    def debug(message = nil, context = {})
+      add_if_enabled(Logger::Severity::DEBUG, message || yield, context: context)
+    end
 
-    if @formatter
-      @formatter.call(severity, timestamp, progname, message_with_context)
-    else
-      "#{message_with_context.to_json}\n"
+    def info(message = nil, context = {})
+      add_if_enabled(Logger::Severity::INFO, message || yield, context: context)
     end
-  end
 
-  def debug(progname = nil, **extra_context, &block)
-    add(Logger::Severity::DEBUG, nil, progname, extra_context, &block)
-  end
+    def warn(message = nil, context = {})
+      add_if_enabled(Logger::Severity::WARN, message || yield, context: context)
+    end
 
-  def info(progname = nil, **extra_context, &block)
-    add(Logger::Severity::INFO, nil, progname, extra_context, &block)
-  end
+    def error(message = nil, context = {})
+      add_if_enabled(Logger::Severity::ERROR, message || yield, context: context)
+    end
 
-  def warn(progname = nil, **extra_context, &block)
-    add(Logger::Severity::WARN, nil, progname, extra_context, &block)
-  end
+    def fatal(message = nil, context = {})
+      add_if_enabled(Logger::Severity::FATAL, message || yield, context: context)
+    end
 
-  def error(progname = nil, **extra_context, &block)
-    add(Logger::Severity::ERROR, nil, progname, extra_context, &block)
-  end
+    def unknown(message = nil, context = {})
+      add_if_enabled(Logger::Severity::UNKNOWN, message || yield, context: context)
+    end
 
-  def fatal(progname = nil, **extra_context, &block)
-    add(Logger::Severity::FATAL, nil, progname, extra_context, &block)
-  end
+    def log_level_enabled?(severity)
+      severity >= level
+    end
 
-  def unknown(progname = nil, **extra_context, &block)
-    add(Logger::Severity::UNKNOWN, nil, progname, extra_context, &block)
-  end
+    def add_if_enabled(severity, message, context:)
+      if log_level_enabled?(severity)
+        write_entry_to_log(severity, Time.now, @progname, message, context: current_context_for_thread.deep_merge(context))
+      end
+      true
+    end
 
-  def add(severity, message = nil, progname = nil, extra_context = nil)
-    severity ||= UNKNOWN
-    if @logdev.nil? || (severity < @level)
-      return true
+    def write_entry_to_log(severity, timestamp, progname, message, context:)
+      @logdev&.write(format_message(format_severity(severity), timestamp, progname, message, context: context))
     end
-    progname ||= @progname
-    if message.nil?
-      if block_given?
-        message = yield
+
+    private
+
+    def format_message(severity, timestamp, progname, message, context: {})
+      message_hash = message_hash_with_context(severity, timestamp, progname, message, context: context)
+
+      if @formatter
+        @formatter.call(severity, timestamp, progname, message_hash)
       else
-        message = progname
-        progname = @progname
+        "#{message_hash.to_json}\n"
       end
     end
-    write_entry_to_log(severity, Time.now, progname, message, current_context_for_thread.deep_merge(extra_context || {}))
-    true
-  end
-
-  def write_entry_to_log(severity, timestamp, progname, message, context)
-    @logdev.write(format_message(format_severity(severity), timestamp, progname, message, context))
-  end
 
-  private
+    def message_hash_with_context(severity, timestamp, progname, message, context:)
+      message_hash =
+        {
+          message:   message,
+          severity:  severity,
+          timestamp: timestamp
+        }
+      message_hash[:progname] = progname if progname
 
-  def message_with_context(context, message, severity, timestamp, progname)
-    context.merge(
-      message: message,
-      severity: severity,
-      timestamp: timestamp,
-      progname: progname
-    )
+      message_hash.merge!(context)
+    end
   end
 end

data/lib/contextual_logger/logger_with_context.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  # A logger that deep_merges additional context and then delegates to the given logger.
+  # Keeps it own log level (called override_level) that may be set independently of the logger it delegates to.
+  # If override_level is non-nil, it takes precedence; if it is nil (the default), then it delegates to the logger.
+  class LoggerWithContext
+    include LoggerMixin
+
+    attr_reader :logger, :override_level, :context
+
+    def initialize(logger, context, level: nil)
+      logger.is_a?(LoggerMixin) or raise ArgumentError, "logger must include ContextualLogger::LoggerMixin (got #{logger.inspect})"
+      @logger = logger
+      @override_level = level
+      @context = context
+      @merged_context_cache = {}  # so we don't have to merge every time
+    end
+
+    def level
+      @override_level || @logger.level
+    end
+
+    def level=(override_level)
+      @override_level = override_level
+    end
+
+    def write_entry_to_log(severity, timestamp, progname, message, context:)
+      merged_context =
+        if @merged_context_cache.size >= 1000 # keep this cache memory use finite
+          @merged_context_cache[context] || @context.deep_merge(context)
+        else
+          @merged_context_cache[context] ||= @context.deep_merge(context)
+        end
+
+      @logger.write_entry_to_log(severity, timestamp, progname, message, context: merged_context)
+    end
+
+    class << self
+      def for_log_source(logger, log_source, level: nil)
+        new(logger, { log_source: log_source }, level: level)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: contextual_logger
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.pre.1
 platform: ruby
 authors:
 - James Ebentier
@@ -46,12 +46,14 @@ extra_rdoc_files: []
 files:
 - lib/contextual_logger.rb
 - lib/contextual_logger/context/handler.rb
+- lib/contextual_logger/logger_with_context.rb
 - lib/contextual_logger/overrides/active_support/tagged_logging/formatter.rb
 homepage: https://rubygems.org/gems/contextual_logger
 licenses:
 - MIT
 metadata:
-  source_code_uri: https://github.com/Invoca/contextual_logger
+  source_code_uri: https://github.com/Invoca/process_settings
+  allowed_push_host: https://rubygems.org
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -63,9 +65,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13