README.rdoc in fluent-plugin-scribe-0.10.0 vs README.rdoc in fluent-plugin-scribe-0.10.1
- old
+ new
@@ -1,20 +1,20 @@
= Scribe input plugin for Fluent
== 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
{
OK,
TRY_LATER
@@ -29,28 +29,28 @@
service scribe extends fb303.FacebookService
{
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>
type scribe
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
To test this plugin, please execute the following command in your 'fluent' project directory, not scribe input plugin directory.
@@ -62,9 +62,10 @@
$ ./bin/fluent-scribe-remote
== Contributors
* {Satoshi Tagomori}[https://github.com/tagomoris]
+* {Sadayuki Furuhashi}[https://github.com/frsyuki]
== Copyright
Copyright:: Copyright (c) 2011 Treasure Data, Inc.
License:: Apache License, Version 2.0