pier_logging 0.1.13 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 642d371babd98a5b8714f67e30d18db2ba10f89da453a916044cb078c64453d6
-  data.tar.gz: 5c47cc13ebddab2937b0c6cdd9abb040e5d6cd7d15f6dab3c3b3ed8becb0da53
+  metadata.gz: 15b02b57cc80e8d5babe64aa73a7b29c2d1fac544acc2c069c7cb0ba4ee985fc
+  data.tar.gz: 13719e2b027929f1e385928a943a96200db798c008be2a4f7895c075ea34fefe
 SHA512:
-  metadata.gz: 93f7ef6e9321afb13e39f07f37f4dfa4475f9be15a33aef48fc64571f468c253049256e0245a7000d394bbceeeb54a77e5297b815f3c9e1bbb8e2e477a311a9a
-  data.tar.gz: 994b98c846e5c91aa496c18209479f909c6fd4f4a4172bfffa64caf8615926678b707d4b19915d623dea50fa441e0f3081a2e19ab20408b56c87890d2268ad15
+  metadata.gz: edcd064cef708218bc0c4fb6e2e2d0ae13737b41a666c14be34129ff5ef008dedf734e33b93fa6e5c82cff95e1ca2bc76f0dcdfc39ed944509dc2742d4c56fb6
+  data.tar.gz: 170036ef60fecdf8cc77b8aa51f5ac4e40e89f29e90fd8410d9c6a65f98a43ecf4f73f0ab79d8db865cd4a38a6fab5bb4da420f00b8d0129e314943c4f2e31f2

data/lib/pier_logging.rb

@@ -54,21 +54,51 @@ 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, :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)
       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
       @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,
@@ -59,7 +60,7 @@ module PierLogging
         },
         response: {
           status: status,
-          body: parse_body(body),
+          body: response_body(request.path, body),
           type: type['Content-Type'],
         }
       })
@@ -71,8 +72,23 @@ 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)
+      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)
@@ -86,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(env, headers) || headers['X-CORRELATION-ID']
+    end
+
     def parse_body(body)
       body_object = get_body_object(body)
       Oj.load(body_object, allow_blank: true)
@@ -99,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
@@ -125,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.13"
+  VERSION = "0.2.2"
 end

metadata

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