fluent-plugin-tcp-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55d3d66e50383de883f0b96b3dbda9b11aaf018c
+  data.tar.gz: 9f9fc07d5bf60422e8013a7e612d55d63c8aa376
+SHA512:
+  metadata.gz: b5efa08171a884902ca46264763b6e280bc0c86c7bf5cb726033c830e2d23760ab6d7612e8bf6d52576b62befad437abe791de931df9f8ec3992e921baca8b2f
+  data.tar.gz: b7fc7d6de33069e9e6bb4b3e1940a0595fcb41f7546c77283689e7109218c04465c015f4325d8c8a2b3e6f2aff9127061171cf3072939a9470fd63f52b0402c0

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    fluent-plugin-tcp-client (0.1.0)
+      fluentd (~> 0.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    cool.io (1.4.6)
+    fluentd (0.14.11)
+      cool.io (~> 1.4.5)
+      http_parser.rb (>= 0.5.1, < 0.7.0)
+      msgpack (>= 0.7.0, < 2.0.0)
+      serverengine (>= 2.0.4, < 3.0.0)
+      sigdump (~> 0.2.2)
+      strptime (~> 0.1.7)
+      tzinfo (~> 1.0)
+      tzinfo-data (~> 1.0)
+      yajl-ruby (~> 1.0)
+    http_parser.rb (0.6.0)
+    msgpack (1.0.3)
+    power_assert (0.4.1)
+    rake (11.3.0)
+    serverengine (2.0.4)
+      sigdump (~> 0.2.2)
+    sigdump (0.2.4)
+    strptime (0.1.9)
+    test-unit (3.2.3)
+      power_assert
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    tzinfo-data (1.2016.10)
+      tzinfo (>= 1.0.0)
+    yajl-ruby (1.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fluent-plugin-tcp-client!
+  rake (~> 11.0)
+  test-unit (~> 3.2)
+
+BUNDLED WITH
+   1.13.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Active Shadow LLC
+
+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/Rakefile

@@ -0,0 +1,12 @@
+require "bundler"
+require "bundler/gem_tasks"
+
+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/fluent-plugin-tcp-client.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "fluent-plugin-tcp-client"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Bryan Richardson"]
+  spec.email         = ["bryan@activeshadow.com"]
+  spec.description   = %q{Fluentd output plugin for persistent TCP connections}
+  spec.summary       = %q{Fluentd output plugin for persistent TCP connections}
+  spec.homepage      = "https://github.com/activeshadow/fluent-plugin-tcp-client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+ 
+  spec.add_dependency "fluentd", ["~> 0.14.0"]
+
+  spec.add_development_dependency "rake",      ["~> 11.0"]
+  spec.add_development_dependency "test-unit", ["~> 3.2"]
+end

data/lib/fluent/plugin/out_tcp_client.rb

@@ -0,0 +1,77 @@
+require 'fluent/plugin/output'
+
+module Fluent::Plugin
+  class TCPClientOutput < Output
+    Fluent::Plugin.register_output('tcp_client', self)
+
+    helpers :formatter, :compat_parameters
+
+    def initialize
+      super
+    end
+
+    config_param :host, :string,  default: '127.0.0.1'
+    config_param :port, :integer, default: nil
+
+    config_section :format do
+      config_set_default :@type, 'json'
+    end
+
+    attr_reader :formatter # for testing
+
+    def configure(conf)
+      compat_parameters_convert(conf, :formatter)
+
+      super
+
+      @formatter = formatter_create
+      @sock = nil
+    end
+
+    def start
+      super
+      connect
+    end
+
+    def shutdown
+      super
+      disconnect
+    end
+
+    def format(tag, time, record)
+      @formatter.format(tag, time, record)
+    end
+
+    def write(chunk)
+      connect
+      tries ||= 3
+
+      chunk.write_to(@sock)
+    rescue => e
+      if (tries -= 1) > 0
+        reconnect
+        retry
+      else
+        $log.warn("Failed writing data to socket: #{e}")
+      end
+    end
+
+    #######
+    private
+    #######
+
+    def connect
+      @sock ||= TCPSocket.new(@host, @port)
+    end
+
+    def disconnect
+      @sock.close rescue nil
+      @sock = nil
+    end
+
+    def reconnect
+      disconnect
+      connect
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fluent/test'
+require 'fluent/test/helpers'
+
+include Fluent::Test::Helpers
+
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args); end
+  }
+
+  $log = nulllogger
+end
+
+require 'fluent/plugin/out_tcp_client'
+
+class Test::Unit::TestCase; end

data/test/plugin/test_out_tcp_client.rb

@@ -0,0 +1,82 @@
+require 'helper'
+require 'fluent/test/driver/output'
+
+class TCPClientOutputTest < Test::Unit::TestCase
+  setup do
+    Fluent::Test.setup
+    @port = rand(20000..30000)
+    start_stub_socket(@port)
+  end
+
+  teardown do
+    stop_stub_socket
+  end
+
+  def create_driver(conf = '')
+    Fluent::Test::Driver::Output.new(Fluent::Plugin::TCPClientOutput).configure(conf)
+  end
+
+  sub_test_case 'configure' do
+    test 'check default' do
+      assert_nothing_raised do
+        d = create_driver
+        assert { d.instance.formatter.is_a? Fluent::Plugin::JSONFormatter }
+      end
+    end
+  end
+
+  sub_test_case "test output" do
+    def output(msgs = [''])
+      config = %[
+        host localhost
+        port #{@port}
+        <format>
+          @type json
+        </format>
+        <buffer>
+          @type memory
+          flush_mode immediate
+        </buffer>
+      ]
+
+      d = create_driver(config)
+      t = event_time("2011-01-02 13:14:15.123")
+
+      d.run(default_tag: 'test') do
+        msgs.each do |m|
+          d.feed(t, m)
+        end
+      end
+
+      d.formatted
+    end
+
+    test 'typical usage' do
+      msgs = [{'a' => 1},{'a' => 2}]
+      output(msgs)
+    end
+  end
+
+  def start_stub_socket(port)
+    @server = TCPServer.new(port)
+    @stub_running = true
+
+    Thread.start do
+      while(@stub_running) do
+        Thread.start(server.accept) do |client|
+          while (b = client.read)
+            puts ">> #{b}"
+          end
+
+          client.close
+        end
+      end
+    end
+
+    server.close rescue nil
+  end
+
+  def stop_stub_socket
+    @stub_running = false
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-tcp-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryan Richardson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.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'
+description: Fluentd output plugin for persistent TCP connections
+email:
+- bryan@activeshadow.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- fluent-plugin-tcp-client.gemspec
+- lib/fluent/plugin/out_tcp_client.rb
+- pkg/fluent-plugin-tcp-client-0.1.0.gem
+- test/helper.rb
+- test/plugin/test_out_tcp_client.rb
+homepage: https://github.com/activeshadow/fluent-plugin-tcp-client
+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.8
+signing_key: 
+specification_version: 4
+summary: Fluentd output plugin for persistent TCP connections
+test_files:
+- test/helper.rb
+- test/plugin/test_out_tcp_client.rb