fluent-plugin-named_pipe 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eee85e2fbf3e52df81b72475238c435dce417ee7
+  data.tar.gz: ba29697a82c0f05ad6d55624bd4bd56af36aa410
+SHA512:
+  metadata.gz: 9efcfa764c8b4dc21be6d381165b18dead49d2bd7521a9a105c978684a8a6c286cd2f0abd56e120c39c53d6c3317e1bcfe6c4611c5e40b399e494784f56ca625
+  data.tar.gz: ef59af3499e6116275c6a4fce0347502e818b6ecae1e85d788789d0b356ce679a1b9d9b0b1f1c6f00a95243e5986003abb151ed4f0a8b4e34bf903bcb68fff16

data/.gitignore

@@ -0,0 +1,14 @@
+/*.gem
+~*
+#*
+*~
+.bundle
+Gemfile.lock
+.rbenv-version
+vendor
+doc/*
+tmp/*
+coverage
+.yardoc
+.ruby-version
+pkg/*

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+--format Fuubar

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.*
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2014/11/22)
+
+First version

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Naotoshi Seo
+
+MIT License
+
+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,76 @@
+# fluent-plugin-named_pipe
+
+[![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-named_pipe.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-named_pipe)
+
+Named pipe input/output plugin for Fluentd.
+
+# Input Plugin
+
+## Configuration
+
+```apache
+<source>
+  type named_pipe
+  path /path/to/file
+  tag foo.bar
+  format ltsv
+</match>
+```
+
+## Parameters
+
+- path
+
+    The file path of the named pipe
+
+- tag
+
+    The emit tag name
+
+- format
+
+    The input format such as regular expression, `apache2`, `ltsv`, etc. Same with `in_tail` plugin. See http://docs.fluentd.org/articles/in_tail
+
+# Output Plugin
+
+## Configuration
+
+```apache
+<match foo.bar.**>
+  type named_pipe
+  path /path/to/file
+</match>
+```
+
+The output to the named pipe would be like:
+
+```
+foo.bar: {"foo":"bar"}
+```
+
+## Parameters
+
+- path
+
+    The file path of the named pipe
+
+- format
+
+    The output format such as `out_file`, `json`, `ltsv`, `single_value`. Default is `out_file`. 
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new [Pull Request](../../pull/new/master)
+
+## Copyright
+
+Copyright (c) 2014 Naotoshi Seo. See [LICENSE](LICENSE) for details.
+

data/Rakefile

@@ -0,0 +1,18 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+desc 'Run test_unit based test'
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = Dir["test/**/test_*.rb"].sort
+  t.verbose = true
+  #t.warning = true
+end
+task :default => :test
+
+desc 'Open an irb session preloaded with the gem library'
+task :console do
+    sh 'irb -rubygems -I lib'
+end
+task :c => :console

data/fluent-plugin-named_pipe.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-named_pipe"
+  s.version     = "0.1.0"
+  s.authors     = ["Naotoshi Seo"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-named_pipe"
+  s.summary     = "Named pipe input/output plugin for Fluentd"
+  s.description = s.summary
+  s.licenses    = ["MIT"]
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "fluentd"
+  s.add_runtime_dependency "ruby-fifo"
+  if RUBY_PLATFORM =~ /mswin|mingw/i
+    s.add_runtime_dependency "win32-pipe"
+  else
+    s.add_runtime_dependency "mkfifo"
+  end
+  s.add_development_dependency "rake"
+  s.add_development_dependency "test-unit"
+  s.add_development_dependency "pry"
+  s.add_development_dependency "pry-nav"
+end

data/lib/fluent/plugin/in_named_pipe.rb

@@ -0,0 +1,68 @@
+module Fluent
+  class NamedPipeInput < Input
+    Fluent::Plugin.register_input('named_pipe', self)
+
+    config_param :path, :string
+    config_param :tag, :string
+    config_param :format, :string
+
+    unless method_defined?(:log)
+      define_method(:log) { $log }
+    end
+
+    def initialize
+      require 'fifo'
+      super
+    end
+
+    def configure(conf)
+      super
+
+      begin
+        pipe = Fifo.new(@path, :r, :nowait)
+        pipe.close # just to try open
+      rescue => e
+        raise ConfigError, "#{e.class}: #{e.message}"
+      end
+
+      config['format'] = @format
+      configure_parser(conf)
+    end
+
+    def configure_parser(conf)
+      @parser = TextParser.new
+      @parser.configure(conf)
+    end
+
+    def start
+      super
+      @running = true
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      @running = false
+      @thread.join
+      @pipe.close
+    end
+
+    def run
+      @pipe = Fifo.new(@path, :r, :wait)
+
+      while @running
+        begin
+          line = @pipe.readline # blocking
+          time, record = @parser.parse(line)
+          if time and record
+            Engine.emit(@tag, time, record)
+          else
+            log.warn "Pattern not match: #{line.inspect}"
+          end
+        rescue => e
+          log.error "in_named_pipe: unexpected error", :error_class => e.class, :error => e.to_s
+          log.error_backtrace
+        end
+      end
+    end
+  end
+end

data/lib/fluent/plugin/out_named_pipe.rb

@@ -0,0 +1,46 @@
+module Fluent
+  class NamedPipeOutput < Output
+    Plugin.register_output('named_pipe', self)
+
+    config_param :path, :string
+    config_param :format, :string, :default => 'out_file'
+
+    unless method_defined?(:log)
+      define_method(:log) { $log }
+    end
+
+    def initialize
+      require 'fifo'
+      super
+    end
+
+    def configure(conf)
+      super
+
+      begin
+        @pipe = Fifo.new(@path, :w, :nowait)
+      rescue => e
+        raise ConfigError, "#{e.class}: #{e.message}"
+      end
+
+      conf['format'] = @format
+      @formatter = TextFormatter.create(conf)
+    end
+
+    def shutdown
+      @pipe.close
+    end
+
+    def emit(tag, es, chain)
+      es.each do |time, record|
+        @pipe.write @formatter.format(tag, time, record)
+      end
+
+      chain.next
+    rescue => e
+      log.error "out_named_pipe: unexpected error", :error_class => e.class, :error => e.to_s
+      log.error_backtrace
+    end
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,27 @@
+require 'test/unit'
+require 'fluent/log'
+require 'fluent/test'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end
+
+# Stop non required sleep at
+# https://github.com/fluent/fluentd/blob/018791f6b1b0400b71e37df2fb3ad80e456d2c11/lib/fluent/test/base.rb#L56
+# module Fluent
+#   module Test
+#     class TestDriver
+#       def run(&block)
+#         @instance.start
+#         begin
+#           # wait until thread starts
+#           # 10.times { sleep 0.05 }
+#           return yield
+#         ensure
+#           @instance.shutdown
+#         end
+#       end
+#     end
+#   end
+# end

data/test/test_in_named_pipe.rb

@@ -0,0 +1,58 @@
+require_relative 'helper'
+require 'fluent/test'
+require 'fluent/plugin/in_named_pipe'
+
+class NamedPipeInputTest < Test::Unit::TestCase
+  TEST_PATH = 'in_named_pipe'
+
+  setup do
+    Fluent::Test.setup
+  end
+
+  teardown do
+    File.unlink(TEST_PATH) rescue nil
+  end
+
+  def create_driver(conf)
+    Fluent::Test::InputTestDriver.new(Fluent::NamedPipeInput).configure(conf)
+  end
+
+  sub_test_case 'configure' do
+    test 'required parameters' do
+      assert_raise_message("'path' parameter is required") do
+        create_driver(%[
+          tag foo
+        ])
+      end
+
+      assert_raise_message("'tag' parameter is required") do
+        create_driver(%[
+          path #{TEST_PATH}
+        ])
+      end
+    end
+  end
+
+  sub_test_case "emit" do
+    CONFIG = %[
+      path #{TEST_PATH}
+      tag named_pipe
+      format ltsv
+    ]
+
+    test 'read and emit' do
+      d = create_driver(CONFIG)
+      d.run {
+        pipe = Fifo.new(TEST_PATH, :w, :nowait)
+        pipe.write "foo:bar\n"
+      }
+
+      emits = d.emits
+      emits.each do |tag, time, record|
+        assert_equal("named_pipe", tag)
+        assert_equal({"foo"=>"bar\n"}, record)
+      end
+    end
+  end
+end
+

data/test/test_out_named_pipe.rb

@@ -0,0 +1,71 @@
+require_relative 'helper'
+require 'fluent/test'
+require 'fluent/plugin/out_named_pipe'
+require 'fifo'
+
+Fluent::Test.setup
+
+class NamedPipeOutputTest < Test::Unit::TestCase
+  TEST_PATH = "out_named_pipe"
+
+  setup do
+    @tag = 'foo.bar'
+  end
+
+  teardown do
+    File.unlink(TEST_PATH) rescue nil
+  end
+
+  def create_driver(conf)
+    Fluent::Test::OutputTestDriver.new(Fluent::NamedPipeOutput, @tag).configure(conf)
+  end
+
+  sub_test_case 'configure' do
+    test 'required parameter' do
+      assert_raise_message("'path' parameter is required") do
+        create_driver('')
+      end
+
+      d = create_driver(%[path #{TEST_PATH}])
+      assert_equal TEST_PATH, d.instance.path
+    end
+
+    test 'option parameter' do
+      config = %[
+        path #{TEST_PATH}
+      ]
+      d = create_driver(config + %[format ltsv])
+      assert_equal TEST_PATH, d.instance.path
+    end
+  end
+
+  sub_test_case 'write' do
+    CONFIG = %[
+      path #{TEST_PATH}
+      format ltsv
+    ]
+    
+    test 'reader is waiting' do
+      readline = nil
+      thread = Thread.new {
+        pipe = Fifo.new(TEST_PATH, :r, :wait)
+        readline = pipe.readline
+      }
+
+      d = create_driver(CONFIG)
+      d.run do
+        d.emit({'foo' => 'bar'})
+      end
+
+      thread.join
+      assert_equal "foo:bar\n", readline
+    end
+
+    test 'reader is not waiting' do
+      d = create_driver(CONFIG)
+      assert_nothing_raised do
+        d.emit({'foo' => 'bar'})
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-named_pipe
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-fifo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mkfifo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Named pipe input/output plugin for Fluentd
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-named_pipe.gemspec
+- lib/fluent/plugin/in_named_pipe.rb
+- lib/fluent/plugin/out_named_pipe.rb
+- test/helper.rb
+- test/test_in_named_pipe.rb
+- test/test_out_named_pipe.rb
+homepage: https://github.com/sonots/fluent-plugin-named_pipe
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Named pipe input/output plugin for Fluentd
+test_files:
+- test/helper.rb
+- test/test_in_named_pipe.rb
+- test/test_out_named_pipe.rb