fluent-plugin-script-filter 0.0.3.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09bdc6238083ca2bcbe6a5a0c395c4f93bf92287
+  data.tar.gz: 5f5943d8de10241de444af680b2d80a87002e826
+SHA512:
+  metadata.gz: be35f929697e222368a5b750b1671b6bf2ac023dc666d2bfbe4b016a1883902b350d4542623b055078e1aa2823088fa6f28dc3ca6fab47c6c29bd69dd327d7fb
+  data.tar.gz: 731905af425fd9352b450098d760999d41f99e11618163bb1f0523134fb846aba5cd6da6f6fe4636b520914aa306459c42c15f1691917349243b3a49a1e2fdc0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "2.2.2"
+  - "2.1.6"

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 SNakano
+
+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,107 @@
+# fluent-plugin-script
+
+Fluent filter plugin to external ruby script.
+
+[![Build Status](https://travis-ci.org/SNakano/fluent-plugin-script.svg)](https://travis-ci.org/SNakano/fluent-plugin-script)
+[![Gem](https://img.shields.io/gem/dt/fluent-plugin-script.svg)](https://rubygems.org/gems/fluent-plugin-script)
+
+## install
+
+``
+gem install fluent-plugin-filter-script
+``
+
+## Configuration
+
+#### fluent.conf
+```
+<filter foo.bar.*>
+  type script
+  path /etc/fluentd/example.rb
+</filter>
+```
+
+#### external ruby script
+
+```
+def start
+  super
+  # This is the first method to be called when it starts running
+  # Use it to allocate resources, etc.  
+end
+
+def shutdown
+  super
+  # This method is called when Fluentd is shutting down.
+  # Use it to free up resources, etc.
+end
+
+def filter(tag, time, record)
+  # This method implements the filtering logic for individual filters
+  record
+end
+
+```
+
+ref. http://docs.fluentd.org/articles/plugin-development#filter-plugins
+
+## Example
+
+#### example.rb
+
+```ruby
+def filter(tag, time, record)
+  case tag
+  when /.+\.code$/
+    code(record)
+  when /.+\.msg$/
+    message(record)
+  end
+end
+
+def code(record)
+  if record.has_key?("key1")
+    record["code"] = record["key1"].to_i
+    record.delete("key1")
+  end
+  record
+end
+
+def message(record)
+  case record["key2"].to_i
+  when 100..200
+    level = "INFO"
+  when 201..300
+    level = "WARN"
+  else
+    level = "ERROR"
+  end
+  record.delete("key2")
+
+  record["message"] = level + ":" + record["key3"]
+  record.delete("key3")
+  record
+end
+```
+
+#### Example 1
+##### input
+```
+foo.bar.code: {"key1": "200"}
+```
+
+##### output
+```
+foo.bar.code: {"code":200}
+```
+
+#### Example 2
+##### input
+```
+foo.bar.msg: {"key2":280,"key3":"Something happend."}
+```
+
+##### output
+```
+foo.bar.msg: {"message":"WARN:Something happend."}
+```

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << "lib" << "test"
+  test.pattern = "test/**/test_*.rb"
+  test.verbose = true
+end
+
+task default: :test

data/example.rb

@@ -0,0 +1,32 @@
+def filter(tag, time, record)
+  case tag
+  when /.+\.code$/
+    code(record)
+  when /.+\.msg$/
+    message(record)
+  end
+end
+
+def code(record)
+  if record.has_key?("key1")
+    record["code"] = record["key1"].to_i
+    record.delete("key1")
+  end
+  record
+end
+
+def message(record)
+  case record["key2"].to_i
+  when 100..200
+    level = "INFO"
+  when 201..300
+    level = "WARN"
+  else
+    level = "ERROR"
+  end
+  record.delete("key2")
+
+  record["message"] = level + ":" + record["key3"]
+  record.delete("key3")
+  record
+end

data/fluent-plugin-script.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |s|
+  s.name          = "fluent-plugin-script-filter"
+  s.version       = "0.0.3.1"
+  s.licenses      = ["MIT"]
+  s.summary       = "Fluentd filter plugin to external ruby script"
+  s.description   = s.summary
+  s.authors       = ["KushalBhandari"]
+  s.email         = ["kushwiz@gmail.com"]
+  s.homepage      = "https://github.com/kushwiz/fluent-plugin-script"
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- test/*`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd", "~> 0.12"
+  s.add_development_dependency "rake", "~> 10.4.2"
+  s.add_development_dependency "test-unit", "~> 3.1.3"
+end

data/lib/fluent/plugin/filter_script.rb

@@ -0,0 +1,22 @@
+module Fluent
+  class ScriptFilter < Filter
+    Plugin.register_filter('script', self)
+
+    config_param :path, :string
+
+    def filter(tag, time, record)
+      record
+    end
+
+    def configure(conf)
+      super
+      load_script_file(conf['path'].to_s)
+    end
+
+    def load_script_file(path)
+      raise ConfigError, "Ruby script file does not exist: #{path}" unless File.exist?(path)
+      eval "self.instance_eval do;" + IO.read(path) + ";end"
+    end
+  end
+end
+

data/test/plugin/example.rb

@@ -0,0 +1,4 @@
+def filter(tag, time, record)
+  record['message'].gsub!(/GET/, "PUT")
+  record
+end

data/test/plugin/test_filter_script.rb

@@ -0,0 +1,46 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+require 'fluent/plugin/filter_script'
+
+class RubyFilterTest < Test::Unit::TestCase
+  include Fluent
+
+  setup do
+    Fluent::Test.setup
+  end
+
+  def create_driver(conf = '')
+    Test::FilterTestDriver.new(ScriptFilter).configure(conf, true)
+  end
+
+  sub_test_case 'configure' do
+    test 'not set required' do
+      conf = ''
+      assert_raises(ConfigError) { create_driver(conf) }
+    end
+    test 'wrong file path' do
+      conf = 'path /not-exit-ruby-file-path'
+      assert_raises(ConfigError) { create_driver(conf) }
+    end
+    test 'file exist' do
+      conf = "path #{__dir__}/example.rb"
+      assert_nothing_raised { create_driver(conf) }
+    end
+  end
+
+  sub_test_case 'filter' do
+    def emit(conf, msg)
+      d = create_driver(conf)
+      d.run {
+        d.emit({'foo' => 'bar', 'message' => msg}, Fluent::Engine.now)
+      }.filtered
+    end
+    test 'execute filter' do
+      conf = "path #{__dir__}/example.rb"
+      msg  = "2015/02/10T01:10:20.123456 INFO GET /ping"
+      es   = emit(conf, msg)
+      assert_equal("2015/02/10T01:10:20.123456 INFO PUT /ping", es.first[1]['message'])
+    end
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-script-filter
+version: !ruby/object:Gem::Version
+  version: 0.0.3.1
+platform: ruby
+authors:
+- KushalBhandari
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.3
+description: Fluentd filter plugin to external ruby script
+email:
+- kushwiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example.rb
+- fluent-plugin-script.gemspec
+- lib/fluent/plugin/filter_script.rb
+- test/plugin/example.rb
+- test/plugin/test_filter_script.rb
+homepage: https://github.com/kushwiz/fluent-plugin-script
+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.10
+signing_key: 
+specification_version: 4
+summary: Fluentd filter plugin to external ruby script
+test_files:
+- test/plugin/example.rb
+- test/plugin/test_filter_script.rb