fluent-plugin-in-udp-event 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDNkZjg0ZmIyMGZiYzRkMzA3MzlhZjg2YjQ0ZjkwNThhMWU3YTIwMw==
+  data.tar.gz: !binary |-
+    NmJmNjNkNGZlMWRlYmQ4OTljNzBmMDUzZWM5ZDk4YWUzZWIyNDUwZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NTQ4ODQ3OTFjNGJlYWI5ZDc2NDZlNjI1ZTgzNDAzMmZhMDViNjU2MTE0ODEy
+    MDUwY2QwZjdkNDg1ZmFjODViYzBjMmI4MWQzNTI3YzU4ZDUxZjNhZWY2ZTRh
+    Y2VmNDVlYWQ5ODcwZDEyYTE1MWI3NTU3MGY3NjZhY2VmOWU4OWY=
+  data.tar.gz: !binary |-
+    YjM2ZGY3NDEyZWM4OGM4M2ZmNTc1NjViMDE5MTU2M2Y2ZWYzNDMyYzk2NDgz
+    OWExMDFhOGI0ZmZmNGU4ZGY0YjZjZDBkYzkxOTZiOWU1YWYxMGFjOTVhMWI2
+    ZmYwOTliNDZjOWM5ZTdjZjE4ZDA4NzEzZTEwZjMwZjVlYWM5NTA=

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://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,31 @@
+= fluent-plugin-in-udp-event {<img src="https://travis-ci.org/ablagoev/fluent-plugin-in-udp-event.png?branch=master" />}[https://travis-ci.org/ablagoev/fluent-plugin-in-udp-event]
+
+An event driven Fluentd[http://fluentd.org/] input plugin for sending logs through UDP. The plugin uses Cool.io[http://coolio.github.io/] similarly to other parts in Fluentd.
+
+The incoming max message size can be configured through the max_message_size config option. It is 1024 bytes by default, any messages larger than this will be ignored.
+
+Messages should be in JSON format, following fluentd's common message structure:
+
+	[tag, timestamp, data]
+
+== Installations:
+
+`gem install fluent-in-udp-event`
+
+== Usage:
+
+	# Configuration file fluent.conf
+    <source>
+      type udp_event
+      port 24224
+      bind 0.0.0.0
+      max_message_size 2048
+    </source>
+
+
+The plugin was heavily influenced by the in_syslog[https://github.com/fluent/fluentd/blob/master/lib/fluent/plugin/in_syslog.rb] plugin in fluentd.
+
+== Copyright
+
+Copyright (c) 2013 ablagoev. See LICENSE.txt for
+further details.

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = (Dir["test/*.rb"] + Dir["test/fluent/plugin/*.rb"] - ["helper.rb"]).sort
+  t.verbose = true
+  #t.warning = true
+end
+
+task :default => [:test]

data/VERSION

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

data/fluent-plugin-in-udp-event.gemspec

@@ -0,0 +1,42 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "fluent-plugin-in-udp-event"
+  gem.version       = File.read("VERSION").strip
+  gem.authors       = ["Alexander Blagoev"]
+  gem.email         = ["alexander.i.blagoev@gmail.com"]
+  gem.summary       = %q{Event driven udp input plugin for fluentd}
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/ablagoev/fluent-plugin-in-udp-event"
+  gem.date          = '2013-10-20'
+
+  gem.files         = [
+    "lib/fluent/plugin/in_udp_event.rb",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "fluent-plugin-in-udp-event.gemspec",
+    "test/helper.rb",
+    "test/fluent/plugin/test_in_udp_event.rb"
+  ]
+
+  gem.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+
+  gem.licenses = ["MIT"]
+
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rake"
+
+  gem.add_runtime_dependency(%q<cool.io>, ["~> 1.1.1"])
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "json"
+end

data/lib/fluent/plugin/in_udp_event.rb

@@ -0,0 +1,124 @@
+# -*- encoding: utf-8 -*-
+
+#
+# Fluent Input Plugin UDP Event
+#
+# Copyright (C) 2013 Alexander Blagoev
+
+module Fluent
+  # Fluentd UDP input main class
+  class UdpEventInput < Input
+    MAX_BLOCKTIME = 2
+
+    Plugin.register_input('udp_event', self)
+
+    def initialize
+      super
+      require 'fluent/plugin/socket_util'
+    end
+
+    config_param :port, :integer, default: 242_24
+    config_param :bind, :string, default: '0.0.0.0'
+    config_param :max_message_size, :integer, default: 1024
+
+    def configure(conf)
+      super
+    end
+
+    def start
+      callback = method(:receive_data)
+
+      @loop = Coolio::Loop.new backend: :epoll
+
+      $log.debug "listening udp socket on #{@bind}:#{@port}"
+      @usock = SocketUtil.create_udp_socket(@bind)
+      @usock.bind(@bind, @port)
+
+      @handler = UdpHandler.new(@usock, @max_message_size, callback)
+      @loop.attach(@handler)
+
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      # Force event every MAX_BLOCKTIME seconds to prevent 60 second timeout
+      # see ext/libev/ev.c MAX_BLOCKTIME
+      @watcher = Cool.io::TimerWatcher.new(MAX_BLOCKTIME, true)
+      @loop.attach(@watcher)
+
+      $log.debug 'stopping event loop'
+      begin
+        @loop.stop
+      rescue RuntimeError
+      end
+
+      $log.debug "closing udp socket on #{@bind}:#{@port}"
+      @handler.close
+
+      $log.debug 'closing watchers'
+      @loop.watchers.each { |w| w.detach }
+
+      $log.debug 'waiting for thread to finish'
+      @thread.join
+      $log.debug 'thread finished'
+      $log.debug 'terminating'
+    end
+
+    def run
+      @loop.run
+    rescue Exception => e
+      $log.error 'unexpected error', error: e.message
+      $log.error_backtrace
+    end
+
+    protected
+
+    def receive_data(data)
+      if data.bytesize == @max_message_size
+        $log.warn "message might be too big and truncated to #{@max_message_size}"
+      end
+
+      begin
+        parsed = JSON.parse(data)
+      rescue JSON::ParserError => e
+        $log.warn 'invalid json data', error: e.message
+        return
+      end
+
+      tag = parsed[0]
+      time = parsed[1].to_i
+      record = parsed[2]
+
+      if tag.nil? || time.nil? || record.nil?
+        $log.warn "invalid message supplied #{data}"
+        return
+      end
+
+      time ||= Engine.now
+
+      Engine.emit(tag, time, record)
+    rescue Exception => e
+      $log.warn data.dump, error: e.message
+      $log.debug_backtrace
+    end
+
+    private
+
+    # Class to handle the UDP layer
+    class UdpHandler < Coolio::IO
+      def initialize(io, max_message_size, callback)
+        super(io)
+        @io = io
+        @callback = callback
+        @max_message_size = max_message_size
+      end
+
+      def on_readable
+        msg, _ = @io.recvfrom_nonblock(@max_message_size)
+        @callback.call(msg)
+      rescue Exception => e
+        $log.error e.message, error: e.message
+      end
+    end
+  end
+end

data/test/fluent/plugin/test_in_udp_event.rb

@@ -0,0 +1,129 @@
+# -*- encoding: utf-8 -*-
+
+require 'helper'
+
+# Test case for the input plugin
+class UdpEventInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+    require 'fluent/plugin/socket_util'
+  end
+
+  PORT = unused_port
+  CONFIG = %[
+    port #{PORT}
+    bind 127.0.0.1
+  ]
+
+  IPV6_CONFIG = %[
+    port #{PORT}
+    bind ::1
+  ]
+
+  def create_driver(conf = CONFIG)
+    Fluent::Test::InputTestDriver.new(Fluent::UdpEventInput).configure(conf)
+  end
+
+  def test_configure
+    configs = { '127.0.0.1' => CONFIG }
+    configs.merge!('::1' => IPV6_CONFIG) if ipv6_enabled?
+
+    configs.each_pair do |k, v|
+      d = create_driver(v)
+      assert_equal PORT, d.instance.port
+      assert_equal k, d.instance.bind
+    end
+  end
+
+  def test_receive_data
+    d = create_driver
+
+    tests = [
+      ['test.route', Time.now.to_i, { 'data' => 'test1' }],
+      ['test.route', Time.now.to_i, { 'data' => 'test2' }],
+      ['test.route', Time.now.to_i, { 'data' => 'test3' }]
+    ]
+
+    d.run do
+      @loop = d.instance.instance_variable_get(:@loop)
+
+      # Force event every 0.1 to prevent 60 second timeout
+      # see ext/libev/ev.c MAX_BLOCKTIME
+      @watcher = Cool.io::TimerWatcher.new(0.1, true)
+      @loop.attach(@watcher)
+
+      u = UDPSocket.new
+      u.connect('127.0.0.1', PORT)
+      tests.each do |message|
+        u.send(JSON.generate(message), 0)
+      end
+
+      sleep 0.2
+    end
+
+    assert_equal d.emits, tests
+  end
+
+  def test_invalid_message
+    d = create_driver
+
+    d.run do
+      @loop = d.instance.instance_variable_get(:@loop)
+
+      # Force event every 0.1 to prevent 60 second timeout
+      # see ext/libev/ev.c MAX_BLOCKTIME
+      @watcher = Cool.io::TimerWatcher.new(0.1, true)
+      @loop.attach(@watcher)
+
+      u = UDPSocket.new
+      u.connect('127.0.0.1', PORT)
+      u.send('invalid_json', 0)
+
+      sleep 0.2
+    end
+
+    assert_equal d.emits.length, 0
+  end
+
+  def test_invalid_structure
+    d = create_driver
+
+    d.run do
+      @loop = d.instance.instance_variable_get(:@loop)
+
+      # Force event every 0.1 to prevent 60 second timeout
+      # see ext/libev/ev.c MAX_BLOCKTIME
+      @watcher = Cool.io::TimerWatcher.new(0.1, true)
+      @loop.attach(@watcher)
+
+      u = UDPSocket.new
+      u.connect('127.0.0.1', PORT)
+      u.send(JSON.generate([]), 0)
+
+      sleep 0.2
+    end
+
+    assert_equal d.emits.length, 0
+  end
+
+  def test_enormous_message
+    d = create_driver
+
+    d.run do
+      @loop = d.instance.instance_variable_get(:@loop)
+
+      # Force event every 0.1s to prevent 60 second timeout
+      # see ext/libev/ev.c MAX_BLOCKTIME
+      @watcher = Cool.io::TimerWatcher.new(0.1, true)
+      @loop.attach(@watcher)
+
+      u = UDPSocket.new
+      u.connect('127.0.0.1', PORT)
+      u.send(JSON.generate(['test', Time.now.to_i, 'x' * 1500]), 0)
+
+      sleep 0.2
+    end
+
+    assert_equal d.emits.length, 0
+  end
+end

data/test/helper.rb

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+require 'test/unit'
+require 'fluent/test'
+require 'fluent/plugin/in_udp_event'
+
+unless defined?(Test::Unit::AssertionFailedError)
+  class Test::Unit::AssertionFailedError < StandardError
+  end
+end
+
+def unused_port
+  s = TCPServer.open(0)
+  port = s.addr[1]
+  s.close
+  port
+end
+
+def ipv6_enabled?
+  require 'socket'
+
+  begin
+    TCPServer.open('::1', 0)
+    true
+  rescue
+    false
+  end
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-in-udp-event
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Blagoev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-20 00:00:00.000000000 Z
+dependencies:
+- !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: cool.io
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !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: json
+  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'
+description: Event driven udp input plugin for fluentd
+email:
+- alexander.i.blagoev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- lib/fluent/plugin/in_udp_event.rb
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- fluent-plugin-in-udp-event.gemspec
+- test/helper.rb
+- test/fluent/plugin/test_in_udp_event.rb
+homepage: https://github.com/ablagoev/fluent-plugin-in-udp-event
+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: Event driven udp input plugin for fluentd
+test_files:
+- test/helper.rb
+- test/fluent/plugin/test_in_udp_event.rb