fluent-plugin-keep-forward 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 89a30d749bd28ea0efcd3b12ef903907bfc18a8a
+  data.tar.gz: 85572acd2c42282174cc2cfee4e2289d49223c5c
+SHA512:
+  metadata.gz: 520e8c13dac8aa2ea721cafc891d7a72fcd61edcda97fcdf2291fd1b9e39b98d8acb1fc3aa36d02b3f99b8710eb8eafc61e0668ae11769049bc8b994c6038493
+  data.tar.gz: 56f82fd672b9df9e2ff338660ceaca1ee283ca166bc5ec31284295e6d80eabe5a697b8e81c3719ecf302afb39a96ff8faf73b681b59d011e73128af4c823384a

data/.gitignore

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

data/.rdebugrc

@@ -0,0 +1,4 @@
+set autolist
+set autoeval
+set autoreload
+

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p0

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+gemfile:
+  - Gemfile

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 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,32 @@
+# fluent-plugin-keep-forward [![Build Status](https://secure.travis-ci.org/sonots/fluent-plugin-keep-forward.png?branch=master)](http://travis-ci.org/sonots/fluent-plugin-keep-forward) [![Dependency Status](https://gemnasium.com/sonots/fluent-plugin-keep-forward.png)](https://gemnasium.com/sonots/fluent-plugin-keep-forward)
+
+testing ruby: 1.9.2, 1.9.3, 2.0.0;  fluentd: 0.10.x
+
+## About
+
+This is an extension of fluentd out\_forward plugin to keep fowarding log data to the same node (as much as possible).
+
+## Configuration
+
+Exactly same with out\_forward plugin. See http://docs.fluentd.org/articles/out_forward
+
+## Log
+
+This plugin outputs log messages like
+
+    $ grep 'keep forwarding' /var/log/td-agent/td-agent.log
+    2013-03-15 10:35:06 +0900: keep forwarding tag 'fluent.info' to node 'localhost:24224' host="localhost" port=24224 weight=60
+
+You can tell the address of forwarding node easily. 
+
+## 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) 2013 Naotoshi SEO. See [LICENSE](LICENSE) for details.

data/Rakefile

@@ -0,0 +1,15 @@
+# encoding: utf-8
+require "bundler/gem_tasks"
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+task :default => :spec
+
+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-keep-forward.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "fluent-plugin-keep-forward"
+  s.version     = "0.0.1"
+  s.authors     = ["Naotoshi SEO"]
+  s.email       = ["sonots@gmail.com"]
+  s.homepage    = "https://github.com/sonots/fluent-plugin-keep-forward"
+  s.summary     = "out_foward extension to keep forwarding to a node"
+  s.description = s.summary
+
+  s.rubyforge_project = "fluent-plugin-keep-forward"
+
+  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_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
+end

data/lib/fluent/plugin/out_keep_forward.rb

@@ -0,0 +1,49 @@
+require 'fluent/plugin/out_forward'
+
+class Fluent::KeepForwardOutput < Fluent::ForwardOutput
+  Fluent::Plugin.register_output('keep_forward', self)
+
+  def write_objects(tag, es)
+    @node ||= {}
+    if @node[tag] and @node[tag].available? and @weight_array.include?(@node[tag])
+      begin
+        send_data(@node[tag], tag, es)
+        return
+      rescue
+        weight_send_data(tag, es)
+      end
+    else
+      weight_send_data(tag, es)
+    end
+  end
+
+  def weight_send_data(tag, es)
+    error = nil
+
+    wlen = @weight_array.length
+    wlen.times do
+      @rr = (@rr + 1) % wlen
+      node = @weight_array[@rr]
+
+      if node.available?
+        begin
+          send_data(node, tag, es)
+          @node[tag] = node
+          $log.info "keep forwarding tag '#{tag}' to node '#{node.name}'", :host=>node.host, :port=>node.port, :weight=>node.weight
+          return
+        rescue
+          # for load balancing during detecting crashed servers
+          error = $!  # use the latest error
+        end
+      end
+    end
+
+    @node[tag] = nil
+    $log.info "keep forwarding tag '#{tag}' is lost"
+    if error
+      raise error
+    else
+      raise "no nodes are available"  # TODO message
+    end
+  end
+end

data/spec/out_keep_forward_spec.rb

@@ -0,0 +1,64 @@
+# encoding: UTF-8
+require_relative 'spec_helper'
+
+shared_context 'keep_forward_init' do
+  before { Fluent::Test.setup }
+  CONFIG = %[
+    <server>
+      host localhost
+      port 24224
+    </server>
+    <server>
+      host localhost
+      port 24225
+    </server>
+  ]
+  let(:tag) { 'syslog.host1' }
+  let(:es)  { Object.new }
+  let(:driver) { Fluent::Test::OutputTestDriver.new(Fluent::KeepForwardOutput, tag).configure(CONFIG).instance }
+end
+
+shared_context 'keep_forward_try_once' do
+  before do
+    # simpler version of Fluent::ForwardOutput#start method
+    driver.instance_variable_set(:@rand_seed, Random.new.seed)
+    driver.send(:rebuild_weight_array)
+    driver.instance_variable_set(:@rr, 0)
+    # try send once to cache keep_node
+    driver.stub(:send_data) # stub
+    driver.write_objects(tag, es)
+  end
+  let!(:keep_node) { driver.instance_variable_get(:@node)[tag] }
+  let!(:unkeep_node) { (driver.instance_variable_get(:@nodes) - [keep_node]).first }
+end
+
+describe Fluent::KeepForwardOutput do
+  include_context 'keep_forward_init'
+  include_context 'keep_forward_try_once'
+
+  describe 'keep forwarding if no problem?' do
+    before { driver.should_receive(:send_data).with(keep_node, tag, es) }
+    it { driver.write_objects(tag, es) }
+  end
+
+  describe 'switch if not available?' do
+    before { keep_node.available = false }
+
+    before { driver.should_receive(:send_data).with(unkeep_node, tag, es) }
+    it { driver.write_objects(tag, es) }
+  end
+
+  describe 'switch if not included in weight_array?' do
+    before { driver.instance_variable_set(:@weight_array, [unkeep_node]) }
+
+    before { driver.should_receive(:send_data).with(unkeep_node, tag, es) }
+    it { driver.write_objects(tag, es) }
+  end
+
+  describe 'switch if send_data to keep_node raises?' do
+    before { driver.stub(:send_data).with(keep_node, tag, es).and_raise(StandardError) }
+
+    before { driver.should_receive(:send_data).with(unkeep_node, tag, es) }
+    it { driver.write_objects(tag, es) }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# encoding: UTF-8
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default, :test)
+Bundler.require(:default, :test)
+
+require 'fluent/test'
+require 'rspec'
+require 'pry'
+
+$TESTING=true
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'fluent/plugin/out_keep_forward'

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-keep-forward
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi SEO
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-15 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: 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: rspec
+  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'
+description: out_foward extension to keep forwarding to a node
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rdebugrc
+- .rspec
+- .ruby-version
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-keep-forward.gemspec
+- lib/fluent/plugin/out_keep_forward.rb
+- spec/out_keep_forward_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/fluent-plugin-keep-forward
+licenses: []
+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: fluent-plugin-keep-forward
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: out_foward extension to keep forwarding to a node
+test_files:
+- spec/out_keep_forward_spec.rb
+- spec/spec_helper.rb