fluent-plugin-scribe 0.10.0 → 0.10.1

data/README.rdoc

@@ -2,17 +2,17 @@
 
 == Overview
 
-This is a plugin for fluent[https://github.com/fluent] event collector. This plugin adds the Scribe[https://github.com/facebook/scribe] compatible interface to fluent.
+This is a plugin for fluentd[https://github.com/fluentd] event collector. This plugin adds the Scribe[https://github.com/facebook/scribe] compatible interface to fluentd.
 
 == What's Scribe?
 
 Scribe[https://github.com/facebook/scribe] is a server for aggregating log data streamed in real time from a large number of servers, developed at Facebook.
 
-It uses Thrift[http://thrift.apache.org/], cross-language RPC framework, to communicate between clients and servers.
+It uses Thrift[http://thrift.apache.org/], a cross-language RPC framework, to communicate between clients and servers.
 
 == What's Scribe plugin for fluent?
 
-The Scribe plugin for fluent enables fluent daemon, to talk the Scribe protocol by using Thrift. The following shows the protocol itself, in thrift-idl format:
+The Scribe plugin for fluentd, which enables fluentd to talk the Scribe protocol. Scribe protocol is defined as follows, in Thrift-IDL format:
 
   enum ResultCode
   {
@@ -31,11 +31,11 @@ The Scribe plugin for fluent enables fluent daemon, to talk the Scribe protocol
     ResultCode Log(1: list<LogEntry> messages);
   }
 
-The category field is used as fluent 'tag'.
+The category field is used as fluentd 'tag'.
 
 == How to use?
 
-To use this plugin with fluent, please add the following configuration to fluent.conf.
+Please add the following configurations to fluent.conf.
 
   # Scribe input
   <source>
@@ -43,12 +43,12 @@ To use this plugin with fluent, please add the following configuration to fluent
     port 1463
   </source>
 
-The following options are supported.
+These options are supported.
 
 * port: port number (default: 1463)
 * bind: bind address (default: 0.0.0.0)
 * server_type: server architecture either in 'simple', 'threaded', 'thread_pool', 'nonblocking' (default: nonblocking)
-* framed: use framed protocol or not (default: true)
+* is_framed: use framed protocol or not (default: true)
 
 == For Developers
 
@@ -64,6 +64,7 @@ Then please execute the sample client.
 == Contributors
 
 * {Satoshi Tagomori}[https://github.com/tagomoris]
+* {Sadayuki Furuhashi}[https://github.com/frsyuki]
 
 == Copyright
 

data/Rakefile

@@ -40,7 +40,7 @@ task "thrift_gen" do
 end
 
 Rake::TestTask.new(:test) do |t|
-  t.test_files = Dir['test/*_test.rb']
+  t.test_files = Dir['test/plugin/*.rb']
   t.ruby_opts = ['-rubygems'] if defined? Gem
   t.ruby_opts << '-I.'
 end

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.10.1

data/lib/fluent/plugin/in_scribe.rb

@@ -21,6 +21,12 @@ module Fluent
 class ScribeInput < Input
   Plugin.register_input('scribe', self)
 
+  config_param :port,            :integer, :default => 1463
+  config_param :bind,            :string,  :default => '0.0.0.0'
+  config_param :server_type,     :string,  :default => 'nonblocking'
+  config_param :is_framed,       :bool,    :default => true
+  config_param :body_size_limit, :size,    :default => 32*1024*1024  # TODO default
+
   def initialize
     require 'thrift'
     $:.unshift File.join(File.dirname(__FILE__), 'thrift')
@@ -30,23 +36,11 @@ class ScribeInput < Input
     require 'scribe_types'
     require 'scribe_constants'
     require 'scribe'
-
-    @port = 1463
-    @bind = '0.0.0.0'
-    @body_size_limit = 32*1024*1024  # TODO default
+    super
   end
 
   def configure(conf)
-    @port = conf['port'] || @port
-    @port = @port.to_i
-    @bind = conf['bind'] || @bind
-
-    @server_type = conf['server_type'] || 'nonblocking'
-    @is_framed = conf['framed'].to_s != "false"
-
-    if body_size_limit = conf['body_size_limit']
-      @body_size_limit = Config.size_value(body_size_limit)
-    end
+    super
   end
 
   def start

data/test/plugin/in_scribe.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+require 'fluent/test'
+require 'lib/fluent/plugin/in_scribe'
+
+class ScribeInputTest < Test::Unit::TestCase
+  def setup
+    Fluent::Test.setup
+  end
+
+  CONFIG = %[
+    port 14630
+    bind 127.0.0.1
+  ]
+
+  def create_driver(conf=CONFIG)
+    Fluent::Test::InputTestDriver.new(Fluent::ScribeInput).configure(conf)
+  end
+
+  def test_configure
+    d = create_driver
+    assert_equal 14630, d.instance.port
+    assert_equal '127.0.0.1', d.instance.bind
+  end
+
+  def test_time
+    d = create_driver
+
+    time = Time.parse("2011-01-02 13:14:15 UTC").to_i
+    Fluent::Engine.now = time
+
+    d.expect_emit "tag1", time, {"message"=>'aiueo'}
+    d.expect_emit "tag2", time, {"message"=>'aiueo'}
+
+    d.run do
+      d.expected_emits.each { |tag, time, record|
+        res = send(tag, record['message'])
+        assert_equal ResultCode::OK, res
+      }
+    end
+  end
+
+  def send(tag, msg)
+    socket = Thrift::Socket.new '127.0.0.1', 14630
+    transport = Thrift::FramedTransport.new socket
+    protocol = Thrift::BinaryProtocol.new transport, false, false
+    client = Scribe::Client.new protocol
+    transport.open
+    raw_sock = socket.to_io
+    raw_sock.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
+    entry = LogEntry.new
+    entry.category = tag
+    entry.message = msg.to_s
+    res = client.Log([entry])
+    transport.close
+    res
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-plugin-scribe
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fluentd
-  requirement: &2153379240 !ruby/object:Gem::Requirement
+  requirement: &2156672800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153379240
+  version_requirements: *2156672800
 - !ruby/object:Gem::Dependency
   name: thrift
-  requirement: &2153378640 !ruby/object:Gem::Requirement
+  requirement: &2156671600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,7 +33,7 @@ dependencies:
         version: 0.7.0
   type: :runtime
   prerelease: false
-  version_requirements: *2153378640
+  version_requirements: *2156671600
 description: 
 email: 
 executables: []
@@ -57,6 +57,7 @@ files:
 - lib/fluent/plugin/thrift/scribe.thrift
 - lib/fluent/plugin/thrift/scribe_constants.rb
 - lib/fluent/plugin/thrift/scribe_types.rb
+- test/plugin/in_scribe.rb
 - README.rdoc
 has_rdoc: true
 homepage: https://github.com/fluent/fluent-plugin-scribe
@@ -83,4 +84,5 @@ rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Scribe plugin for Fluent event collector
-test_files: []
+test_files:
+- test/plugin/in_scribe.rb