[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 e91e6c6ac770f03b51de6b9503d6943fc45d8b0a
Author: Tomas Doran <bobtfish at bobtfish.net>
Date:   Sun Apr 29 23:32:49 2012 +0100

    More docs

diff --git a/README b/README
index efa8530..2d4493c 100644
--- a/README
+++ b/README
@@ -42,6 +42,11 @@ DESCRIPTION
     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.
 
+    To dive straight in, see the documentation for the command line utility
+    logstash, and see the examples in Log::Stash::Manual::Cookbook.
+
+    For more about how the system works, see Log::Stash::Manual::Concepts.
+
 COMPONENTS
     Below is a non-exhaustive list of components available.
 
diff --git a/lib/Log/Stash/Manual/Concepts.pod b/lib/Log/Stash/Manual/Concepts.pod
index 2efdcca..199d5e4 100644
--- a/lib/Log/Stash/Manual/Concepts.pod
+++ b/lib/Log/Stash/Manual/Concepts.pod
@@ -5,24 +5,24 @@ Log::Stash::Manual::Concepts - The concepts behind the framework
 =head1 DESCRIPTION
 
 This framework tries to be a simplifying layer over message passing, allowing you to easily
-make the networking parts of message passing become just configuration, allowing you to concentrate
+make the networking parts of message passing become just configuration. This allows you to concentrate
 on the hard parts (i.e. your application, not the message passing).
 
 =head1 COMPONENTS AND CHAINS
 
-There are only a few core concepts to grasp to use the framework, but lets start with the component types, and then
-move onto chains.. 
+There are only a few core concepts to grasp to use the framework. We'll start with the component types, and then
+move onto chains.
 
 There are only three types of components:
 
 =head2 OUTPUTS
 
-An output is simply a class with a C<consume> method. This will be called with the message
+An output is simply a class with a C<consume> method. This will be called with a message
 as it's only parameter, like this:
 
     $output->consume($message);
     
-Outputs are expected to compose L<Log::Stash::Role::Output>. See the source code of
+Outputs are expected to compose L<Log::Stash::Role::Output>.
 
 =head2 INPUTS
 
@@ -39,7 +39,7 @@ use the C<BUILD> method from Moose to do any work needed to start listening for
 A filter is just a combination of an output and input. Some (or all) of the messages consumed
 by the input are sent on to the output.
 
-An optional L<Log::Stash::Role::Filter is supplied, allowing you to provide a simple filter
+An optional L<Log::Stash::Role::Filter> is supplied, allowing you to provide a simple filter
 method:
 
     with 'Log::Stash::Role::Filter';
@@ -49,7 +49,7 @@ method:
         return $message; # Or return undef to drop it
     }
 
-If you want to, you can however write a filter manually, as:
+However, if you want or need to, you can however write a filter manually, as:
 
     with qw/
         Log::Stash::Role::Input
@@ -101,6 +101,24 @@ The example above becomes:
 
 =head1 Event loop
 
-L<AnyEvent> has been mentioned more than on
+L<AnyEvent> has been mentioned, and it's expected that logstash scripts will use a supported event
+loop. This implies that your logstash code is asynchronous, which is generally fine - however it should
+be noted that doing any long operation (non trivial database queries) will block the entire server - meaning
+no events will be processed. 
+
+In cases such as these, running a pool of worker processes to distribute the blocking jobs is more appropriate,
+and easy to wire up (on one or more hosts). This is documented more fully in L<Log::Stash::Manual::Workers>.
+
+=head1 ZeroMQ
+
+L<ZeroMQ> is the recommended transport for logstash messages, and L<Log::Stash::Output::ZeroMQ> is designed to work
+inside a traditional synchronous application. This means that you can emit messages into ZeroMQ without blocking your
+application, or having to use or run the AnyEvent event loop.
+
+=head1 SEE ALSO
+
+=head2 L<Log::Stash::Manual::Cookbook>
+
+Recipies for achieving common tasks
 
 =cut

-- 
libmessage-passing-perl Debian packaging