fluent-plugin-out-http-buffered 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWU0ZDllMjIzMTA1MjkxZWVlNDdiMzJlZGZiMGUzYWExNWNiZjEwMg==
+  data.tar.gz: !binary |-
+    OTExYzg3MDQ2YWZiYjQwZTVhOTI1ZGY4ZjVkOGJjMmQ1OTQ3NGU3OA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGY5MDdlMGM5ZGVhZDIxMTU0ZjI4ZWIyYTJhY2Q0YTM0NjUzYTI4ZWU2OGEx
+    Yzg4Yzc1OGEzN2M5ODQ1NWJhMGI4NTcxMWExM2IzOTE3NDVmYTMxNDBmOGRm
+    NTdiY2Y1YTA5YTY1MmVjZGEwMTQ5MmE4MWQ5NjBlMjYxMjJjYWU=
+  data.tar.gz: !binary |-
+    ZjcxOThiZWYzNTMxMzUwMTUwYThjOTBlMTg1NmY0NjVlM2I4N2I3ZDU3NmMx
+    MjI2YzVhOTE0ZTdhN2Y4ZjA5MDkwMTM0OTZmNTgwZGI0N2IwMWY2MmEyYzM2
+    Y2JjMDYxNTlkYzE1MzQyYWJiMGYyYTY3OGMxNTdlNjA0YTQ3OWM=

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 ablagoev
+
+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.rdoc

@@ -0,0 +1,36 @@
+= fluent-out-http-buffered {<img src="https://travis-ci.org/ablagoev/fluent-plugin-out-http-buffered.png?branch=master" />}[https://travis-ci.org/ablagoev/fluent-plugin-out-http-buffered]
+
+This is an output plugin for (Fluentd)[http://fluentd.org/] which deliveres buffered log messages to an http endpoint.
+
+It has configurable (read)[http://ruby-doc.org/stdlib-2.0/libdoc/net/http/rdoc/Net/HTTP.html#method-i-read_timeout-3D] and (open)[http://ruby-doc.org/stdlib-2.0/libdoc/net/http/rdoc/Net/HTTP.html#open_timeout] timeouts.
+
+Clients can also configure which http response statuses should be retried (in most cases clients would want to retry on status 500).
+
+All messages are sent through POST in json format.
+
+The plugin was influenced by the standard (http output plugin)[https://github.com/ento/fluent-plugin-out-http].
+
+== Installation:
+
+`gem install fluent-out-http-buffered`
+
+== Usage:
+
+    # Configuration file fluent.conf
+    <match fluentd.test.*>
+      type http_buffered
+      flush_interval 2s
+      #Endpoint for messages
+      endpoint_url    http://localhost/fluent.php
+      #Comma separated list of http statuses which need to be retried
+      http_retry_statuses 500, 403
+      #Read timeout in seconds, supports floats
+      http_read_timeout 2.2
+      #Open timeout in seconds, supports floats
+      http_open_timeout 2.34
+    </match>
+
+== Copyright
+
+Copyright (c) 2013 ablagoev. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+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/VERSION

@@ -0,0 +1 @@
+0.0.1

data/fluent-plugin-out-http-buffered.gemspec

@@ -0,0 +1,39 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'fluent-plugin-out-http-buffered'
+  s.version     = File.read("VERSION").strip
+  s.date        = '2013-05-13'
+  s.summary     = "Fluentd http buffered output plugin"
+  s.description = "Send fluent buffered logs to an http endpoint"
+  s.authors     = ["Alexander Blagoev"]
+  s.email       = 'alexander.i.blagoev@gmail.com'
+  s.homepage    =
+    'http://github.com/ablagoev/fluent-plugin-out-http-buffered'
+
+  s.files       = [
+    "lib/fluent/plugin/out_http_buffered.rb",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fluent-plugin-out-http-buffered.gemspec",
+    "test/helper.rb",
+    "test/fluent/plugin/test_out_http_buffered.rb",
+  ]
+
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.licenses = ["MIT"]
+
+  s.require_paths = ['lib']
+
+  s.add_dependency "fluentd", "~> 0.10.0"
+  s.add_development_dependency "rake", ">= 0.9.2"
+  s.add_development_dependency "rspec-mocks", ">= 2.13.0"
+  s.add_development_dependency "bundler", ">= 1.3.4"
+end

data/lib/fluent/plugin/out_http_buffered.rb

@@ -0,0 +1,109 @@
+# encoding: utf-8
+
+module Fluent
+  # Main Output plugin class
+  class HttpBufferedOutput < Fluent::BufferedOutput
+    Fluent::Plugin.register_output('http_buffered', self)
+
+    def initialize
+      super
+      require 'net/http'
+      require 'uri'
+    end
+
+    # Endpoint URL ex. localhost.local/api/
+    config_param :endpoint_url, :string
+
+    # statuses under which to retry
+    config_param :http_retry_statuses, :string, default: ''
+
+    # read timeout for the http call
+    config_param :http_read_timeout, :float, default: 2.0
+
+    # open timeout for the http call
+    config_param :http_open_timeout, :float, default: 2.0
+
+    def configure(conf)
+      super
+
+      # Check if endpoint URL is valid
+      unless @endpoint_url =~ /^#{URI.regexp}$/
+        fail Fluent::ConfigError, 'endpoint_url invalid'
+      end
+
+      begin
+        @uri = URI.parse(@endpoint_url)
+      rescue URI::InvalidURIError
+        raise Fluent::ConfigError, 'endpoint_url invalid'
+      end
+
+      # Parse http statuses
+      @statuses = @http_retry_statuses.split(',').map { |status| status.to_i }
+
+      @statuses = [] if @statuses.nil?
+
+      @http = Net::HTTP.new(@uri.host, @uri.port)
+      @http.read_timeout = @http_read_timeout
+      @http.open_timeout = @http_open_timeout
+    end
+
+    def start
+      super
+    end
+
+    def shutdown
+      super
+      begin
+        @http.finish
+      rescue
+      end
+    end
+
+    def format(tag, time, record)
+      [tag, time, record].to_msgpack
+    end
+
+    def write(chunk)
+      data = []
+      chunk.msgpack_each do |(tag, time, record)|
+        data << [tag, time, record]
+      end
+
+      request = create_request(data)
+
+      begin
+        response = @http.start do |http|
+          request = create_request(data)
+          http.request request
+        end
+
+        if @statuses.include? response.code.to_i
+          # Raise an exception so that fluent retries
+          fail "Server returned bad status: #{response.code}"
+        end
+      rescue IOError, EOFError, SystemCallError => e
+        # server didn't respond
+        $log.warn "Net::HTTP.#{request.method.capitalize} raises exception: #{e.class}, '#{e.message}'"
+      ensure
+        begin
+          @http.finish
+        rescue
+        end
+      end
+    end
+
+    protected
+
+      def create_request(data)
+        request = Net::HTTP::Post.new(@uri.request_uri)
+
+        # Headers
+        request['Content-Type'] = 'application/json'
+
+        # Body
+        request.body = JSON.dump(data)
+
+        request
+      end
+  end
+end

data/test/fluent/plugin/test_out_http_buffered.rb

@@ -0,0 +1,97 @@
+# encoding: utf-8
+
+require 'helper'
+require 'yaml'
+
+# Test case for the output plugin
+class HttpBufferedOutputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    endpoint_url  http://local.endpoint
+  ]
+
+  # Used to test invalid method config
+  CONFIG_METHOD = %[
+    endpoint_url local.endpoint
+    http_method  invalid_method
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::BufferedOutputTestDriver.new(Fluent::HttpBufferedOutput).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 'http://local.endpoint', d.instance.instance_eval { @endpoint_url }
+    assert_equal '', d.instance.instance_eval { @http_retry_statuses }
+    assert_equal [], d.instance.instance_eval { @statuses }
+    assert_equal 2.0, d.instance.instance_eval { @http_read_timeout }
+    assert_equal 2.0, d.instance.instance_eval { @http_open_timeout }
+  end
+
+  def test_invalid_endpoint
+    assert_raise Fluent::ConfigError do
+      create_driver('endpoint_url \\@3')
+    end
+
+    assert_raise Fluent::ConfigError do
+      create_driver('endpoint_url google.com')
+    end
+  end
+
+  def test_write_status_retry
+    setup_rspec(self)
+
+    d = create_driver(%[
+        endpoint_url http://local.endpoint
+        http_retry_statuses 500
+      ])
+
+    d.emit('abc')
+
+    http = double()
+    http.stub(:finish)
+    http.stub(:start).and_yield(http)
+    http.stub(:request) do
+      response = OpenStruct.new
+      response.code = '500'
+      response
+    end
+
+    d.instance.instance_eval { @http = http }
+
+    assert_raise RuntimeError do
+      d.run
+    end
+
+    verify_rspec
+    teardown_rspec
+  end
+
+  def test_write
+    setup_rspec(self)
+
+    d = create_driver('endpoint_url http://www.google.com/')
+
+    d.emit('message')
+    http = double('Net::HTTP')
+    http.stub(:finish)
+    http.stub(:start).and_yield(http)
+    http.stub(:request) do |request|
+      assert(request.body =~ /message/)
+      response = OpenStruct.new
+      response.code = '200'
+      response
+    end
+
+    d.instance.instance_eval { @http = http }
+
+    d.run
+
+    verify_rspec
+    teardown_rspec
+  end
+end

data/test/helper.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+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'
+require 'rspec/mocks'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fluent/test'
+require 'fluent/plugin/out_http_buffered'
+
+# TestCase base class
+class Test::Unit::TestCase
+  def setup_rspec(test_case)
+    RSpec::Mocks.setup(test_case)
+  end
+
+  def verify_rspec
+    RSpec::Mocks.verify
+  end
+
+  def teardown_rspec
+    RSpec::Mocks.teardown
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-out-http-buffered
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Blagoev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fluentd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.4
+description: Send fluent buffered logs to an http endpoint
+email: alexander.i.blagoev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/fluent/plugin/out_http_buffered.rb
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fluent-plugin-out-http-buffered.gemspec
+- test/helper.rb
+- test/fluent/plugin/test_out_http_buffered.rb
+homepage: http://github.com/ablagoev/fluent-plugin-out-http-buffered
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Fluentd http buffered output plugin
+test_files: []