pier_logging 0.1.11 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5790108eb8d4e852835319b5ab0aa479b0484a4a7c8557b6c3ed71ceaaae704d
-  data.tar.gz: 7c8e4d8772b28bb31ee8cd554635bf5b58394a37f8d8a2bff2f97be79e1d8a04
+  metadata.gz: c102d9c566bc2227233c2fb698f87f99a13061194f25d0d4728bc356ed2c1593
+  data.tar.gz: 76d4d43102a6e10693dffb9f7b6671ecff73a2b22f47add8d2dbe9635b3c2044
 SHA512:
-  metadata.gz: 8c6c86e0fb40803784e7225db81e331d4b7b3de3372cf0311632b098c017c8e434358365de96b9f5d55da061714d314f8ac5c1926a8cab6b3892f9f6cdb1a1c0
-  data.tar.gz: f95d6ae0abd0756e597cf8333e156a4f9ecf163737ccd418552f12d496fd8b1387c642c9a28a129ada40dbeacdb3db3bc13d022e285a0cb9baddca118292653e
+  metadata.gz: f98a44d5ca1c3b360301550e14a20327301e12c40b8fc07286432068b9943bed4820472ba8f2d2c78aa87eefb0c3440c89153c4a1bbd1b78e5705c22aee8cfb9
+  data.tar.gz: e072ab069990dd67224e1bfd7e3c32c446ef76849f222499adb94cd5c67ea50260ac25f7d36da8d5cda8cd43463482cb9e4327bb547a8a0d493665d100257d8a

data/lib/pier_logging.rb

@@ -54,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/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

@@ -50,7 +50,7 @@ module PierLogging
         duration: ((ends_at - starts_at)*1000).to_i,
         context: {
           user: get_user_info_from_headers(request_headers),
-          correlation_id: env['action_dispatch.request_id'],
+          correlation_id: request_headers['X-CORRELATION-ID'],
         },
         request: {
           headers: request_headers,
@@ -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
@@ -125,4 +140,4 @@ module PierLogging
       500
     end
   end
-end
+end

data/lib/pier_logging/version.rb

@@ -1,3 +1,3 @@
 module PierLogging
-  VERSION = "0.1.11"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pier_logging
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.2.0
 platform: ruby
 authors:
 - Mauricio Banduk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-08 00:00:00.000000000 Z
+date: 2020-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ougai