l2meter 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3673ba178109f4ff153a1e629f77ad8661eb927
-  data.tar.gz: '09daa1747e20d54e43cd8002c17e57fb46810ae2'
+  metadata.gz: b8abd7703829d8b981631fd16b5fa6f30daea752
+  data.tar.gz: e539765cd1db9d19045a60ff6f437de738e8722d
 SHA512:
-  metadata.gz: f6bb5ea3300ba4b1dc00d4782d51736b8660f050d207c94c27438d240a9550d06ad6a5f0855fbdc3ecc0372655c00a8329da8b5a8752a838cb6b0dd986cd70e9
-  data.tar.gz: b3cb2ba31ce943f33de1d030aced621bd6c2dfe9ff02855e3136aedd5cc579ccd44193447605e6c886798905a024395431ba72bf5953644d9468dbfddf2dce91
+  metadata.gz: 7270713f3b643b674b9bfb6f5c9d3cceb1ba5f72893331314c8f2119f773ccbd708bade4fefc7434d7ca6c38161e718c50ff4b944f5539d28065ccd43c9cffdd
+  data.tar.gz: d4578d786d1518b2b7a8e226be63426006f85cd91a96975a309dfae900b451b361c4df52eeb85362165b8a8daad2ffa4d391bd2272e99bcabed1ddab18dbc537

data/README.md

@@ -206,6 +206,28 @@ config.prefix = "my-app"
 Metrics.count :users, 100500 # => count#my-app.users=100500
 ```
 
+## Scrubbing
+
+L2meter allows plugging in custom scrubbing logic that might be useful in
+environments where logging compliance is important.
+
+```ruby
+config.scrubber = ->(key, value) do
+  begin
+    uri = URI.parse(value)
+    uri.password = "scrubbed" if uri.password
+    uri.to_s
+  rescue URI::Error
+    value
+  end
+end
+
+Metric.log my_url: "https://user:password@example.com"
+# => my-url="https://user:redacted@example.com"
+```
+
+Note that returning nil value will make l2meter omit the field completely.
+
 ## Silence
 
 There's a way to temporary silence the log emitter. This might be userful for

data/lib/l2meter/configuration.rb

@@ -1,7 +1,7 @@
 module L2meter
   class Configuration
     attr_writer :output
-    attr_accessor :source, :prefix, :float_precision
+    attr_accessor :source, :prefix, :float_precision, :scrubber
     attr_reader :context, :key_formatter, :output
 
     DEFAULT_KEY_FORMATTER = ->(key) do

data/lib/l2meter/emitter.rb

@@ -90,12 +90,8 @@ module L2meter
     end
 
     def fire!
-      tokens = @buffer.map do |key, value|
-        next if value.nil?
-        key = format_key(key)
-        value == true ? key : "#{key}=#{format_value(value)}"
-      end.compact
-
+      tokens = @buffer.map { |key, value| build_token(key, value) }
+      tokens.compact!
       tokens.sort! if configuration.sort?
 
       output_queue.last.print tokens.join(SPACE) << NL if tokens.any?
@@ -124,6 +120,14 @@ module L2meter
       end
     end
 
+    def build_token(key, value)
+      value = value.call if Proc === value
+      return if value.nil?
+      value = scrub_value(key, value)
+      return if value.nil?
+      value == true ? key : "#{key}=#{format_value(value)}"
+    end
+
     def format_float(value, unit: nil)
       "%.#{configuration.float_precision}f#{unit}" % value
     end
@@ -143,7 +147,7 @@ module L2meter
 
     def format_value(value)
       case value
-      when /[^\w,.:@-]/
+      when /[^\w,.:@\-\]\[]/
         value.strip.gsub(/\s+/, " ").inspect
       when String
         value.to_s
@@ -151,8 +155,6 @@ module L2meter
         format_float(value)
       when Time
         value.iso8601
-      when Proc
-        format_value(value.call)
       when Hash
         format_value(value.inspect)
       when Array
@@ -162,12 +164,11 @@ module L2meter
       end
     end
 
-    def format_key(key)
-      configuration.key_formatter.call(key)
-    end
-
     def format_keys(hash)
-      hash.each_with_object({}) { |(k, v), a| a[format_key(k)] = v }
+      hash.each_with_object({}) do |(key, value), acc|
+        key = configuration.key_formatter.call(key)
+        acc[key] = value
+      end
     end
 
     def write(params = nil)
@@ -222,5 +223,13 @@ module L2meter
     def elapsed_value(since)
       format_float(Time.now - since, unit: ?s)
     end
+
+    def scrub_value(key, value)
+      if scrubber = configuration.scrubber
+        scrubber.call(key, value)
+      else
+        value
+      end
+    end
   end
 end

data/lib/l2meter/version.rb

@@ -1,3 +1,3 @@
 module L2meter
-  VERSION = "0.9.1".freeze
+  VERSION = "0.10.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: l2meter
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Pavel Pravosud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-18 00:00:00.000000000 Z
+date: 2017-04-07 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -45,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: L2met friendly log formatter