contextual_logger 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e2c38b3b8a3f6b71ba8ec88f823064a163a942b
-  data.tar.gz: 023cbad6c4da242b80590a3f33ba42b4c5bd0e69
+  metadata.gz: '0118241ab98c2c3ec5f47741cc2e173a22bd4c13'
+  data.tar.gz: 3370e95855bc8c7076581ea19564af108b0e9e1d
 SHA512:
-  metadata.gz: 45400f8d40a634bdb89cc5e60801853bf584ef07e8237d176a9561ad3cbfc81a1682d122fd1130e453de183bc5f9f0932cb601685315d97681964a47cf6e053c
-  data.tar.gz: fc778151d8728552bc57da6e41fef37efc571b94e0ac7e6be2aec0f871db88c2106f70fd7206a215114e25407d649d63742c9a979da9b69bed4455fea9be9715
+  metadata.gz: 54580c2fc2920f81203dba48b911be2034e93892d6cab427b93557c54e9f227e09f7ad6c04ec6bd74cd9d758fbf3a72acd7923f63cfb5c5cd264d60e92d5ef0c
+  data.tar.gz: dbde45342044cfba8a7c98e15febf3fc2d800b398fdfd07d26e38682b255d8eac90e55c8e43795e14f786cd15e6976f47a508f32fe186b1ac728930456a9588b

data/lib/contextual_logger.rb

@@ -2,6 +2,7 @@
 
 require 'active_support'
 require 'json'
+require_relative './contextual_logger/redactor'
 require_relative './contextual_logger/context/handler'
 
 module ContextualLogger
@@ -32,9 +33,20 @@ module ContextualLogger
         end
       end
     end
+
+    def normalize_message(message)
+      case message
+      when String
+        message
+      else
+        message.inspect
+      end
+    end
   end
 
   module LoggerMixin
+    delegate :register_secret, to: :redactor
+
     def global_context=(context)
       Context::Handler.new(context).set!
     end
@@ -59,27 +71,27 @@ module ContextualLogger
     end
 
     def debug(message = nil, context = {})
-      add(Logger::Severity::DEBUG, message || yield, **context)
+      add(Logger::Severity::DEBUG, message.nil? && block_given? ? yield : message, **context)
     end
 
     def info(message = nil, context = {})
-      add(Logger::Severity::INFO, message || yield, **context)
+      add(Logger::Severity::INFO, message.nil? && block_given? ? yield : message, **context)
     end
 
     def warn(message = nil, context = {})
-      add(Logger::Severity::WARN, message || yield, **context)
+      add(Logger::Severity::WARN, message.nil? && block_given? ? yield : message, **context)
     end
 
     def error(message = nil, context = {})
-      add(Logger::Severity::ERROR, message || yield, **context)
+      add(Logger::Severity::ERROR, message.nil? && block_given? ? yield : message, **context)
     end
 
     def fatal(message = nil, context = {})
-      add(Logger::Severity::FATAL, message || yield, **context)
+      add(Logger::Severity::FATAL, message.nil? && block_given? ? yield : message, **context)
     end
 
     def unknown(message = nil, context = {})
-      add(Logger::Severity::UNKNOWN, message || yield, **context)
+      add(Logger::Severity::UNKNOWN, message.nil? && block_given? ? yield : message, **context)
     end
 
     def log_level_enabled?(severity)
@@ -105,11 +117,19 @@ module ContextualLogger
     end
 
     def write_entry_to_log(severity, timestamp, progname, message, context:)
-      @logdev&.write(format_message(format_severity(severity), timestamp, progname, message, context: context))
+      @logdev&.write(
+        redactor.redact(
+          format_message(format_severity(severity), timestamp, progname, message, context: context)
+        )
+      )
     end
 
     private
 
+    def redactor
+      @redactor ||= Redactor.new
+    end
+
     def format_message(severity, timestamp, progname, message, context: {})
       message_hash = message_hash_with_context(severity, timestamp, progname, message, context: context)
 
@@ -123,7 +143,7 @@ module ContextualLogger
     def message_hash_with_context(severity, timestamp, progname, message, context:)
       message_hash =
         {
-          message:   message,
+          message:   ContextualLogger.normalize_message(message),
           severity:  severity,
           timestamp: timestamp
         }

data/lib/contextual_logger/redactor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  class Redactor
+    attr_reader :redaction_set, :redaction_regex
+
+    def initialize
+      @redaction_set   = Set.new
+      @redaction_regex = nil
+    end
+
+    def register_secret(sensitive_data)
+      if redaction_set.add?(Regexp.escape(sensitive_data))
+        @redaction_regex = Regexp.new(
+          redaction_set.to_a.join('|')
+        )
+      end
+    end
+
+    def redact(log_line)
+      if redaction_regex
+        log_line.gsub(redaction_regex, '<redacted>')
+      else
+        log_line
+      end
+    end
+  end
+end

data/lib/contextual_logger/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ContextualLogger
+  VERSION = '0.6.0'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contextual_logger
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - James Ebentier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -48,6 +48,8 @@ files:
 - lib/contextual_logger/context/handler.rb
 - lib/contextual_logger/logger_with_context.rb
 - lib/contextual_logger/overrides/active_support/tagged_logging/formatter.rb
+- lib/contextual_logger/redactor.rb
+- lib/contextual_logger/version.rb
 homepage: https://rubygems.org/gems/contextual_logger
 licenses:
 - MIT