fluent-plugin-input-gelf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b72e348033187ca8353e8f0f458586e757f7ae49
+  data.tar.gz: b481677ab24fed18c12e90b0e0e01fb41a4f105a
+SHA512:
+  metadata.gz: c0e9646e2608c25e9a6f2f3a198f27eb5b44034d5df2c388034f8c68ed5350f54e20d49a77d34d31418a9e81a156dc395b2129668f749fbff4b1f0474e59bf0c
+  data.tar.gz: 23524913869c9d57d8f1ea03f48fd0edfd5cb3828863513f4319b4150b22ff707ad16e1fa1ef21f494c010848bd03e0b3c7e8ca36d5d9c171a6a0b8add1efc18

data/.gitignore

@@ -0,0 +1,11 @@
+~*
+#*
+*~
+[._]*.s[a-w][a-z]
+.DS_Store
+
+*.gem
+.bundle
+Gemfile.lock
+vendor
+.ruby-version

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2.2
+  - 2.3.0
+
+gemfile:
+  - Gemfile
+
+branches:
+  only:
+    - master
+
+script: bundle exec rake test

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 Daniel Malon
+
+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,25 @@
+# fluent-plugin-input-gelf
+
+[![Build Status](https://travis-ci.org/MerlinDMC/fluent-plugin-input-gelf.svg?branch=master)](https://travis-ci.org/MerlinDMC/fluent-plugin-input-gelf)
+[![Gem Version](https://badge.fury.io/rb/fluent-plugin-input-gelf.svg)](http://badge.fury.io/rb/fluent-plugin-input-gelf)
+
+## Overview
+
+A GELF compatible input for [Fluentd](http://www.fluentd.org/).
+
+### Configuration
+
+Accept GELF encoded messages over UDP
+
+```
+<source>
+  type gelf
+  tag example.gelf
+  bind 127.0.0.1
+  port 12201
+</source>
+
+<match example.gelf>
+  type stdout
+</match>
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.test_files = FileList['test/plugin/test_*.rb']
+  test.verbose = true
+end
+
+task :default => [:build]

data/fluent-plugin-input-gelf.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-input-gelf"
+  gem.description = "A GELF input plugin for fluentd"
+  gem.license     = "MIT"
+  gem.homepage    = "https://github.com/MerlinDMC/fluent-plugin-input-gelf"
+  gem.summary     = gem.description
+  gem.version     = "0.1.0"
+  gem.authors     = ["Daniel Malon"]
+  gem.email       = "daniel.malon@me.com"
+  gem.has_rdoc    = false
+  gem.files       = `git ls-files`.split("\n")
+  gem.test_files  = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency "fluentd"
+  gem.add_runtime_dependency "gelfd", ">= 0.2.0"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "gelf", ">= 2.0.0"
+end

data/lib/fluent/plugin/in_gelf.rb

@@ -0,0 +1,113 @@
+# encoding: utf-8
+require 'time'
+
+require 'cool.io'
+require 'yajl'
+
+require 'fluent/input'
+
+module Fluent
+  class GelfInput < Fluent::Input
+    Fluent::Plugin.register_input('gelf', self)
+
+    def initialize
+      super
+      require 'fluent/plugin/socket_util'
+      require 'gelfd'
+    end
+
+    desc "The value is the tag assigned to the generated events."
+    config_param :tag, :string
+    desc 'The format of the payload.'
+    config_param :format, :string, default: 'json'
+    desc 'The port to listen to.'
+    config_param :port, :integer, default: 12201
+    desc 'The bind address to listen to.'
+    config_param :bind, :string, default: '0.0.0.0'
+    desc 'The transport protocol used to receive logs.(udp, tcp)'
+    config_param :protocol_type, default: :udp do |val|
+      case val.downcase
+      when 'tcp'
+        :tcp
+      when 'udp'
+        :udp
+      else
+        raise ConfigError, "gelf input protocol type should be 'tcp' or 'udp'"
+      end
+    end
+    config_param :blocking_timeout, :time, default: 0.5
+
+    def configure(conf)
+      super
+
+      @parser = Plugin.new_parser(@format)
+      @parser.configure(conf)
+    end
+
+    def start
+      @loop = Coolio::Loop.new
+      @handler = listen(method(:receive_data))
+      @loop.attach(@handler)
+
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      @loop.watchers.each { |w| w.detach }
+      @loop.stop
+      @handler.close
+      @thread.join
+    end
+
+    def run
+      @loop.run(@blocking_timeout)
+    rescue
+      log.error 'unexpected error', error: $!.to_s
+      log.error_backtrace
+    end
+
+    def receive_data(data, addr)
+      begin
+        msg = Gelfd::Parser.parse(data)
+      rescue => e
+        log.warn 'Gelfd failed to parse a message', error: e.to_s
+        log.warn_backtrace
+      end
+
+      # Gelfd parser will return nil if it received and parsed a non-final chunk
+      return if msg.nil?
+
+      @parser.parse(msg) { |time, record|
+        unless time && record
+          log.warn "pattern not match: #{msg.inspect}"
+          return
+        end
+
+        # Use the recorded event time if available
+        time = record.delete('timestamp').to_i if record.key?('timestamp')
+
+        emit(time, record)
+      }
+    rescue => e
+      log.error data.dump, error: e.to_s
+      log.error_backtrace
+    end
+
+    def listen(callback)
+      log.info "listening gelf socket on #{@bind}:#{@port} with #{@protocol_type}"
+      if @protocol_type == :tcp
+        Coolio::TCPServer.new(@bind, @port, SocketUtil::TcpHandler, log, "\n", callback)
+      else
+        @usock = SocketUtil.create_udp_socket(@bind)
+        @usock.bind(@bind, @port)
+        SocketUtil::UdpHandler.new(@usock, log, 8192, callback)
+      end
+    end
+
+    def emit(time, record)
+      router.emit(@tag, time, record)
+    rescue => e
+      log.error 'gelf failed to emit', error: e.to_s, error_class: e.class.to_s, tag: @tag, record: Yajl.dump(record)
+    end
+  end
+end

data/test/plugin/test_in_gelf.rb

@@ -0,0 +1,72 @@
+require_relative '../test_helper'
+require 'gelf'
+
+class GelfInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  PORT = 12345
+  BASE_CONFIG = %[
+    port #{PORT}
+    protocol_type udp
+    tag gelf
+  ]
+  CONFIG = BASE_CONFIG + %!
+    bind 127.0.0.1
+  !
+  IPv6_CONFIG = BASE_CONFIG + %!
+    bind ::1
+  !
+
+  def create_driver(conf)
+    Fluent::Test::InputTestDriver.new(Fluent::GelfInput).configure(conf)
+  end
+
+  def test_configure
+    configs = {'127.0.0.1' => CONFIG}
+    configs.merge!('::1' => IPv6_CONFIG) if ipv6_enabled?
+
+    configs.each_pair { |k, v|
+      d = create_driver(v)
+      assert_equal PORT, d.instance.port
+      assert_equal k, d.instance.bind
+      assert_equal 'json', d.instance.format
+    }
+  end
+
+  def test_parse
+    configs = {'127.0.0.1' => CONFIG}
+    # gelf-rb currently does not support IPv6 over UDP
+    # configs.merge!('::1' => IPv6_CONFIG) if ipv6_enabled?
+
+    configs.each_pair { |k, v|
+      d = create_driver(v)
+
+      tests = [
+        {:short_message => 'short message', :full_message => 'full message'},
+        {:short_message => 'short message', :full_message => 'full message', :timestamp => 12345678.12345}
+      ]
+
+      d.run do
+        n = GELF::Notifier.new(k, PORT)
+
+        tests.each { |test|
+          n.notify!(test)
+        }
+
+        sleep 1
+      end
+
+      emits = d.emits
+      assert_equal tests.length, emits.length, 'missing emitted events'
+      emits.each_index { |i|
+        puts emits[i].to_s
+        assert_equal 'gelf', emits[i][0]
+        assert_equal tests[i][:timestamp].to_i, emits[i][1] unless tests[i][:timestamp].nil?
+        assert_equal tests[i][:short_message], emits[i][2]['short_message']
+        assert_equal tests[i][:full_message], emits[i][2]['full_message']
+      }
+    }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,47 @@
+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'
+unless ENV.has_key?('VERBOSE')
+  nulllogger = Object.new
+  nulllogger.instance_eval {|obj|
+    def method_missing(method, *args)
+      # pass
+    end
+  }
+  $log = nulllogger
+end
+
+require 'fluent/plugin/in_gelf'
+
+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
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-input-gelf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Malon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-27 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: gelfd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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: gelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: A GELF input plugin for fluentd
+email: daniel.malon@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- fluent-plugin-input-gelf.gemspec
+- lib/fluent/plugin/in_gelf.rb
+- test/plugin/test_in_gelf.rb
+- test/test_helper.rb
+homepage: https://github.com/MerlinDMC/fluent-plugin-input-gelf
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A GELF input plugin for fluentd
+test_files:
+- test/plugin/test_in_gelf.rb
+- test/test_helper.rb