pier_logging 0.1.14 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cf700dcf41369d8bf53db3a083f23777b62a30da2250a3297560c2d6aaef187
-  data.tar.gz: 25ee1fabd0de22e25b08b3ef356a731b1dd828490699b9dadbb1ddf281fd061e
+  metadata.gz: a7e62fec86c0128b538d981f3920a29ef7facca185c9f0a2e57b05025b01fdc9
+  data.tar.gz: 9e9823722a20e9b6279e086513a30ca948fa87bba2ed776e5b2df39023133c38
 SHA512:
-  metadata.gz: 9ce0e74e9ef845b85b226dbc44b462a4d1557d8b74faa5ffb937d983fad866430d21f3d6fd53a294638a2f2eae8cdd56226fde35039e5fbe3605143efe23bdea
-  data.tar.gz: 8ad7ccc220039ae2d1ffc9baca617d5984af96431729ec635d3e9294a04886bf4afbb7a2d14c45fb43b3f23b9fe796fe128c80b1dc164e1052a2ce1b476cf27a
+  metadata.gz: 878039658c28b40809de6cff417fafa7c25b63852b9f1a41f1e5513c4266f5fe430f65d452315b5973c2764678092492ad81de6738bb8667df6544504747a47d
+  data.tar.gz: 7488c60cf4dbec7507853be535cb7639c16035d6b87102a577cd88b81450f738da9a672c1b10552cc709b1d71bfa2b38b6f04cc31b65ba6290209280e689c9f2

data/lib/pier_logging.rb

@@ -54,13 +54,16 @@ module PierLogging
   end
 
   class RequestLoggerConfiguration
-    attr_reader :enabled, :user_info_getter, :hide_response_body_for_paths, :log_response
+    attr_reader :enabled, :user_info_getter, :hide_response_body_for_paths, 
+                :log_response, :hide_request_headers, :correlation_id_getter
 
     def initialize
-      @user_info_getter = nil
+      @user_info_getter = ->(_ = nil) { nil }
       @enabled = false
       @hide_response_body_for_paths = nil
       @log_response = true
+      @hide_request_headers = nil
+      @correlation_id_getter = ->(_ = nil, _ = nil) { nil }
     end
 
     def user_info_getter=(proc)
@@ -80,10 +83,22 @@ module PierLogging
       
       @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
       @enabled = enabled
     end
+
+    def correlation_id_getter=(proc)
+      raise ArgumentError, "Config 'correlation_id_getter' must be a 'Proc'" unless proc.is_a? Proc
+      @correlation_id_getter = proc
+    end
   end
 end

data/lib/pier_logging/request_logger.rb

@@ -50,7 +50,8 @@ 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'],
+          request_id: env['action_dispatch.request_id'],
+          correlation_id: get_correlation_id(env, request_headers)
         },
         request: {
           headers: request_headers,
@@ -71,8 +72,14 @@ module PierLogging
 
     private
     def get_request_headers_from_env(env)
-      env.select { |k,v| k[0..4] == 'HTTP_'}.
+      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)
@@ -95,6 +102,10 @@ module PierLogging
       PierLogging.request_logger_configuration.user_info_getter.call(headers)
     end
 
+    def get_correlation_id(env, headers)
+      PierLogging.request_logger_configuration.correlation_id_getter.call(env, headers) || headers['X-CORRELATION-ID']
+    end
+
     def parse_body(body)
       body_object = get_body_object(body)
       Oj.load(body_object, allow_blank: true)
@@ -108,11 +119,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
@@ -134,4 +145,4 @@ module PierLogging
       500
     end
   end
-end
+end

data/lib/pier_logging/version.rb

@@ -1,3 +1,3 @@
 module PierLogging
-  VERSION = "0.1.14"
+  VERSION = "0.2.3"
 end

metadata

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