fluent-plugin-gelf-in.fitterpen 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: faceebe56b6a7b9c2a9ae244996951c231b2bccb697f78baa5f42b7e8e4260fe
+  data.tar.gz: 76a616407ef3eb603ee03198daeb9b39b2e985e292ede376bf545ba7f47c6942
+SHA512:
+  metadata.gz: 7f30e3f2da86c021b310d93f0cfb89366f3798cac96bc19b23b9c4671ba25f1f9bc2d4a0720273482bb3b6427f7f1ac0934627233ff7c3bba91faddbe5413bd0
+  data.tar.gz: ac45ef618fa86a78a4e0a9783ec3a13c09d93704d9ffbcdba6808ff8d44d3e6f3de465aeaf9b8f026538e3f37824f090dc7c2c4387e255a52c83269bb5aba7ed

data/.travis.yml

@@ -0,0 +1,33 @@
+language: ruby
+
+rvm:
+- 2.1
+- 2.2
+- 2.3
+- 2.4
+- 2.5
+
+gemfile:
+- Gemfile
+
+branches:
+  only:
+  - master
+  # Tagged commits
+  - /^v\d+\.\d+(\.\d+)?(-\S*)?$/
+
+script: bundle exec rake test
+
+jobs:
+  include:
+  - stage: gem release
+    rvm: 2.3
+    script: echo "Deploying to rubygems.org ..."
+    deploy:
+      provider: rubygems
+      api_key:
+        secure: R06ICCYHjZ+bk+CocD+eZROiTsfDnmUlugdSIqND0f9Z+Vi8ALOZmIEhlpBvloRaOLU0pz3d9juj74vHMJ1boJN6Qgn+CtAGSDzesxm6vcd/AP87mEzAaJvvHRme7bNLy7gt1RvrmVzDjyOe2fF8kcVAz19bEArJ1rqBXeLiLY+fOPenCsWRNrOt2+yOH5qRgdFs+n2NQ6oQrDEq18uZJVQ74WnSyKGylIhPfXj+TcgMrDGJtxqWYmL+DeuzOVk73REMHiw+9ljvhjVIdMxiU/oXge9y7Ua7q6OlkJgmChaWrs06bHiwhJHz6yh+OXebVFbxHTsPdsw4w+Uv9/MB961zgR58yLVi6AJr5xosM8l92S/OJeG9paO43xuQGeX+mch7m/827VbeM8aLtRGXjNILC3BW+l9O++Yg0eF6YC4c6NobNOX4ZpfGNopDsoyYI19Yj9SoKvoqw3WtAZsX2T5CrAdG1PHLKNDwyCbuiYjlNKAAHy5ZCB7X63JrDAKgwUQSnYEPEGNVzisnNfyqVxQnvTDZLwgzWcYxTBCjXoO09+qsbB9lpgecT45UI80VgW70nokEzilmyXARG+eBGKhz2iJli+mrdZbpfzws/PD/Hr5dubgn8mNX5/e6DRMoTr9xQOGrvdXhET+ygiTEWg1VMzfcZ2WpeJTveV9h2BQ=
+      gem: fluent-plugin-input-gelf
+      on:
+        tags: true
+        repo: MerlinDMC/fluent-plugin-input-gelf

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,37 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-gelf-in.fitterpen"
+  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.3.2"
+  gem.authors     = ["Daniel Malon"]
+  gem.email       = "daniel.malon@me.com"
+  gem.has_rdoc    = false
+  gem.files = [
+    ".travis.yml",
+    "fluent-plugin-input-gelf.gemspec",
+    "Gemfile",
+    "LICENSE",
+    "Rakefile",
+    "README.md",
+    "lib/fluent/plugin/in_gelf.rb",
+    "test/plugin/test_in_gelf.rb",
+    "test/test_helper.rb"
+  ]
+  #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", [">= 0.14.10", "< 2"]
+  gem.add_runtime_dependency "gelfd2", ">= 0.3.0"
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "test-unit"
+  gem.add_development_dependency "gelf.fitterpen", ">= 2.0.0"
+end

data/lib/fluent/plugin/in_gelf.rb

@@ -0,0 +1,116 @@
+# encoding: utf-8
+require 'time'
+
+require 'cool.io'
+require 'yajl'
+
+require 'gelfd2'
+
+require 'fluent/plugin/input'
+
+module Fluent::Plugin
+  class GelfInput < Fluent::Plugin::Input
+    Fluent::Plugin.register_input('gelf', self)
+
+    helpers :server, :parser, :compat_parameters
+
+    DEFAULT_PARSER = 'json'.freeze
+
+    def initialize
+      super
+    end
+
+    desc "The value is the tag assigned to the generated events."
+    config_param :tag, :string
+    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, :enum, list: [:udp, :tcp], default: :udp
+    desc 'Strip leading underscore'
+    config_param :strip_leading_underscore, :bool, default: true
+
+    config_section :parse do
+      config_set_default :@type, DEFAULT_PARSER
+    end
+
+    def configure(conf)
+      compat_parameters_convert(conf, :parser)
+      super
+
+      @parser = parser_create
+    end
+
+    def start
+      super
+
+      listen
+    end
+
+    def shutdown
+      super
+    end
+
+    def receive_data(data, addr)
+      begin
+        msg = Gelfd2::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_f if record.key?('timestamp')
+
+        # Postprocess recorded event
+        strip_leading_underscore_(record) if @strip_leading_underscore
+
+        emit(time, record)
+      }
+    rescue => e
+      log.error data.dump, error: e.to_s
+      log.error_backtrace
+    end
+
+    def listen
+      log.info "listening gelf socket on #{@bind}:#{@port} with #{@protocol_type}"
+      if @protocol_type == :tcp
+        server_create(:in_tcp_server, @port, bind: @bind) do |data, conn|
+          receive_data(data, conn)
+        end
+      else
+        # Graylog is ready to accept 8192 bytes of GELF, but with
+        # chunking we need to accept at least 12 bytes of chunk header
+        # as well. But we don't need to pin us down to that either.
+        server_create(:in_udp_server, @port, proto: :udp, bind: @bind, max_bytes: 65536) do |data, sock|
+          receive_data(data, sock)
+        end
+      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
+
+    private
+
+    def strip_leading_underscore_(record)
+      record.keys.each { |k|
+        next unless k[0,1] == '_'
+        record[k[1..-1]] = record.delete(k)
+      }
+    end
+  end
+end

data/test/plugin/test_in_gelf.rb

@@ -0,0 +1,116 @@
+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::Driver::Input.new(Fluent::Plugin::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.parser_configs.first["@type"]
+    }
+  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(expect_emits: 2)  do
+        n = GELF::Notifier.new(k, PORT)
+
+        tests.each { |test|
+          n.notify!(test)
+        }
+      end
+
+      emits = d.events
+      assert_equal tests.length, emits.length, 'missing emitted events'
+      emits.each_index { |i|
+        assert_equal 'gelf', emits[i][0]
+        assert_equal tests[i][:timestamp].to_f, 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
+
+  def test_strip_leading_underscore
+    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 = [
+        {:given =>
+         {
+           :timestamp => 12345,
+           :short_message => 'short message',
+           :full_message => 'full message',
+           '_custom_field' => 12345
+         },
+         :expected =>
+         {
+           'short_message' => 'short message',
+           'full_message' => 'full message',
+           'custom_field' => 12345
+         }
+        }
+      ]
+
+      d.run(expect_emits: 1) do
+        n = GELF::Notifier.new(k, PORT)
+
+        tests.each { |test|
+          n.notify!(test[:given])
+        }
+      end
+
+      emits = d.events
+      assert_equal tests.length, emits.length, 'missing emitted events'
+      emits.each_index { |i|
+        assert_equal 'gelf', emits[i][0]
+        assert_equal tests[i][:timestamp].to_f, emits[i][1] unless tests[i][:timestamp].nil?
+        assert_block "expectation not met: #{tests[i][:expected]}" do
+          emits[i][2].merge(tests[i][:expected]) == emits[i][2]
+        end
+      }
+    }
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+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/driver/input'
+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,141 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-gelf-in.fitterpen
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Daniel Malon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-12-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.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.10
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: gelfd2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.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.fitterpen
+  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:
+- ".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: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: A GELF input plugin for fluentd
+test_files: []