Contents

= 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.

== 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.

== 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:

  enum ResultCode
  {
    OK,
    TRY_LATER
  }
  
  struct LogEntry
  {
    1:  string category,
    2:  string message
  }
  
  service scribe extends fb303.FacebookService
  {
    ResultCode Log(1: list<LogEntry> messages);
  }

== How to use?

Install this plugin with fluent, and add the following configuration to fluent.conf.

  # Scribe input
  <source>
    type scribe
    port 1463
    tag debug.aiueo
  </source>

You can modify port, and the corresponding tag.

== Contributors

* {Satoshi Tagomori}[https://github.com/tagomoris]

== Copyright

Copyright:: Copyright (c) 2011 Treasure Data, Inc.
License::   Apache License, Version 2.0

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
fluent-plugin-scribe-0.9.9	README.rdoc