diff --git a/README.md b/README.md index 14b3d90..dc97355 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,30 @@ -flume-hornetq -============= +Flume HornetQ Plugin +======= -This project is simply a Flume Sink plugin to send events to a HornetQ queue. +## Overview +This plugin has been built for and tested with Cloudera's Flume v0.9.4 from CDH3 in order to provide interoperability with HornetQ Messaging queue. -Currently a work in progress. +## Install +* In order to install you will need to place the HornetQ jars from the `lib` directory of the download package into the Flume lib directory: `cp ./hornetq-2.2.14.Final/lib/*.jar /usr/lib/flume/lib/`. +* Download source: `git clone git://github.com/brettlangdon/flume-hornetq.git` +* Build plugin: `cd ./flume-hornetq` then `ant` +* Place `flume-hornetq.jar` into Flume lib directory: `cp flume-hornetq.jar /usr/lib/flume/lib`. +* Add `com.blangdon.flume.hornetq.HornetQJMSSink` to the `flume.plugin.classes` property in your Flume site config: `/etc/flume/cponf/flume-site/xml`. -I only currently intent on writting this targeted for Flume v0.9.4 and only a sink that uses JMS to send messages to a provided HornetQ queue. \ No newline at end of file +## HornetQJMSSink +Provides a producer to send events to HornetQ + +### Definition +``` +hornetQJMSSink( queueName, [jnpHost, jnpPort] ) +``` + +### Example +``` +collector: autoCollectorSource() | hornetQJMSSink("/queue/name"); +``` + +### TODO +* Auto Reconnect, right now if there is a disconnect between Flume and HornetQ then no more events will be Produced. \ No newline at end of file