fluent-plugin-filter_empty_keys 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3d0399e8d3016a5935a1a367c460cfb93955239e
-  data.tar.gz: 7e5da4cc2d21f1266718ae1254f21870b15f1811
+  metadata.gz: 8f90d886f79fd03b913bba8151528489e376380c
+  data.tar.gz: b9e146a6345f7d985ef0003edf71a758cf396d05
 SHA512:
-  metadata.gz: d4ab6e7b4c9da64befecb73f00d23316dbe6cdc649504fd8a859d4278847727f7c59dfb7ab23cca8bd5083d803ab11621fddc62fd0eb360ab05700d6ba50d113
-  data.tar.gz: defd246fb276b6853046dbfa7afbbf976fd93d57fbc15c0e2de888492dc21e94268433785e2b1b92b6458932cf3ecfa61d1b0a232fb6c271fd7874086053020d
+  metadata.gz: d1979232f4de1292104871165ca37889d5b3f6778c2a16da501da6615c5f1015f3fe614414be61aff48045ed2993acaa61bef5b889166700a5c901c1e4468f5e
+  data.tar.gz: f693eb2bba9f3faa8d6418dd6470ff8a749eb83f4f7cd809c752ee82bf615893ec4819ca543c2367c5b372271b51d808741df0ece6d10d42d1aad1d31f116072

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.0.3
+Enhancements:
+
+* Support custome keys empty values.
+
 # 0.0.1
 
 Enhancements:

data/README.md

@@ -14,6 +14,50 @@ Use RubyGems:
 gem install fluent-plugin-filter_empty_keys
 ```
 
+## Configuration Examples
+
+```
+<source>
+  type dummy
+  tag dummy
+  dummy {"field1":"","field2":"2","field3":"2013-02-12 22:04:14 UTC","field4":"","field5":"a,b,c"}
+</source>
+
+<filter **>
+  type empty_keys
+</filter>
+
+<match **>
+  type stdout
+</match>
+```
+
+You should see casted records:
+```
+dummy {"field2":"2","field3":"2013-02-12 22:04:14 UTC","field5":"a,b,c"}
+```
+
+```
+<source>
+  type dummy
+  tag dummy
+  dummy {"field0":0,"field1":"","field2":"Undefined","field3":"2013-02-12 22:04:14 UTC","field4":"","field5":"a,b,c"}
+</source>
+
+<filter **>
+  type empty_keys
+  empty_keys field0:0,field2:Undefined
+</filter>
+
+<match **>
+  type stdout
+</match>
+```
+
+You should see casted records:
+```
+dummy {"field3":"2013-02-12 22:04:14 UTC","field5":"a,b,c"}
+```
 
 ## ChangeLog
 

data/fluent-plugin-filter_empty_keys.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "fluent-plugin-filter_empty_keys"
-  s.version     = "0.0.2"
+  s.version     = "0.0.3"
   s.authors     = ["Al-waleed Shihadeh"]
   s.email       = ["wshihadh@gmail.com"]
   s.homepage    = "https://github.com/wshihadeh/fluent-plugin-filter_empty_keys.git"

data/lib/fluent/plugin/filter_empty_keys.rb

@@ -5,8 +5,33 @@ module Fluent
   class EmptyKeysFilter < Filter
     Fluent::Plugin.register_filter('empty_keys', self)
 
+    config_param :empty_keys, :string, default: nil
+    config_param :keys_delimiter, :string, default: ','
+    config_param :values_delimiter, :string, default: ':'
+
+    def configure(conf)
+        super
+
+        @keys_empty_values = nil
+        @keys_empty_values = parse_empty_values_parameter unless @empty_keys.nil?
+    end
+
     def filter(tag, time, record)
-      record.reject{ |k,v| (v.nil? || v.to_s.empty?) }
+      record.reject{ |k,v| (v.nil? || v.to_s.empty? || (!@keys_empty_values.nil? && v.to_s.eql?(@keys_empty_values[k]))) }
+    end
+
+    private
+
+    def parse_empty_values_parameter
+      keys_empty_values = {}
+
+      @empty_keys.split(@keys_delimiter).each do |pattern_name|
+        key, empty_value, format = pattern_name.split(@values_delimiter, 3)
+        raise ConfigError, "EmptyValue is needed" if empty_value.nil?
+        keys_empty_values[key] = empty_value
+      end
+
+      keys_empty_values
     end
   end
 end

data/test/test_filter_empty_keys.rb

@@ -23,14 +23,18 @@ class TypecastFilterTest < Test::Unit::TestCase
   end
 
   test 'test_empty_keys' do
-    d = create_driver
+    d = create_driver(%[
+        empty_keys Undefined:Undefined,Remove:1
+      ])
     msg = {
-      'integer' => 1,
-      'nil'  => nil,
-      'time'    => '2013-02-12 22:01:15 UTC',
-      'bool'    => 'true',
-      'array'   => 'a,b,c',
-      'empty'   => '',
+      'integer'   => 1,
+      'nil'       => nil,
+      'time'      => '2013-02-12 22:01:15 UTC',
+      'bool'      => 'true',
+      'array'     => 'a,b,c',
+      'empty'     => '',
+      'Undefined' => 'Undefined',
+      'Remove'    => 1,
     }
     filtered = filter(d, [msg]).first[2]
     assert_equal 4, filtered.count
@@ -40,6 +44,7 @@ class TypecastFilterTest < Test::Unit::TestCase
     assert_equal true,  filtered.key?("bool")
     assert_equal true,  filtered.key?("array")
     assert_equal false, filtered.key?("empty")
-
+    assert_equal false, filtered.key?("Undefined")
+    assert_equal false, filtered.key?("Remove")
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-filter_empty_keys
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Al-waleed Shihadeh