pier_logging 0.2.0 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c102d9c566bc2227233c2fb698f87f99a13061194f25d0d4728bc356ed2c1593
-  data.tar.gz: 76d4d43102a6e10693dffb9f7b6671ecff73a2b22f47add8d2dbe9635b3c2044
+  metadata.gz: 5b2a1b9430577ae2c662d051aa5e305f33aeff05655333e0112a73386beab712
+  data.tar.gz: b1cb0e6cb96dde62fac3c7ae240e3f56aa14df4df416929eb889b68df4a09ae3
 SHA512:
-  metadata.gz: f98a44d5ca1c3b360301550e14a20327301e12c40b8fc07286432068b9943bed4820472ba8f2d2c78aa87eefb0c3440c89153c4a1bbd1b78e5705c22aee8cfb9
-  data.tar.gz: e072ab069990dd67224e1bfd7e3c32c446ef76849f222499adb94cd5c67ea50260ac25f7d36da8d5cda8cd43463482cb9e4327bb547a8a0d493665d100257d8a
+  metadata.gz: 6ea2ebdf2a038bd3c0b9b76f0409c0e3abf05eab7b00d5934c9bcf7b461e2bee3a35af07788a62d87cf892f333141ae5658348237effb7d171c1feddd511826c
+  data.tar.gz: d2aefc5a1d51a288e541d80cefc0caf3f9794726b8860131cdfc320eeba0ea0deac035097de74515ddb9639d42d76b080e6850d1d610b83c11e1e05451b699cd

data/lib/pier_logging.rb

@@ -54,14 +54,16 @@ module PierLogging
   end
 
   class RequestLoggerConfiguration
-    attr_reader :enabled, :user_info_getter, :hide_response_body_for_paths, :log_response, :hide_request_headers
+    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)
@@ -93,5 +95,10 @@ module PierLogging
       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

@@ -44,18 +44,20 @@ module PierLogging
       env, status, type, body, starts_at, ends_at, _ = args
       request = Rack::Request.new(env)
       request_headers = get_request_headers_from_env(env)
-      logger.info redact_hash({
+      logger.info redact_object({
         message: build_message_from_request(request),
         type: 'http',
         duration: ((ends_at - starts_at)*1000).to_i,
         context: {
           user: get_user_info_from_headers(request_headers),
-          correlation_id: request_headers['X-CORRELATION-ID'],
+          request_id: env['action_dispatch.request_id'],
+          correlation_id: get_correlation_id(env, request_headers)
         },
         request: {
           headers: request_headers,
           href: request.url,
-          body: parse_body(request.POST)
+          query_string: request.query_string,
+          body: parse_body(request.body)
         },
         response: {
           status: status,
@@ -76,7 +78,7 @@ module PierLogging
       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?
+      return redact_object(headers, hide_request_headers, nil) if hide_request_headers.present?
 
       headers
     end
@@ -101,6 +103,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)
@@ -114,13 +120,35 @@ module PierLogging
       body
     end
 
+    def redact_object(obj, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
+      if obj === Array
+        redact_array(obj, replace_keys, replace_by)
+      elsif obj === Hash
+        redact_hash(obj, replace_keys, replace_by)
+      elsif obj.respond_to?(:to_hash)
+        redact_hash(obj.to_hash, replace_keys, replace_by)
+      else
+        obj
+      end
+    end
+    
+    def redact_array(arr, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
+      raise StandardError, 'Could not redact_array for non-array objects' unless arr.is_a? Array
+      arr.map { |el| redact_object(el, replace_keys, replace_by) }
+    end
+    
     def redact_hash(hash, replace_keys = REDACT_REPLACE_KEYS, replace_by = REDACT_REPLACE_BY)
-      hash.traverse do |k,v| 
+      raise StandardError, 'Could not redact_hash for non-hash objects' unless hash.is_a? Hash
+      hash.traverse do |k,v|
         should_redact = replace_keys.any?{ |regex| k =~regex }
         if (should_redact)
           [k, replace_by]
         else
-          [k, v]
+          case v
+          when Array then [k, redact_array(v, replace_keys, replace_by)]
+          else 
+            [k, v]
+          end
         end
       end
     end

data/lib/pier_logging/version.rb

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

metadata

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