fluent-plugin-beats 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22b370cd6030f188fc607586558a34341419735b
+  data.tar.gz: c1c732fbb50f60bcc503d413a0cc40a9e5a3df08
+SHA512:
+  metadata.gz: 2f103a1cecb9002a90978920cef9ee907e0f857cabcfe7e5abc305a7b6174a6520e834333cc13cc00b38a9026bfb52497d94f44bfcd908ae38eed0a03d8b2e3a
+  data.tar.gz: d872ee9de6e8b2dc1eb7c6b538664357dbf5c7db5113b3782b7a8ca33bdfc817991de0d068620d2238ac4f6bc647f9b75815b93d678d82e0b10531e72f9d5c82

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+

data/README.md

@@ -0,0 +1,61 @@
+# fluent-plugin-beats
+
+[Fluentd](http://fluentd.org) plugin to accept events from [Elastic Beats](https://www.elastic.co/products/beats).
+
+This plugin uses lumberjack protocol for communicating with each beat.
+
+## Installation
+
+    $ gem install fluent-plugin-beats
+
+## Configuration
+
+Configuration example:
+
+    <source>
+      @type beats
+      metadata_as_tag
+    </source>
+
+    # Forward all events from beats to each index on elasticsearch
+    <match *beat>
+      @type elasticsearch_dynamic
+      logstash_format true
+      logstash_prefix ${tag_parts[0]}
+      type_name ${record['type']}
+    </match>
+
+**port**
+
+  The port to listen to. Default Value is `5044`.
+
+**bind**
+
+  The bind address to listen to. Default Value is 0.0.0.0 (all addresses)
+
+**tag**
+
+  The tag of the event.
+
+**metadata_as_tag**
+
+  Use `record['@metadata']['beat']` value instead of fixed tag. Available values are `filebeat`, `packetbeat` and `topbeat`.
+
+**format**
+
+  The format of the log. This format is used for `message` field of `filebeat` event. See Parser article for more detail: http://docs.fluentd.org/articles/parser-plugin-overview
+
+**max_connections**
+
+  Limit the number of connections from beat instances. Default is unlimited.
+
+**use_ssl**, **ssl_certificate**, **ssl_key**, **ssl_key_passphrase**
+
+  For lumberjack protocol.
+
+## Note
+
+* `lumberjack` directory is copied from `logstash-input-beats` and bit modified.
+  * Add `Server::Connection#closed?` to check connection is dead or not
+  * Remove `id_stream` argument from `Server::Connection#run` block
+* From lumberjack limitation, this plugin launches one thread for each connection. You can mitigate this problem by `max_connections`.

data/Rakefile

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

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/fluent-plugin-beats.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "fluent-plugin-beats"
+  gem.description = "Elastic beats plugin for Fluentd event collector"
+  gem.license     = "Apache-2.0"
+  gem.homepage    = "https://github.com/repeatedly/fluent-plugin-beats"
+  gem.summary     = gem.description
+  gem.version     = File.read("VERSION").strip
+  gem.authors     = ["Masahiro Nakagawa"]
+  gem.email       = "repeatedly@gmail.com"
+  gem.has_rdoc    = false
+  #gem.platform    = Gem::Platform::RUBY
+  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_dependency "fluentd", [">= 0.10.58", "< 2"]
+  gem.add_dependency "concurrent-ruby", "~> 0.9.2"
+  gem.add_development_dependency "rake", ">= 0.9.2"
+  gem.add_development_dependency "test-unit", ">= 3.0.8"
+  gem.add_development_dependency "test-unit-rr", ">= 1.0.3"
+end

data/lib/fluent/plugin/in_beats.rb

@@ -0,0 +1,116 @@
+#
+# Fluent
+#
+# Copyright (C) 2015 Masahiro Nakagawa
+#
+#    Licensed under the Apache License, Version 2.0 (the "License");
+#    you may not use this file except in compliance with the License.
+#    You may obtain a copy of the License at
+#
+#        http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS,
+#    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#    See the License for the specific language governing permissions and
+#    limitations under the License.
+#
+module Fluent
+  class BeatsInput < Input
+    Plugin.register_input('beats', self)
+
+    def initialize
+      super
+
+      require "lumberjack/beats"
+      require "lumberjack/beats/server"
+      require 'concurrent/executor/cached_thread_pool'
+    end
+
+    config_param :port, :integer, :default => 5044
+    config_param :bind, :string, :default => '0.0.0.0'
+    config_param :tag, :string, :default => nil
+    config_param :metadata_as_tag, :bool, :default => nil
+    config_param :format, :string, :default => nil
+    config_param :max_connections, :integer, :default => nil # CachedThreadPool can't limit the number of threads
+    config_param :use_ssl, :string, :default => false
+    config_param :ssl_certificate, :string, :default => nil
+    config_param :ssl_key, :string, :default => nil
+    config_param :ssl_key_passphrase, :string, :default => nil
+
+    def configure(conf)
+      super
+
+      if !@tag && !@metadata_as_tag
+        raise ConfigError,  "'tag' or 'metadata_as_tag' parameter is required on beats input"
+      end
+
+      @time_parser = TextParser::TimeParser.new('%Y-%m-%dT%H:%M:%S.%N%z')
+      if @format
+        @parser = Plugin.new_parser(@format)
+        @parser.configure(conf)
+      end
+      @connections = []
+    end
+
+    def start
+      @lumberjack = Lumberjack::Beats::Server.new(
+        :address => @bind, :port => @port, :ssl => @use_ssl, :ssl_certificate => @ssl_certificate,
+        :ssl_key => @ssl_key, :ssl_key_passphrase => @ssl_key_passphrase)
+      # Lumberjack::Beats::Server depends on normal accept so we need to launch thread for each connection.
+      # TODO: Re-implement Beats Server with Cool.io for resource control
+      @thread_pool = Concurrent::CachedThreadPool.new(:idletime => 15) # idletime setting is based on logstash beats input
+      @thread = Thread.new(&method(:run))
+    end
+
+    def shutdown
+      @lumberjack.close rescue nil
+      @thread_pool.shutdown
+      @thread.join
+    end
+
+    FILEBEAT_MESSAGE = 'message'
+
+    def run
+      until @lumberjack.closed?
+        conn = @lumberjack.accept
+        next if conn.nil?
+
+        if @max_connections
+          @connections.reject! { |c| c.closed? }
+          if @connections.size >= @max_connections
+            conn.close # close for retry on beats side
+            sleep 1
+            next
+          end          
+          @connections << conn
+        end
+
+        @thread_pool.post {
+          begin
+            conn.run { |map|
+              tag = @metadata_as_tag ? map['@metadata']['beat'] : @tag
+
+              if map.has_key?('message') &&  @format
+                message = map.delete('message')
+                @parser.parse(message) { |time, record|
+                  record['@timestamp'] = map['@timestamp']
+                  map.each { |k, v|
+                    record[k] = v
+                  }
+                  router.emit(tag, time, record)
+                }
+                next
+              end
+
+              router.emit(tag, @time_parser.parse(map['@timestamp']), map)
+            }
+          rescue => e
+            log.error "unexpected error", :error => e.to_s
+            log.error_backtrace
+          end
+        }
+      end
+    end
+  end
+end

data/lib/lumberjack/beats.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+require "json"
+module Lumberjack module Beats
+  SEQUENCE_MAX = (2**32-1).freeze
+
+  @@json = Class.new do
+    def self.load(blob)
+      JSON.parse(blob)
+    end
+    def self.dump(v)
+      v.to_json
+    end
+  end
+
+  def self.json
+    @@json
+  end
+
+  def self.json=(j)
+    @@json = j
+  end
+end; end

data/lib/lumberjack/beats/client.rb

@@ -0,0 +1,219 @@
+# encoding: utf-8
+require "lumberjack/beats"
+require "socket"
+require "thread"
+require "openssl"
+require "zlib"
+
+module Lumberjack module Beats
+  class Client
+    def initialize(opts={})
+      @opts = {
+        :port => 0,
+        :addresses => [],
+        :ssl_certificate => nil,
+        :ssl => true,
+        :json => false,
+      }.merge(opts)
+
+      @opts[:addresses] = [@opts[:addresses]] if @opts[:addresses].class == String
+      raise "Must set a port." if @opts[:port] == 0
+      raise "Must set atleast one address" if @opts[:addresses].empty? == 0
+      raise "Must set a ssl certificate or path" if @opts[:ssl_certificate].nil? && @opts[:ssl]
+
+      @socket = connect
+    end
+
+    private
+    def connect
+      addrs = @opts[:addresses].shuffle
+      begin
+        raise "Could not connect to any hosts" if addrs.empty?
+        opts = @opts
+        opts[:address] = addrs.pop
+        Lumberjack::Beats::Socket.new(opts)
+      rescue *[Errno::ECONNREFUSED,SocketError]
+        retry
+      end
+    end
+
+    public
+    def write(elements, opts={})
+      @socket.write_sync(elements, opts)
+    end
+
+    public
+    def host
+      @socket.host
+    end
+  end
+
+  class Socket
+    # Create a new Lumberjack Socket.
+    #
+    # - options is a hash. Valid options are:
+    #
+    # * :port - the port to listen on
+    # * :address - the host/address to bind to
+    # * :ssl - enable/disable ssl support
+    # * :ssl_certificate - the path to the ssl cert to use.
+    #                      If ssl_certificate is not set, a plain tcp connection
+    #                      will be used.
+    attr_reader :sequence
+    attr_reader :host
+    def initialize(opts={})
+      @sequence = 0
+      @last_ack = 0
+      @opts = {
+        :port => 0,
+        :address => "127.0.0.1",
+        :ssl_certificate => nil,
+        :ssl => true,
+        :json => false,
+      }.merge(opts)
+      @host = @opts[:address]
+
+      connection_start(opts)
+    end
+
+    private
+    def connection_start(opts)
+      tcp_socket = TCPSocket.new(opts[:address], opts[:port])
+      if !opts[:ssl]
+        @socket = tcp_socket
+      else
+        certificate = OpenSSL::X509::Certificate.new(File.read(opts[:ssl_certificate]))
+
+        certificate_store = OpenSSL::X509::Store.new
+        certificate_store.add_cert(certificate)
+
+        ssl_context = OpenSSL::SSL::SSLContext.new
+        ssl_context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        ssl_context.cert_store = certificate_store
+
+        @socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, ssl_context)
+        @socket.connect
+      end
+    end
+
+    private 
+    def inc
+      @sequence = 0 if @sequence + 1 > Lumberjack::Beats::SEQUENCE_MAX
+      @sequence = @sequence + 1
+    end
+
+    private
+    def send_window_size(size)
+      @socket.syswrite(["1", "W", size].pack("AAN"))
+    end
+
+    private
+    def send_payload(payload)
+      # SSLSocket has a limit of 16k per message
+      # execute multiple writes if needed
+      bytes_written = 0
+      while bytes_written < payload.bytesize
+        bytes_written += @socket.syswrite(payload.byteslice(bytes_written..-1))
+      end
+    end
+
+    public
+    def write_sync(elements, opts={})
+      options = {
+        :json => @opts[:json],
+      }.merge(opts)
+
+      elements = [elements] if elements.is_a?(Hash)
+      send_window_size(elements.size)
+
+      encoder = options[:json] ? JsonEncoder : FrameEncoder
+      payload = elements.map { |element| encoder.to_frame(element, inc) }.join
+      compress = compress_payload(payload)
+      send_payload(compress)
+
+      ack(elements.size)
+    end
+
+    private 
+    def compress_payload(payload)
+      compress = Zlib::Deflate.deflate(payload)
+      ["1", "C", compress.bytesize, compress].pack("AANA*")
+    end
+
+    private
+    def ack(size)
+      _, type = read_version_and_type
+      raise "Whoa we shouldn't get this frame: #{type}" if type != "A"
+      @last_ack = read_last_ack
+    end
+
+    private
+    def unacked_sequence_size
+      sequence - (@last_ack + 1)
+    end
+
+    private
+    def read_version_and_type
+      version = @socket.read(1)
+      type    = @socket.read(1)
+      [version, type]
+    end
+
+    private
+    def read_last_ack
+      @socket.read(4).unpack("N").first
+    end
+  end
+
+  module JsonEncoder
+    def self.to_frame(hash, sequence)
+      json = Lumberjack::Beats::json.dump(hash)
+      json_length = json.bytesize
+      pack = "AANNA#{json_length}"
+      frame = ["1", "J", sequence, json_length, json]
+      frame.pack(pack)
+    end
+  end # JsonEncoder
+
+  module FrameEncoder
+    def self.to_frame(hash, sequence)
+      frame = ["1", "D", sequence]
+      pack = "AAN"
+      keys = deep_keys(hash)
+      frame << keys.length
+      pack << "N"
+      keys.each do |k|
+        val = deep_get(hash,k)
+        key_length = k.bytesize
+        val_length = val.bytesize
+        frame << key_length
+        pack << "N"
+        frame << k
+        pack << "A#{key_length}"
+        frame << val_length
+        pack << "N"
+        frame << val
+        pack << "A#{val_length}"
+      end
+      frame.pack(pack)
+    end
+
+    private
+    def self.deep_get(hash, key="")
+      return hash if key.nil?
+      deep_get(
+        hash[key.split('.').first],
+        key[key.split('.').first.length+1..key.length]
+      )
+    end
+    private
+    def self.deep_keys(hash, prefix="")
+      keys = []
+      hash.each do |k,v|
+        keys << "#{prefix}#{k}" if v.class == String
+        keys << deep_keys(hash[k], "#{k}.") if v.class == Hash
+      end
+      keys.flatten
+    end
+  end # module Encoder
+end; end

data/lib/lumberjack/beats/server.rb

@@ -0,0 +1,466 @@
+# encoding: utf-8
+require "lumberjack/beats"
+require "socket"
+require "thread"
+require "openssl"
+require "zlib"
+require "json"
+require "concurrent"
+
+module Lumberjack module Beats
+  class Server
+    SOCKET_TIMEOUT = 1 # seconds
+
+    attr_reader :port
+
+    # Create a new Lumberjack server.
+    #
+    # - options is a hash. Valid options are:
+    #
+    # * :port - the port to listen on
+    # * :address - the host/address to bind to
+    # * :ssl_certificate - the path to the ssl cert to use
+    # * :ssl_key - the path to the ssl key to use
+    # * :ssl_key_passphrase - the key passphrase (optional)
+    def initialize(options={})
+      @options = {
+        :port => 0,
+        :address => "0.0.0.0",
+        :ssl => true,
+        :ssl_certificate => nil,
+        :ssl_key => nil,
+        :ssl_key_passphrase => nil
+      }.merge(options)
+
+      if @options[:ssl]
+        [:ssl_certificate, :ssl_key].each do |k|
+          if @options[k].nil?
+            raise "You must specify #{k} in Lumberjack::Server.new(...)"
+          end
+        end
+      end
+
+      @server = TCPServer.new(@options[:address], @options[:port])
+
+      @close = Concurrent::AtomicBoolean.new
+
+      # Query the port in case the port number is '0'
+      # TCPServer#addr == [ address_family, port, address, address ]
+      @port = @server.addr[1]
+
+      if @options[:ssl]
+        # load SSL certificate
+        @ssl = OpenSSL::SSL::SSLContext.new
+        @ssl.cert = OpenSSL::X509::Certificate.new(File.read(@options[:ssl_certificate]))
+        @ssl.key = OpenSSL::PKey::RSA.new(File.read(@options[:ssl_key]),
+          @options[:ssl_key_passphrase])
+      end
+    end # def initialize
+
+    def run(&block)
+      while !closed?
+        connection = accept
+
+        # Some exception may occur in the accept loop
+        # we will try again in the next iteration
+        # unless the server is closing
+        next unless connection
+
+        Thread.new(connection) do |connection|
+          connection.run(&block)
+        end
+      end
+    end # def run
+
+    def ssl?
+      @ssl
+    end
+
+    def accept(&block)
+      begin
+        socket = @server.accept_nonblock
+        # update the socket with a SSL layer
+        socket = accept_ssl(socket) if ssl?
+
+        if block_given?
+          block.call(socket, self)
+        else
+          return Connection.new(socket, self)
+        end
+      rescue OpenSSL::SSL::SSLError, IOError, EOFError, Errno::EBADF
+        socket.close rescue nil
+        retry unless closed?
+      rescue IO::WaitReadable, Errno::EAGAIN # Resource not ready yet, so lets try again
+        begin
+          IO.select([@server], nil, nil, SOCKET_TIMEOUT)
+          retry unless closed?
+        rescue IOError, Errno::EBADF => e # we currently closing
+          raise e unless closed?
+        end
+      end
+    end
+
+    def accept_ssl(tcp_socket)
+      ssl_socket = OpenSSL::SSL::SSLSocket.new(tcp_socket, @ssl)
+      ssl_socket.sync_close
+
+      begin
+        ssl_socket.accept_nonblock
+
+        return ssl_socket
+      rescue IO::WaitReadable # handshake
+        IO.select([ssl_socket], nil, nil, SOCKET_TIMEOUT)
+        retry unless closed?
+      rescue IO::WaitWritable # handshake
+        IO.select(nil, [ssl_socket], nil, SOCKET_TIMEOUT)
+        retry unless closed?
+      end
+    end
+
+    def closed?
+      @close.value
+    end
+
+    def close
+      @close.make_true
+      @server.close unless @server.closed?
+    end
+  end # class Server
+
+  class Parser
+    PROTOCOL_VERSION_1 = "1".ord
+    PROTOCOL_VERSION_2 = "2".ord
+
+    SUPPORTED_PROTOCOLS = [PROTOCOL_VERSION_1, PROTOCOL_VERSION_2]
+
+    def initialize
+      @buffer_offset = 0
+      @buffer = ""
+      @buffer.force_encoding("BINARY")
+      transition(:header, 2)
+    end # def initialize
+
+    def transition(state, next_length)
+      @state = state
+      #puts :transition => state
+      # TODO(sissel): Assert this self.respond_to?(state)
+      # TODO(sissel): Assert state is in STATES
+      # TODO(sissel): Assert next_length is a number
+      need(next_length)
+    end # def transition
+
+    # Feed data to this parser.
+    #
+    # Currently, it will return the raw payload of websocket messages.
+    # Otherwise, it returns nil if no complete message has yet been consumed.
+    #
+    # @param [String] the string data to feed into the parser.
+    # @return [String, nil] the websocket message payload, if any, nil otherwise.
+    def feed(data, &block)
+      @buffer << data
+      #p :need => @need
+      while have?(@need)
+        send(@state, &block)
+        #case @state
+        #when :header; header(&block)
+        #when :window_size; window_size(&block)
+        #when :data_lead; data_lead(&block)
+        #when :data_field_key_len; data_field_key_len(&block)
+        #when :data_field_key; data_field_key(&block)
+        #when :data_field_value_len; data_field_value_len(&block)
+        #when :data_field_value; data_field_value(&block)
+        #when :data_field_value; data_field_value(&block)
+        #when :compressed_lead; compressed_lead(&block)
+        #when :compressed_payload; compressed_payload(&block)
+        #end # case @state
+      end
+      return nil
+    end # def <<
+
+    # Do we have at least 'length' bytes in the buffer?
+    def have?(length)
+      return length <= (@buffer.size - @buffer_offset)
+    end # def have?
+
+    # Get 'length' string from the buffer.
+    def get(length=nil)
+      length = @need if length.nil?
+      data = @buffer[@buffer_offset ... @buffer_offset + length]
+      @buffer_offset += length
+      if @buffer_offset > 16384
+        @buffer = @buffer[@buffer_offset  .. -1]
+        @buffer_offset = 0
+      end
+      return data
+    end # def get
+
+    # Set the minimum number of bytes we need in the buffer for the next read.
+    def need(length)
+      @need = length
+    end # def need
+
+    FRAME_WINDOW = "W".ord
+    FRAME_DATA = "D".ord
+    FRAME_JSON_DATA = "J".ord
+    FRAME_COMPRESSED = "C".ord
+    def header(&block)
+      version, frame_type = get.bytes.to_a[0..1]
+      version ||= PROTOCOL_VERSION_1
+
+      handle_version(version, &block)
+
+      case frame_type
+      when FRAME_WINDOW; transition(:window_size, 4)
+      when FRAME_DATA; transition(:data_lead, 8)
+      when FRAME_JSON_DATA; transition(:json_data_lead, 8)
+      when FRAME_COMPRESSED; transition(:compressed_lead, 4)
+      else; raise "Unknown frame type: `#{frame_type}`"
+      end
+    end
+
+    def handle_version(version, &block)
+      if supported_protocol?(version)
+        yield :version, version
+      else
+        raise "unsupported protocol #{version}"
+      end
+    end
+
+    def supported_protocol?(version)
+      SUPPORTED_PROTOCOLS.include?(version)
+    end
+
+    def window_size(&block)
+      @window_size = get.unpack("N").first
+      transition(:header, 2)
+      yield :window_size, @window_size
+    end # def window_size
+
+    def json_data_lead(&block)
+      @sequence, payload_size = get.unpack("NN")
+      transition(:json_data_payload, payload_size)
+    end
+
+    def json_data_payload(&block)
+      payload = get
+      yield :json, @sequence, Lumberjack::Beats::json.load(payload)
+      transition(:header, 2)
+    end
+
+    def data_lead(&block)
+      @sequence, @data_count = get.unpack("NN")
+      @data = {}
+      transition(:data_field_key_len, 4)
+    end
+
+    def data_field_key_len(&block)
+      key_len = get.unpack("N").first
+      transition(:data_field_key, key_len)
+    end
+
+    def data_field_key(&block)
+      @key = get
+      transition(:data_field_value_len, 4)
+    end
+
+    def data_field_value_len(&block)
+      transition(:data_field_value, get.unpack("N").first)
+    end
+
+    def data_field_value(&block)
+      @value = get
+
+      @data_count -= 1
+      @data[@key] = @value
+
+      if @data_count > 0
+        transition(:data_field_key_len, 4)
+      else
+        # emit the whole map now that we found the end of the data fields list.
+        yield :data, @sequence, @data
+        transition(:header, 2)
+      end
+
+    end # def data_field_value
+
+    def compressed_lead(&block)
+      length = get.unpack("N").first
+      transition(:compressed_payload, length)
+    end
+
+    def compressed_payload(&block)
+      original = Zlib::Inflate.inflate(get)
+      transition(:header, 2)
+
+      # Parse the uncompressed payload.
+      feed(original, &block)
+    end
+  end # class Parser
+
+  class Connection
+    READ_SIZE = 16384
+
+    attr_accessor :server
+
+    def initialize(fd, server)
+      @parser = Parser.new
+      @fd = fd
+
+      @server = server
+      @ack_handler = nil
+    end
+
+    def peer
+      "#{@fd.peeraddr[3]}:#{@fd.peeraddr[1]}"
+    end
+
+    def run(&block)
+      while !server.closed?
+        read_socket(&block)
+      end
+    rescue EOFError,
+      OpenSSL::SSL::SSLError,
+      IOError,
+      Errno::ECONNRESET,
+      Errno::EPIPE
+      # EOF or other read errors, only action is to shutdown which we'll do in
+      # 'ensure'
+    rescue
+      # when the server is shutting down we can safely ignore any exceptions
+      # On windows, we can get a `SystemCallErr`
+      raise unless server.closed?
+    ensure
+      close rescue 'Already closed stream'
+    end # def run
+
+    def read_socket(&block)
+      # TODO(sissel): Ack on idle.
+      # X: - if any unacked, IO.select
+      # X:   - on timeout, ack all.
+      # X: Doing so will prevent slow streams from retransmitting
+      # X: too many events after errors.
+      @parser.feed(@fd.sysread(READ_SIZE)) do |event, *args|
+        case event
+        when :version
+          version(*args)
+        when :window_size
+          reset_next_ack(*args)
+        when :data
+          sequence, map = args
+          ack_if_needed(sequence) { data(map, &block) }
+        when :json
+          # If the payload is an array of items we will emit multiple events
+          # this behavior was moved from the plugin to the library.
+          # see this commit: https://github.com/logstash-plugins/logstash-input-lumberjack/pull/57/files#diff-1b9590423b15f04f215635164e7376ecR158
+          sequence, map = args
+
+          ack_if_needed(sequence) do
+            if map.is_a?(Array)
+              map.each { |e| data(e, &block) }
+            else
+              data(map, &block)
+            end
+          end
+        end
+      end
+    end
+
+    def version(version)
+      @version = version
+    end
+
+    def ack_if_needed(sequence, &block)
+      block.call
+      send_ack(sequence) if @ack_handler.ack?(sequence)
+    end
+
+    def close
+      @fd.close unless @fd.closed?
+    end
+
+    def closed?
+      @fd.closed?
+    end
+
+    def data(map, &block)
+      block.call(map) if block_given?
+    end
+
+    def reset_next_ack(window_size)
+      klass = version_1? ? AckingProtocolV1 : AckingProtocolV2
+      @ack_handler = klass.new(window_size)
+    end
+
+    def send_ack(sequence)
+      @fd.syswrite(@ack_handler.ack_frame(sequence))
+    end
+
+    def version_1?
+      @version == Parser::PROTOCOL_VERSION_1
+    end
+
+    def identity_stream(map)
+      id = map.fetch("beat", {})["id"]
+
+      if id && map["resource_id"]
+        identity_values = [id, map["resource_id"]]
+      else
+        identity_values = [map.fetch("beat", {})["name"],
+                          map["source"]]
+      end
+
+      identity_values.compact.join("-")
+    end
+  end # class Connection
+
+  class AckingProtocolV1
+    def initialize(window_size)
+      @next_ack = nil
+      @window_size = window_size
+    end
+
+    def ack?(sequence)
+      # The first encoded event will contain the sequence number
+      # this is needed to know when we should ack.
+      @next_ack = compute_next_ack(sequence) if @next_ack.nil?
+      sequence == @next_ack
+    end
+
+    def ack_frame(sequence)
+      ["1A", sequence].pack("A*N")
+    end
+
+    private
+    def compute_next_ack(sequence)
+      (sequence + @window_size - 1) % SEQUENCE_MAX
+    end
+  end
+
+  # Allow lumberjack to send partial ack back to the producer
+  # only V2 client support partial Acks
+  #
+  # Send Ack on every 20% of the data, so with default settings every 200 events
+  # This should reduce the congestion on retransmit.
+  class AckingProtocolV2
+    ACK_RATIO = 5
+
+    def initialize(window_size)
+      @window_size = window_size
+      @every = (window_size / ACK_RATIO).round
+    end
+
+    def ack?(sequence)
+      if @window_size == sequence
+        true
+      elsif @every != 0 && sequence % @every == 0
+        true
+      else
+        false
+      end
+    end
+
+    def ack_frame(sequence)
+      ["2A", sequence].pack("A*N")
+    end
+  end
+end; end# module Lumberjack

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: fluent-plugin-beats
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Masahiro Nakagawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-17 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.58
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.58
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !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: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.8
+- !ruby/object:Gem::Dependency
+  name: test-unit-rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+description: Elastic beats plugin for Fluentd event collector
+email: repeatedly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- fluent-plugin-beats.gemspec
+- lib/fluent/plugin/in_beats.rb
+- lib/lumberjack/beats.rb
+- lib/lumberjack/beats/client.rb
+- lib/lumberjack/beats/server.rb
+homepage: https://github.com/repeatedly/fluent-plugin-beats
+licenses:
+- Apache-2.0
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Elastic beats plugin for Fluentd event collector
+test_files: []