pier_logging 0.1.10 → 0.1.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e873082a51ac0e6d7727295242b351f48c36359f229cd86d88a2cf2ff30dc261
-  data.tar.gz: 18ea7a72b907d6c83c62feddae585c5c0d37488540be4f437b8c8ae7d9427156
+  metadata.gz: d5b9f495421c7b6e2b36d0cd8a0ff5978cba36feaf25350a383900347f58b9eb
+  data.tar.gz: 64339331f573395e582b713b460278ff41df69906b6584765b14f3a6f2f8f122
 SHA512:
-  metadata.gz: 440474356d2d9bf8f90e2df6474f147706892bb0778dd1d63ba7d6c5d550287f62da83d3f6dd384e073869951adcc117092a55561b0a4938590251e2802bd619
-  data.tar.gz: d80ca3622d92b96503764e77e01d5c02f1ccb32413781b09d9ca46c7751d74d7b25fbb6d4af6360be51319377262843f4ce8ff70a8de6058237d7e70663adf54
+  metadata.gz: 9cbc2402ac849f1b89938d17e3b33c47829148e5bc67eda1250e189fb0b394385ffbc58877e875c8437cfabf7ddb8e0c524f3e3fce42adec755b5afc4a097cac
+  data.tar.gz: ef22e8acb1ec18fc43b54e60454759a7f2728375344feb9c97b3d8de24db0dfe1bb28cd3e824ba9f9518d03aa8e9db399a3b37856192b43ef9d225b2c9d06a18

data/lib/pier_logging.rb

@@ -9,6 +9,7 @@ require "pier_logging/formatter/base"
 require "pier_logging/formatter/json"
 require "pier_logging/formatter/readable"
 require "pier_logging/helpers/headers"
+require "pier_logging/helpers/env_config"
 
 module PierLogging
   def self.logger_configuration
@@ -53,17 +54,40 @@ module PierLogging
   end
 
   class RequestLoggerConfiguration
-    attr_reader :enabled, :user_info_getter
+    attr_reader :enabled, :user_info_getter, :hide_response_body_for_paths, :log_response, :hide_request_headers
 
     def initialize
       @user_info_getter = nil
       @enabled = false
+      @hide_response_body_for_paths = nil
+      @log_response = true
+      @hide_request_headers = nil
     end
 
     def user_info_getter=(proc)
       raise ArgumentError, "Config 'user_info_getter' must be a 'Proc'" unless proc.is_a? Proc
       @user_info_getter = proc
     end
+
+    def log_response=(log_response)
+      raise ArgumentError, "Config 'log_response' must be a 'boolean'" unless !!log_response == log_response
+      @log_response = log_response
+    end
+
+    def hide_response_body_for_paths=(hide_response_body_for_paths)
+      unless (hide_response_body_for_paths.is_a? Array) && (hide_response_body_for_paths.all?{|item| item.is_a? Regexp})
+        raise ArgumentError, "Config 'hide_response_body_for_paths' must be an 'Array of Regexps'" 
+      end
+      
+      @hide_response_body_for_paths = hide_response_body_for_paths
+    end
+
+    def hide_request_headers=(hide_request_headers)
+      unless (hide_request_headers.is_a? Array) && (hide_request_headers.all?{|item| item.is_a? Regexp})
+        raise ArgumentError, "Config 'hide_request_headers' must be an 'Array of Regexps'" 
+      end
+      @hide_request_headers = hide_request_headers
+    end
     
     def enabled=(enabled = false)
       raise ArgumentError, "Config 'enabled' must be a 'boolean'" unless !!enabled == enabled

data/lib/pier_logging/helpers/env_config.rb

@@ -0,0 +1,48 @@
+module PierLogging
+  module Helpers
+    class EnvConfig
+      def self.for(logger = nil, log_dir: 'log', log_file: PierLogging.logger_configuration.env)
+        {
+          enabled: log_enabled(logger),
+          output: log_output(logger, log_dir, log_file),
+          level: log_level(logger),
+        }
+      end
+
+      private
+
+      def self.log_output(logger, log_dir, log_file)
+        return nil unless log_enabled(logger)
+        log_output_env = ENV.fetch(output_env_var(logger), 'STDOUT').upcase
+        log_output_env == 'STDOUT' ? STDOUT : output_file_name(log_dir, log_file)
+      end
+
+      def self.log_enabled(logger)
+        ENV.fetch(enabled_env_var(logger), 'true') == 'true'
+      end
+
+      def self.log_level(logger)
+        ENV.fetch(level_env_var(logger), 'info').upcase
+      end
+
+      def self.output_env_var(logger)
+        ['LOG', logger ,'OUTPUT'].compact.join('_').upcase
+      end
+
+      def self.enabled_env_var(logger)
+        ['LOG', logger ,'ENABLED'].compact.join('_').upcase
+      end
+
+      def self.level_env_var(logger)
+        ['LOG', logger ,'LEVEL'].compact.join('_').upcase
+      end
+
+      def self.output_file_name(log_dir, log_file)
+        [
+          [ log_dir, log_file ].join('/'),
+          'log'
+        ].join('.')
+      end
+    end
+  end
+end

data/lib/pier_logging/logger.rb

@@ -2,7 +2,12 @@
 module PierLogging
   class Logger < Ougai::Logger
     include ActiveSupport::LoggerThreadSafeLevel
-    include ActiveSupport::LoggerSilence
+    include LoggerSilence
+
+    def initialize(*args)
+      super
+      after_initialize if respond_to? :after_initialize
+    end
 
     def create_formatter
       PierLogging.logger_configuration.formatter

data/lib/pier_logging/request_logger.rb

@@ -59,7 +59,7 @@ module PierLogging
         },
         response: {
           status: status,
-          body: parse_body(body),
+          body: response_body(request.path, body),
           type: type['Content-Type'],
         }
       })
@@ -71,8 +71,23 @@ module PierLogging
 
     private
     def get_request_headers_from_env(env)
-      env.select { |k,v| k.start_with? 'HTTP_'}.
-        transform_keys { |k| k.delete_prefix('HTTP_').split('_').join('-').upcase }
+      hide_request_headers = PierLogging.request_logger_configuration.hide_request_headers
+      
+      headers = env.select { |k,v| k[0..4] == 'HTTP_'}.
+        transform_keys { |k| k[5..-1].split('_').join('-').upcase }
+      
+      return redact_hash(headers, hide_request_headers, nil) if hide_request_headers.present?
+
+      headers
+    end
+
+    def response_body(request_path, body)
+      return nil unless PierLogging.request_logger_configuration.log_response
+      
+      hide_response_body_for_paths = PierLogging.request_logger_configuration.hide_response_body_for_paths
+      return nil if hide_response_body_for_paths && hide_response_body_for_paths.any?{ |path|request_path =~ path }
+      
+      parse_body(body)
     end
 
     def build_message_from_request(request)
@@ -99,11 +114,11 @@ module PierLogging
       body
     end
 
-    def redact_hash(hash)
+    def redact_hash(hash, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
       hash.traverse do |k,v| 
-        should_redact = REDACT_REPLACE_KEYS.any?{ |regex| k =~regex }
+        should_redact = replace_keys.any?{ |regex| k =~regex }
         if (should_redact)
-          [k, REDACT_REPLACE_BY]
+          [k, replace_by]
         else
           [k, v]
         end

data/lib/pier_logging/version.rb

@@ -1,3 +1,3 @@
 module PierLogging
-  VERSION = "0.1.10"
+  VERSION = "0.1.15"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pier_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.15
 platform: ruby
 authors:
 - Mauricio Banduk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 2020-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai
@@ -149,6 +149,7 @@ files:
 - lib/pier_logging/formatter/base.rb
 - lib/pier_logging/formatter/json.rb
 - lib/pier_logging/formatter/readable.rb
+- lib/pier_logging/helpers/env_config.rb
 - lib/pier_logging/helpers/headers.rb
 - lib/pier_logging/logger.rb
 - lib/pier_logging/request_logger.rb