fluent-plugin-filter_empty_keys 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8f90d886f79fd03b913bba8151528489e376380c
-  data.tar.gz: b9e146a6345f7d985ef0003edf71a758cf396d05
+SHA256:
+  metadata.gz: 8d9c1e349c66044733fba36cee0f128b368c335045ff619a29cc1550fccceabf
+  data.tar.gz: 9b005343fa79f152c1c8da7187f6b0e9285feaffeb50fb6e3632f635575ea590
 SHA512:
-  metadata.gz: d1979232f4de1292104871165ca37889d5b3f6778c2a16da501da6615c5f1015f3fe614414be61aff48045ed2993acaa61bef5b889166700a5c901c1e4468f5e
-  data.tar.gz: f693eb2bba9f3faa8d6418dd6470ff8a749eb83f4f7cd809c752ee82bf615893ec4819ca543c2367c5b372271b51d808741df0ece6d10d42d1aad1d31f116072
+  metadata.gz: f25ed059007a427c9582b90e92b134aabc1f080243c54d512b6a338bf29af9269bb367389f8079bc5a784c580f33a19ac1f397964f6c82fa6ee18d660f8926e8
+  data.tar.gz: 0f10f8300503bd1cdb834ad975c589230c8f7cd3e7556c489fc928aab8a5952512072993fc28bd0894a7fcad7a07f410d80758fb8542ad8af00f8329ab8e276e

data/CHANGELOG.md

@@ -1,7 +1,14 @@
+# 0.0.4
+Enhancements:
+
+* Support custom empty values.
+* updated examples with `@type` instead deprecated `type`
+
+
 # 0.0.3
 Enhancements:
 
-* Support custome keys empty values.
+* Support custom keys empty values.
 
 # 0.0.1
 

data/README.md

@@ -1,4 +1,4 @@
-# fluent-plugin-filter_typecast
+# fluent-plugin-filter_empty_keys
 
 A Fluentd filter plugin to filter empty keys
 
@@ -18,45 +18,68 @@ gem install fluent-plugin-filter_empty_keys
 
 ```
 <source>
-  type dummy
+  @type dummy
   tag dummy
-  dummy {"field1":"","field2":"2","field3":"2013-02-12 22:04:14 UTC","field4":"","field5":"a,b,c"}
+  dummy {"field1":"", "field2":"2", "field3":"2013-02-12 22:04:14 UTC", "field4":"", "field5":"a,b,c"}
 </source>
 
 <filter **>
-  type empty_keys
+  @type empty_keys
 </filter>
 
 <match **>
-  type stdout
+  @type stdout
 </match>
 ```
 
 You should see casted records:
 ```
-dummy {"field2":"2","field3":"2013-02-12 22:04:14 UTC","field5":"a,b,c"}
+dummy {"field2":"2", "field3":"2013-02-12 22:04:14 UTC", "field5":"a,b,c"}
 ```
 
 ```
 <source>
-  type dummy
+  @type dummy
   tag dummy
-  dummy {"field0":0,"field1":"","field2":"Undefined","field3":"2013-02-12 22:04:14 UTC","field4":"","field5":"a,b,c"}
+  dummy {"field0":0, "field1":"", "field2":"Undefined", "field3":"2013-02-12 22:04:14 UTC", "field4":"", "field5":"a,b,c"}
 </source>
 
 <filter **>
-  type empty_keys
+  @type empty_keys
   empty_keys field0:0,field2:Undefined
 </filter>
 
 <match **>
-  type stdout
+  @type stdout
 </match>
 ```
 
 You should see casted records:
 ```
-dummy {"field3":"2013-02-12 22:04:14 UTC","field5":"a,b,c"}
+dummy {"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":"-"}
+</source>
+
+<filter **>
+  @type empty_keys
+  empty_values -,0
+  empty_values_delimiter ,
+</filter>
+
+<match **>
+  @type stdout
+</match>
+```
+
+You should see casted records:
+```
+dummy {"field2":"Undefined","field3":"2013-02-12 22:04:14 UTC"}
 ```
 
 ## ChangeLog

data/example.conf

@@ -1,7 +1,7 @@
 <filter **>
-  type empty_keys
+  @type empty_keys
 </filter>
 
 <match **>
-  type stdout
+  @type stdout
 </match>

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.3"
+  s.version     = "0.0.4"
   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,33 +5,52 @@ module Fluent
   class EmptyKeysFilter < Filter
     Fluent::Plugin.register_filter('empty_keys', self)
 
+    config_param :empty_values, :string, default: nil
     config_param :empty_keys, :string, default: nil
-    config_param :keys_delimiter, :string, default: ','
-    config_param :values_delimiter, :string, default: ':'
+    config_param :empty_keys_delimiter, :string, default: ','
+    config_param :empty_values_delimiter, :string, default: ','
+    config_param :empty_keys_value_delimiter, :string, default: ':'
 
     def configure(conf)
-        super
-
-        @keys_empty_values = nil
-        @keys_empty_values = parse_empty_values_parameter unless @empty_keys.nil?
+      super
+      @all_empty_values = parse_empty_values_parameter
+      @keys_empty_values = nil
+      @keys_empty_values = parse_empty_keys_parameter unless @empty_keys.nil?
     end
 
-    def filter(tag, time, record)
-      record.reject{ |k,v| (v.nil? || v.to_s.empty? || (!@keys_empty_values.nil? && v.to_s.eql?(@keys_empty_values[k]))) }
+    def filter(_tag, _time, record)
+      record.reject do |k, v|
+        (
+          v.nil? ||
+          v.to_s.empty? ||
+          @all_empty_values.include?(v.to_s) ||
+          (!@keys_empty_values.nil? && v.to_s.eql?(@keys_empty_values[k]))
+        )
+      end
     end
 
     private
 
-    def parse_empty_values_parameter
+    def parse_empty_keys_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?
+      @empty_keys.split(@empty_keys_delimiter).each do |pattern_name|
+        key, empty_value, _format = pattern_name.split(@empty_keys_value_delimiter, 3)
+        raise ConfigError, 'EmptyValue is needed' if empty_value.nil?
+
         keys_empty_values[key] = empty_value
       end
 
       keys_empty_values
     end
+
+    def parse_empty_values_parameter
+      if @empty_values.nil?
+        []
+      else
+        @empty_values.split(@empty_values_delimiter)
+      end
+    end
+
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-filter_empty_keys
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Al-waleed Shihadeh
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2021-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
@@ -104,7 +104,7 @@ homepage: https://github.com/wshihadeh/fluent-plugin-filter_empty_keys.git
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -119,9 +119,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
 summary: A Fluentd filter plugin to filter empty keys
 test_files: