fluent-plugin-filter-single_key 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 708465fbc3e9c986d6fd1dbaa9e30ac5d1a6ec3f
+  data.tar.gz: 45e958e5e96d36df05d39f702b9c1bb0b0f3113d
+SHA512:
+  metadata.gz: 2d0f117455700b25de7a4ca66513a879849e749a8f07f92965871696bc882f230638b34eab302905123c241499e96537aa2e695a6ffc5c250407f1b86fab6d47
+  data.tar.gz: 205d1b058a4a7c53ce787d5a839f0febd010db9ee1c9b40d96b9208976e17de3b83b72e90b22f8c8817229934f1cad2c16d72ef799f98d949687c92b1654545b

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.2.8
+  - 2.3.5
+  - 2.4.2
+before_install: gem install bundler

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 joker1007
+
+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,73 @@
+# fluent-plugin-filter-single_key
+
+[Fluentd](https://fluentd.org/) filter plugin that Explode record to single key record.
+
+## Installation
+
+### RubyGems
+
+```
+$ gem install fluent-plugin-filter-single_key
+```
+
+### Bundler
+
+Add following line to your Gemfile:
+
+```ruby
+gem "fluent-plugin-filter-single_key"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Configuration
+
+### key_pattern (string) (required)
+
+regexp pattern for target key
+
+### keep_key_pattern (string) (optional)
+
+regexp pattern for keep key
+
+### new_key (string) (optional)
+
+If this param is set, replace this value as new key
+
+You can copy and paste generated documents here.
+
+## Sample
+
+### Config
+
+```
+<filter sample.tag>
+  key_pattern foo(\d)
+  new_key bar\1
+  keep_key_pattern other1
+</filter>
+```
+
+### Incoming Record
+
+```
+{"foo1" => 1, "foo2" => 2, "other1" => 99, "other2" => 100}
+```
+
+### Outgoing Record
+
+```
+{"bar1" => 1, "other1" => 99}
+{"bar2" => 2, "other1" => 99}
+{"bar3" => 3, "other1" => 99}
+```
+
+## Copyright
+
+* Copyright(c) 2017- joker1007
+* License
+  * MIT

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs.push("lib", "test")
+  t.test_files = FileList["test/**/test_*.rb"]
+  t.verbose = true
+  t.warning = true
+end
+
+task default: [:test]

data/fluent-plugin-filter-single_key.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name    = "fluent-plugin-filter-single_key"
+  spec.version = "0.1.0"
+  spec.authors = ["joker1007"]
+  spec.email   = ["kakyoin.hierophant@gmail.com"]
+
+  spec.summary       = %q{Fluentd filter plugin that Explode record to single key record.}
+  spec.description   = %q{Fluentd filter plugin that Explode record to single key record.}
+  spec.homepage      = "https://github.com/joker1007/fluent-plugin-filter-single_key"
+  spec.license       = "MIT"
+
+  test_files, files  = `git ls-files -z`.split("\x0").partition do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.files         = files
+  spec.executables   = files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = test_files
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "test-unit", "~> 3.0"
+  spec.add_runtime_dependency "fluentd", [">= 0.14.10", "< 2"]
+end

data/lib/fluent/plugin/filter_single_key.rb

@@ -0,0 +1,54 @@
+require "fluent/plugin/filter"
+
+module Fluent
+  module Plugin
+    class SingleValueFilter < Fluent::Plugin::Filter
+      Fluent::Plugin.register_filter("single_key", self)
+
+      desc "regexp pattern for target key"
+      config_param :key_pattern, :string
+
+      desc "regexp pattern for keep key"
+      config_param :keep_key_pattern, :string, default: nil
+
+      desc "If this param is set, replace this value as new key"
+      config_param :new_key, :string, default: nil
+
+      def configure(conf)
+        super
+
+        @key_pattern = Regexp.new(@key_pattern)
+        @keep_key_pattern = Regexp.new(@keep_key_pattern) if @keep_key_pattern
+      end
+
+      def filter_stream(tag, es)
+        new_es = MultiEventStream.new
+        es.each do |time, record|
+          begin
+            record.each do |k, v|
+              if k =~ @key_pattern
+                new_record =
+                  if @new_key
+                    {k.gsub(@key_pattern, @new_key) => v}
+                  else
+                    {k => v}
+                  end
+
+                if @keep_key_pattern
+                  keep_record = record.select { |k2, _| k2 =~ @keep_key_pattern }
+                  unless keep_record.empty?
+                    new_record = keep_record.merge(new_record)
+                  end
+                end
+                new_es.add(time, new_record)
+              end
+            end
+          rescue => e
+            router.emit_error_event(tag, time, record, e)
+          end
+        end
+        new_es
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift(File.expand_path("../../", __FILE__))
+require "test-unit"
+require "fluent/test"
+require "fluent/test/driver/filter"
+require "fluent/test/helpers"
+
+Test::Unit::TestCase.include(Fluent::Test::Helpers)
+Test::Unit::TestCase.extend(Fluent::Test::Helpers)

data/test/plugin/test_filter_single_key.rb

@@ -0,0 +1,61 @@
+require "helper"
+require "fluent/plugin/filter_single_key.rb"
+
+class SingleValueFilterTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+  end
+
+  test "#configure" do
+    d = create_driver
+
+    assert { d.instance.key_pattern == /foo(\d)/ }
+    assert { d.instance.new_key == 'bar\1' }
+  end
+
+  test "#filter_stream" do
+    d = create_driver
+
+    d.run do
+      d.feed("tag", Time.now.to_i, {"foo1" => 1, "foo2" => 2, "no_match" => 99})
+    end
+
+    assert { d.filtered_records == [{"bar1" => 1}, {"bar2" => 2}] }
+  end
+
+  test "#filter_stream without new_key" do
+    d = create_driver(%q{
+      key_pattern foo(\d)
+    })
+
+    d.run do
+      d.feed("tag", Time.now.to_i, {"foo1" => 1, "foo2" => 2, "no_match" => 99})
+    end
+
+    assert { d.filtered_records == [{"foo1" => 1}, {"foo2" => 2}] }
+  end
+
+  test "#filter_stream wit keep_key_pattern" do
+    d = create_driver(%q{
+      key_pattern foo(\d)
+      keep_key_pattern no_match
+    })
+
+    d.run do
+      d.feed("tag", Time.now.to_i, {"foo1" => 1, "foo2" => 2, "no_match" => 99})
+    end
+
+    assert { d.filtered_records == [{"foo1" => 1, "no_match" => 99}, {"foo2" => 2, "no_match" => 99}] }
+  end
+
+  private
+
+  DEFAULT_CONF = %q{
+    key_pattern foo(\d)
+    new_key bar\1
+  }
+
+  def create_driver(conf = DEFAULT_CONF)
+    Fluent::Test::Driver::Filter.new(Fluent::Plugin::SingleValueFilter).configure(conf)
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-filter-single_key
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- joker1007
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Fluentd filter plugin that Explode record to single key record.
+email:
+- kakyoin.hierophant@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-filter-single_key.gemspec
+- lib/fluent/plugin/filter_single_key.rb
+- test/helper.rb
+- test/plugin/test_filter_single_key.rb
+homepage: https://github.com/joker1007/fluent-plugin-filter-single_key
+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.13
+signing_key: 
+specification_version: 4
+summary: Fluentd filter plugin that Explode record to single key record.
+test_files:
+- test/helper.rb
+- test/plugin/test_filter_single_key.rb