[SCM] libmessage-passing-perl Debian packaging branch, master, updated. debian/0.111-3-14-g44f6e88

[Tomas Doran]

The following commit has been merged in the master branch:
commit 9b6b04a59f2dda46b3abc2dcbdfb4ceef0d7f945
Author: Tomas Doran <bobtfish at bobtfish.net>
Date:   Sun Mar 4 17:52:14 2012 +0000

    Generate README for github

diff --git a/Makefile.PL b/Makefile.PL
index e2d861e..a2f5953 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -29,5 +29,10 @@ author_requires 'Test::Spelling';
 
 author_tests 't/author';
 
+if ($Module::Install::AUTHOR) {
+    system("pod2text lib/Log/Stash.pm > README")
+        and die $!;
+}
+
 WriteAll;
 
diff --git a/README b/README
new file mode 100644
index 0000000..b3b65e1
--- /dev/null
+++ b/README
@@ -0,0 +1,127 @@
+NAME
+    Log::Stash - a perl subset of Logstash <http://logstash.net>
+
+SYNOPSIS
+        logstash --input STDIN --output STDOUT
+        {"foo": "bar"}
+        {"foo":"bar"}
+
+DESCRIPTION
+    A lightweight but inter-operable subset of logstash
+    <http://logstash.net>
+
+    This implementation is currently a prototype, and as such should be
+    considered alpha and subject to change at any point.
+
+  BASIC PREMISE
+    You have data for discrete events, represented by a hash (and serialized
+    as JSON).
+
+    This could be a text log line, an audit record of an API event, a metric
+    emitted from your application that you wish to aggregate and process -
+    anything that can be a simple hash really..
+
+    You want to be able to shove these events over the network easily, and
+    aggregate them / filter and rewrite them / split them into worker
+    queues.
+
+    This module is designed as a simple framework for writing components
+    that let you do all of these things, in a simple and easily extensible
+    manor.
+
+    For a practical example, You generate events from a source (e.g. ZeroMQ
+    output of logs and performance metrics from your Catalyst FCGI or
+    Starman workers) and run one script that will give you a central
+    application log file, or push the logs into ElasticSearch.
+
+    There are a growing set of components you can plug together to make your
+    logging solution.
+
+    Getting started is really easy - you can just use the "logstash" command
+    installed by the distribution. If you have a common config that you want
+    to repeat, or you want to write your own server which does something
+    more flexible than the normal script allows, then see Log::Stash::DSL.
+
+COMPONENTS
+    Below is a non-exhaustive list of components available.
+
+  INPUTS
+    Inputs receive data from a source (usually a network protocol).
+
+    They are responsible for decoding the data into a hash before passing it
+    onto the next stage.
+
+    Inputs include:
+
+    Log::Stash::Input::STDIN
+    Log::Stash::Input::ZeroMQ
+    Log::Stash::Input::Test
+
+    You can easily write your own input, just use AnyEvent, and consume
+    Log::Stash::Role::Input.
+
+  FILTER
+    Filters can transform a message in any way.
+
+    Examples include:
+
+    Log::Stash::Filter::Null - Returns the input unchanged.
+    Log::Stash::Filter::All - Stops any messages it receives from being
+    passed to the output. I.e. literally filters all input out.
+    Log::Stash::Filter::T - Splits the incoming message to multiple outputs.
+
+    You can easily write your own filter, just consume
+    Log::Stash::Role::Filter.
+
+    Note that filters can be chained, and a filter can return undef to stop
+    a message being passed to the output.
+
+  OUTPUTS
+    Outputs send data to somewhere, i.e. they consume messages.
+
+    Log::Stash::Output::STDOUT
+    Log::Stash::Output::AMQP
+    Log::Stash::Output::ZeroMQ
+    Log::Stash::Output::WebHooks
+    Log::Stash::Output::ElasticSearch
+    Log::Stash::Output::Test
+
+SEE ALSO
+    Log::Message::Structured - For creating your log messages.
+    Log::Dispatch::Log::Stash - use Log::Stash outputs from Log::Dispatch.
+
+THIS MODULE
+    This is a simple MooseX::Getopt script, with one input, one filter and
+    one output.
+
+  METHODS
+   build_chain
+    Builds and returns the configured chain of input => filter => output
+
+   start
+    Class method to call the run_log_server function with the results of
+    having constructed an instance of this class, parsed command line
+    options and constructed a chain.
+
+    This is the entry point for the logstash script.
+
+AUTHOR
+    Tomas (t0m) Doran <bobtfish at bobtfish.net>
+
+SPONSORSHIP
+    This module exists due to the wonderful people at Suretec Systems
+    <http://www.suretecsystems.com/> who sponsored it's development.
+
+COPYRIGHT
+    Copyright Suretec Systems 2012.
+
+    Logstash (upon which many ideas for this project is based, but which we
+    do not reuse any code from) is copyright 2010 Jorden Sissel.
+
+LICENSE
+    GNU Affero General Public License, Version 3
+
+    If you feel this is too restrictive to be able to use this software,
+    please talk to us as we'd be willing to consider re-licensing under less
+    restrictive terms.
+

-- 
libmessage-passing-perl Debian packaging