fluent-plugin-filter-list 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52c5a00e64374a2b7299e3f279b6cf70ead7af0e
+  data.tar.gz: c1b067e9b9319c1bfc71371f91b3fa3b7af1a3d4
+SHA512:
+  metadata.gz: ffce82c944c72031923e98c2ad22d86653b16397f74b481a686290bcfe81c2ebcf50e16274553f65a09c25beb6acc1282898edc1e215e8619abd8d6f882cc6c6
+  data.tar.gz: 31cef37f016b9fb187fa202a2e022d52f7bc79816737d6215c2e6a5648051882c8a3bef51a2ff3ea347a2ebecfc1c37e853a99daa1beb26afda6b6b90065e2be

data/.gitignore

@@ -0,0 +1,39 @@
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+*.gem
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.4
+  - 2.3.3
+  - 2.4.1
+before_install: gem update bundler

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at metroplexity@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fluent-plugin-out_filter_list.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Shun Yanaura
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# fluent-plugin-filter-list
+
+[![Build Status](https://travis-ci.org/yanana/fluent-plugin-filter-list.svg?branch=master)](https://travis-ci.org/yanana/fluent-plugin-filter-list)
+
+This is a plugin to filter for [Fluentd](http://fluentd.org/) ≧ v0.12.0.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fluent-plugin-out_filter_list'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fluent-plugin-out_filter_list
+
+## Usage
+
+TODO: Write usage instructions here
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fluent-plugin-out_filter_list. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Fluent::Plugin::OutFilterList project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fluent-plugin-out_filter_list/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test' << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fluent/plugin/out_filter_list"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/fluent-plugin-out_filter_list.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fluent/plugin/out_filter_list/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-filter-list"
+  spec.version       = Fluent::Plugin::OutFilterList::VERSION
+  spec.authors       = ["Shun Yanaura"]
+  spec.email         = ["metroplexity@gmail.com"]
+
+  spec.summary       = %q{A fluentd output plugin to filter keywords from messages}
+  spec.description   = %q{A fluentd output plugin to filter keywords from messages}
+  spec.homepage      = "https://github.com/yanana/fluent-plugin-filter-list"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "test-unit", "~> 3.2"
+  spec.add_runtime_dependency "fluentd", "~> 0.12", ">= 0.12.0"
+end

data/lib/aho_corasick.rb

@@ -0,0 +1,85 @@
+module Matchers
+  class ACMatcher
+    attr_reader :trie
+
+    def initialize(patterns)
+      patterns = (patterns || []).compact.reject(&:empty?)
+      @trie = Trie.new patterns
+    end
+
+    def matches?(str)
+      node = @trie.root
+      str.split('').each do |char|
+        node = node.failure while node.children[char].nil? # Follow failure if it exists in case pattern doesn't match
+        node = node.children[char]
+        return true unless node.output.nil?
+      end
+      false
+    end
+  end
+
+  class Trie
+    attr_reader :root
+    def initialize(patterns)
+      @root = Node.new
+      @root.children.default = @root
+      patterns.each do |pattern|
+        insert(pattern)
+      end
+      build
+    end
+
+    def insert(pattern = '')
+      current_node = @root
+      pattern.split('').each_with_index do |char, i|
+        current_node = current_node.insert(char)
+        if i == pattern.length - 1
+          current_node.output = pattern
+        end
+      end
+    end
+
+    def new_queue
+      q = Queue.new
+      @root.children.values.each do |child|
+        q.push(child)
+        child.failure = @root # set root on root's children's failure
+      end
+      q
+    end
+
+    def build
+      # Update failure on each node.
+      # Search longest matching suffix (which becomes failure) by BFS. In case no matching suffix, root becomes failure.
+      q = new_queue
+      until q.empty?
+        cur_node = q.pop
+        cur_node.children.each do |char, child|
+          q.push(child)
+          detect_node = cur_node.failure || @root
+          while detect_node.children[char].nil?
+            detect_node = detect_node.failure
+          end
+          child.failure = detect_node.children[char]
+        end
+      end
+    end
+  end
+
+  class Node
+    attr_reader :children
+    attr_accessor :failure, :output
+
+    def initialize
+      @children = {}
+      @children.default = nil
+      @output = nil
+      @failure = nil
+    end
+
+    def insert(char)
+      @children[char] = Node.new unless @children.key?(char)
+      @children[char]
+    end
+  end
+end

data/lib/fluent/plugin/out_filter_list.rb

@@ -0,0 +1,68 @@
+require 'fluent/plugin/out_filter_list/version'
+require 'aho_corasick'
+
+module Fluent
+  class FilterListOutput < Output
+    include Matchers
+
+    Plugin.register_output('filter_list', self)
+
+    config_param :key_to_filter, :string, :default => nil
+    config_param :patterns_file_path, :string, :default => ''
+
+    config_section :retag, required: true, multi: false do
+      config_param :tag, :string, :default => nil
+      config_param :add_prefix, :string, :default => nil
+    end
+
+    config_section :retag_filtered, param_name: :retag_for_filtered, required: false, multi: false do
+      config_param :tag, :string, :default => nil
+      config_param :add_prefix, :string, :default => nil
+    end
+
+    def initialize
+      super
+    end
+
+    def validate(retag)
+      if !retag
+        return
+      end
+      if !(retag.tag || retag.add_prefix)
+        raise Fluent::ConfigError, "missing tag and add_prefix"
+      end
+      if retag.tag && retag.add_prefix
+        raise Fluent::ConfigError, "tag and add_prefix are mutually exclusive"
+      end
+    end
+
+    def configure(conf)
+      super
+      [@retag, @retag_for_filtered].each { |c| validate c }
+      patterns = @patterns_file_path.empty? ? [] : File.readlines(@patterns_file_path).map(&:chomp).reject(&:empty?)
+      @matcher = ACMatcher.new(patterns)
+      if @retag_for_filtered && @retag_for_filtered.add_prefix
+        @prefix_for_filtered_tag = @retag_for_filtered.add_prefix + "."
+      end
+      if @retag && @retag.add_prefix
+        @prefix = @retag.add_prefix + "."
+      end
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        target = record[@key_to_filter]
+        # Do filter
+        if target && @matcher.matches?(target)
+          if @retag_for_filtered
+            tag = @retag_for_filtered.tag || ((tag && !tag.empty?) ? @prefix_for_filtered_tag + tag : @retag_for_filtered.add_prefix)
+            router.emit(tag, time, record)
+          end
+          next
+        end
+        tag = @retag.tag || ((tag && !tag.empty?) ? @prefix + tag : @retag.add_prefix)
+        router.emit(tag, time, record)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+module Fluent
+  module Plugin
+    module OutFilterList
+      VERSION = "0.2.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter-list
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Shun Yanaura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: A fluentd output plugin to filter keywords from messages
+email:
+- metroplexity@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fluent-plugin-out_filter_list.gemspec
+- lib/aho_corasick.rb
+- lib/fluent/plugin/out_filter_list.rb
+- lib/fluent/plugin/out_filter_list/version.rb
+homepage: https://github.com/yanana/fluent-plugin-filter-list
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: A fluentd output plugin to filter keywords from messages
+test_files: []