fluent-plugin-filter-list 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f1beff88a018e08d4bc91c64df9c4366fae068b2a1b52943a97dbf7da3db5f7
-  data.tar.gz: 700de6cd91d914d1e24fcd5f00935478d57d60749983d9f2c961f03adcaca97d
+  metadata.gz: 38d4d2dffb112f1d1848a5b19b65012a8b58a98dfd109b2a8aebfc6778ef581d
+  data.tar.gz: 0ea84ac0818d740133cec309afca9a7e6dcc3fa51e9d4374dda61759da3530ae
 SHA512:
-  metadata.gz: 878771c4a28216d0c69c2f2f71235a73dd9bc9031fde4ef32a42b8c3fdac51aae9a81f73e22f6435955adf0011da4d6647bd218efe526c3bb63a437c88c0c6af
-  data.tar.gz: 8a8f76921f0b739c1ca396c4f7ddfafdecd396c6e44dc4cf1f0101c4ffad9996f2479d194a21eb81c1ed5d604824d84ccdb157ad0202fc8fa7cfcd86800359cc
+  metadata.gz: 900364d81be98c75bee9dec18ba8d30521e05931ba692c977e7e849570df4e295e49bb0194a8718219a6037a1990835836ca7e3da28d1bfc3e2e9f99081f1f1a
+  data.tar.gz: 80c826720b8cdb2797c291d6f962d42cea8cd80d42ba5451bad75ee13f7a4e9a01d17d2debf20e77f8aeac02e37a165b7e1bd82add57745064b2135f8d0d1d36

data/.rubocop.yml

@@ -1,6 +1,9 @@
-Naming/UncommunicativeMethodParamName:
+AllCops:
+  TargetRubyVersion: 2.6
+
+Naming/MethodParameterName:
   Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Max: 160
 Style/FormatString:
   EnforcedStyle: sprintf
@@ -45,9 +48,7 @@ Style/TernaryParentheses:
   Enabled: false
 Style/BlockDelimiters:
   AutoCorrect: false
-Style/BlockDelimiters:
-  AutoCorrect: false
 Style/BracesAroundHashParameters:
   Enabled: false
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent

data/.travis.yml

@@ -6,7 +6,6 @@ rvm:
   - 2.6
 before_install:
   - gem update --remote bundler
-  - gem update --system
   - gem install rubocop bundler
 script:
   - bundle exec rake

data/Gemfile

@@ -4,4 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 # Added at 2017-08-14 19:47:59 +0900 by 5hun:
-gem 'rubocop', '~> 0.72.0', require: false, group: [:development]
+gem 'rubocop', '~> 0.78.0', require: false, group: [:development]

data/README.md

@@ -29,6 +29,9 @@ This repository contains two plugins: _Filter_ and _Output_, and expects two mai
 Use the `filter_list` filter. Configure fluentd as follows.
 
 #### ACMatcher
+
+_ACMatcher_ is a matcher using [Aho–Corasick algorithm](https://en.wikipedia.org/wiki/Aho%E2%80%93Corasick_algorithm) to enable faster multiple-pattern matching.
+
 ```
 <filter pattern>
   @type filter_list
@@ -66,7 +69,7 @@ While the following message is passed through as the target field specified in t
 }
 ```
 
-Additionally, the following message is also omitted since `filter_empty` is `true`. The value is determined to be empty when the trimed value is empty.
+Additionally, the following message is also omitted since `filter_empty` is `true`. The value is determined to be empty when the trimmed value is empty.
 
 ```json
 {
@@ -75,6 +78,19 @@ Additionally, the following message is also omitted since `filter_empty` is `tru
 }
 ```
 
+All these examples are _blacklisting_. That is, a text matched to a pattern will be determined to be filtered. The plugin provides the other type of filtering: _whitelisting_. With the type you can filter records that don't match any pattern. You can enable _whitelisting_ by specifying the `action` (the default value is _blacklist_) explicitly as follows.
+
+```
+<filter>
+  @type filter_list
+
+  filter AC
+  key_to_filter foo
+  pattern_file_paths blacklist.txt
+  action whitelist
+</filter>
+```
+
 #### IPMatcher
 ```
 <filter pattern>
@@ -132,6 +148,7 @@ The other use case is to filter messages likewise, but process the filtered mess
   key_to_filter field_name_you_want_to_filter
   pattern_file_paths ["file_including_patterns_separated_by_new_line"]
   filter_empty true
+  action blacklist
 
   <retag>
     add_prefix x # retag non-filtered messages whose tag will be "x.your_tag"

data/fluent-plugin-out_filter_list.gemspec

@@ -21,9 +21,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'minitest', '~> 5.11'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'test-unit', '~> 3.2'
+  spec.add_development_dependency 'bundler', '~> 2.1'
+  spec.add_development_dependency 'minitest', '~> 5.13'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'test-unit', '~> 3.3'
   spec.add_runtime_dependency 'fluentd', '>= 0.14.0', '< 2.0.0'
 end

data/lib/base.rb

@@ -0,0 +1,8 @@
+module BaseFilter
+  def should_filter?(target)
+    return false if target.nil?
+    return true if @filter_empty && target.strip.empty?
+
+    @action == (@matcher.matches?(target) ? :blacklist : :whitelist)
+  end
+end

data/lib/fluent/plugin/filter_filter_list.rb

@@ -2,12 +2,14 @@ require 'fluent/plugin/out_filter_list/version'
 require 'matcher'
 require 'fluent/plugin/filter'
 require 'ip'
+require 'base'
 
 module Fluent
   module Plugin
     class FilterListFilter < Filter
       include Matchers
       include IP
+      include BaseFilter
 
       Plugin.register_filter('filter_list', self)
 
@@ -15,6 +17,7 @@ module Fluent
       config_param :key_to_filter, :string, default: nil
       config_param :pattern_file_paths, :array, default: [], value_type: :string
       config_param :filter_empty, :bool, default: false
+      config_param :action, :enum, list: %i[blacklist whitelist], default: :blacklist
 
       def configure(conf)
         super
@@ -24,7 +27,8 @@ module Fluent
 
       def filter(_tag, _time, record)
         target = record[@key_to_filter]
-        return nil if target && (@matcher.matches?(target) || (@filter_empty && target.strip.empty?))
+
+        return nil if should_filter?(target)
 
         record
       end

data/lib/fluent/plugin/out_filter_list.rb

@@ -2,12 +2,14 @@ require 'fluent/plugin/output'
 require 'fluent/plugin/out_filter_list/version'
 require 'matcher'
 require 'ip'
+require 'base'
 
 module Fluent
   module Plugin
     class FilterListOutput < Output
       include Matchers
       include IP
+      include BaseFilter
 
       Plugin.register_output('filter_list', self)
 
@@ -17,6 +19,7 @@ module Fluent
       config_param :key_to_filter, :string, default: nil
       config_param :pattern_file_paths, :array, default: [], value_type: :string
       config_param :filter_empty, :bool, default: false
+      config_param :action, :enum, list: %i[blacklist whitelist], default: :blacklist
 
       config_section :retag, required: true, multi: false do
         config_param :tag, :string, default: nil
@@ -72,7 +75,7 @@ module Fluent
           target = record[@key_to_filter]
           log.debug "target: #{target}"
           # Do filter
-          if target && (@matcher.matches?(target) || (@filter_empty && target.strip.empty?))
+          if should_filter?(target)
             if @retag_for_filtered
               t = @retag_for_filtered.tag || ((tag && !tag.empty?) ? @prefix_for_filtered_tag + tag : @retag_for_filtered.add_prefix)
               log.debug "re-emit with the tag: '#{t}', originally: '#{tag}'"

data/lib/fluent/plugin/out_filter_list/version.rb

@@ -1,7 +1,7 @@
 module Fluent
   module Plugin
     module FilterList
-      VERSION = "0.6.2"
+      VERSION = "0.7.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-filter-list
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Shun Yanaura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2020-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.11'
+        version: '5.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: fluentd
   requirement: !ruby/object:Gem::Requirement
@@ -106,6 +106,7 @@ files:
 - bin/console
 - bin/setup
 - fluent-plugin-out_filter_list.gemspec
+- lib/base.rb
 - lib/fluent/plugin/filter_filter_list.rb
 - lib/fluent/plugin/out_filter_list.rb
 - lib/fluent/plugin/out_filter_list/version.rb