ltsv_logger_formatter 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c41a0f98815517b88de7ad4bc73fded258b43d9
-  data.tar.gz: c9279c545852670f286b36e2726ebafb440f50d8
+  metadata.gz: 0f3509008f39570486a2ca095a9fda0089d04538
+  data.tar.gz: 28349db60e3c890faba16d590cf41001ed8cebd9
 SHA512:
-  metadata.gz: 98bb9d37efa7cd04330d10a04e42d902d2d371bbe4a9d9be3bcd4f52ced75aa354654990b1e0c52cc86eef335f968ab56418c5e49b3a7a47ae4a4047627fc181
-  data.tar.gz: db00857be73b9296d63121ba352f4bc1506c672ee7866046e46ab90d795497a87e0ca295d33ca3d54fa4eaa7cef2919b219351f9aee31d034fb8ba9c006eba5d
+  metadata.gz: 83052717caf9b195715ae8a3ff8c7ce430d7d8b716f1ef840ed62ad2a0ac757c6f0ebba95d7d63c71514d5be5f1f094eaab5769c34c00c085dd8fb660bea6a34
+  data.tar.gz: f64e90bc40e960d5145917ada21f8c843c8c6df21937ddb99331511070df44ed57687f42caf85518712a84faac020c291866966e5610ed7a59b8e2eb1a5b01b5

data/README.md

@@ -85,6 +85,19 @@ logger.info('progname') { { key: 'val' } }
 # => test1:INFO      test2:2016-10-03T00:45:52.073456        test3:progname  key:val
 ```
 
+### Filtering parameters ###
+
+You can filter parameters using `filter` option.
+
+```ruby
+require 'action_dispatch/http/parameter_filter'
+filter = ActionDispatch::Http::ParameterFilter.new([/password/])
+
+logger.formatter = LtsvLoggerFormatter.new(filter: filter)
+logger.info(key: 'value', password: 'password')
+# => level:INFO      time:2016-11-01T01:19:51.754113 key:value       password:[FILTERED]
+```
+
 ## Dependency
 
 This gem uses [LTSV gem](https://github.com/condor/ltsv/blob/master/ltsv.gemspec).

data/lib/ltsv_logger_formatter/version.rb

@@ -1,5 +1,5 @@
 require 'logger'
 
 class LtsvLoggerFormatter < Logger::Formatter
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/ltsv_logger_formatter.rb

@@ -11,13 +11,16 @@ class LtsvLoggerFormatter < ::Logger::Formatter
   # @param [Symbol] severity_key Optional, key for severity. Default is :level.
   # @param [Symbol] time_key Optional, key for time. Default is :time.
   # @param [Symbol] progname_key Optional, key for progname. Default is :progname.
+  # @param [Object] filter Optional, object which responds to #filter, e.g. ActionDispatch::Http::ParameterFilter.
+  #   This object used to filter parameter in hash such as 'password'.
   def initialize(datetime_format: '%Y-%m-%dT%H:%M:%S.%6N',
-                 severity_key: :level, time_key: :time, progname_key: :progname)
+                 severity_key: :level, time_key: :time, progname_key: :progname, filter: nil)
     super()
     self.datetime_format = datetime_format
     @severity_key = severity_key
     @time_key = time_key
     @progname_key = progname_key
+    @filter = filter
   end
 
   # Return formatted string using arguments.
@@ -44,9 +47,9 @@ class LtsvLoggerFormatter < ::Logger::Formatter
   private
 
   def format_data(data)
-    if data.is_a? Exception
-      return { message: data.message, class: data.class, backtrace: (data.backtrace || []).join("\\n") } # \n cannot be used in LTSV, so use \\n in backtrace.
-    end
-    data.respond_to?(:to_hash) ? data.to_hash : { message: data.to_s }
+    return { message: data.message, class: data.class, backtrace: Array(data.backtrace).join("\\n") } if data.is_a? Exception
+    return { message: data.to_s } unless data.respond_to?(:to_hash)
+
+    @filter ? @filter.filter(data.to_hash) : data.to_hash
   end
 end

data/ltsv_logger_formatter.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'actionpack'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ltsv_logger_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - ryu39
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ltsv
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple logger formatter for logging in ltsv format.
 email:
 - dev.ryu39@gmail.com