[SCM] libmessage-passing-perl Debian packaging branch, master, updated. debian/0.111-3-14-g44f6e88
Tomas Doran
bobtfish at bobtfish.net
Mon May 6 11:57:03 UTC 2013
The following commit has been merged in the master branch:
commit c14ebe774541dc5d355d2a89b5749f0e34c123bd
Author: Tomas Doran <bobtfish at bobtfish.net>
Date: Mon May 28 08:51:50 2012 +0100
Fix the docs
diff --git a/Changes b/Changes
index a22092b..8c28fc0 100644
--- a/Changes
+++ b/Changes
@@ -1,3 +1,7 @@
+ - Updates and fixes to documentation.
+
+ - Unify license/author/copyright to main file.
+
0.002_01
- Add more core roles for use by extensions which need to make
a connection.
diff --git a/lib/Message/Passing.pm b/lib/Message/Passing.pm
index a2a8ec6..53ffd09 100644
--- a/lib/Message/Passing.pm
+++ b/lib/Message/Passing.pm
@@ -41,22 +41,22 @@ __PACKAGE__->meta->make_immutable;
=head1 NAME
-Message::Passing - a perl subset of Logstash <http://logstash.net>
+Message::Passing - a simple way of doing messaging.
=head1 SYNOPSIS
- logstash --input STDIN --output STDOUT
+ message-passing --input STDIN --output STDOUT
{"foo": "bar"}
{"foo":"bar"}
=head1 DESCRIPTION
-A lightweight but inter-operable subset of logstash
-L<http://logstash.net>
-
This implementation is currently a prototype, and as such should be considered
alpha and subject to change at any point.
+A library for building high performance, loosely coupled and reliable/reseliant applications,
+structured as small services which communicate over the network by passing messages.
+
=head2 BASIC PREMISE
You have data for discrete events, represented by a hash (and
@@ -74,21 +74,21 @@ 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
+L<ZeroMQ> output of logs and performance metrics from your L<Catalyst> FCGI
+or L<Starman> workers) and run one script that will give you a central
application log file, or push the logs into L<ElasticSearch>.
There are a growing set of components you can plug together
-to make your logging solution.
+to make your solution.
-Getting started is really easy - you can just use the C<logstash>
+Getting started is really easy - you can just use the C<message-passing>
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 L<Message::Passing::DSL>.
To dive straight in, see the documentation for the command line utility
-L<logstash>, and see the examples in L<Message::Passing::Manual::Cookbook>.
+L<message-passing>, and see the examples in L<Message::Passing::Manual::Cookbook>.
For more about how the system works, see L<Message::Passing::Manual::Concepts>.
@@ -148,13 +148,13 @@ Outputs send data to somewhere, i.e. they consume messages.
=item L<Message::Passing::Output::STDOUT>
-=item L<Message::Passing::Output::AMQP>
+=item L<Message::Passing::Output::AMQP> - COMING SOON (L<https://github.com/suretec/Message-Passing-AMQP>)
=item L<Message::Passing::Output::ZeroMQ>
=item L<Message::Passing::Output::WebHooks>
-=item L<Message::Passing::Output::ElasticSearch>
+=item L<Message::Passing::Output::ElasticSearch> - COMING SOON (L<https://github.com/suretec/Message-Passing-Output-ElasticSearch>)
=item L<Message::Passing::Output::Test>
@@ -187,7 +187,7 @@ 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.
+This is the entry point for the script.
=head1 AUTHOR
diff --git a/lib/Message/Passing/DSL.pm b/lib/Message/Passing/DSL.pm
index 3ae5a63..26d5705 100644
--- a/lib/Message/Passing/DSL.pm
+++ b/lib/Message/Passing/DSL.pm
@@ -79,14 +79,15 @@ sub run_log_server {
=head1 NAME
-Message::Passing::DSL - An easy way to make chains of logstash objects.
+Message::Passing::DSL - An easy way to make chains of Message::Passing components.
=head1 SYNOPSIS
package mylogcollectorscript;
use Message::Passing::DSL;
- with 'MooseX::GetOpt';
+ with 'MooseX::GetOpt',
+ 'Message::Passing::Role::Script';
has socket_bind => (
is => 'ro',
@@ -108,22 +109,14 @@ Message::Passing::DSL - An easy way to make chains of logstash objects.
};
}
- sub start { run_log_server __PACKAGE__->new_with_options->build_chain }
__PACKAGE__->start unless caller;
+ 1;
=head1 DESCRIPTION
This module provides a simple to use helper system for writing
scripts which implement a L<Message::Passing> server, like
-the built in logstash script.
-
-Your script can just be a script, however if it's a class with a
-C<< ->new >> method, then the new method will be called, or
-if you're a L<MooseX::Getopt> user (i.e. you implement a new_with_optons
-method), then this will be called.
-
-You are expected to define one or more chains, and then call the run
-function.
+the built in message-passing script.
=head2 FUNCTIONS
diff --git a/lib/Message/Passing/DSL/Factory.pm b/lib/Message/Passing/DSL/Factory.pm
index a462aa1..426b2d0 100644
--- a/lib/Message/Passing/DSL/Factory.pm
+++ b/lib/Message/Passing/DSL/Factory.pm
@@ -68,7 +68,7 @@ __PACKAGE__->meta->make_immutable;
=head1 NAME
-Message::Passing::DSL::Factory - Build a set of logstash chains using symbolic names
+Message::Passing::DSL::Factory - Build a set of chains using symbolic names
=head1 DESCRIPTION
diff --git a/lib/Message/Passing/Input/FileTail.pm b/lib/Message/Passing/Input/FileTail.pm
index b6cdb11..2b42955 100644
--- a/lib/Message/Passing/Input/FileTail.pm
+++ b/lib/Message/Passing/Input/FileTail.pm
@@ -55,8 +55,7 @@ Message::Passing::Input::FileTail - File tailing input
=head1 SYNOPSIS
- logstash --input FileTail --input_options '{"filename": "/var/log/foo.log"} --output STDOUT
- {"foo": "bar"}
+ message-passing --input FileTail --input_options '{"filename": "/var/log/foo.log"} --output STDOUT
{"foo":"bar"}
=head1 DESCRIPTION
@@ -65,10 +64,6 @@ Message::Passing::Input::FileTail - File tailing input
L<Message::Passing>
-=head1 AUTHOR
-
-Tomas (t0m) Doran <bobtfish at bobtfish.net>
-
=head1 SPONSORSHIP
This module exists due to the wonderful people at Suretec Systems Ltd.
@@ -77,16 +72,9 @@ VoIP division called SureVoIP <http://www.surevoip.co.uk/> for use with
the SureVoIP API -
<http://www.surevoip.co.uk/support/wiki/api_documentation>
-=head1 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.
-
-=head1 LICENSE
+=head1 AUTHOR, COPYRIGHT AND LICENSE
-XX - TODO
+See L<Message::Passing>.
=cut
diff --git a/lib/Message/Passing/Input/Null.pm b/lib/Message/Passing/Input/Null.pm
index 220c2b3..0ccabbf 100644
--- a/lib/Message/Passing/Input/Null.pm
+++ b/lib/Message/Passing/Input/Null.pm
@@ -15,7 +15,8 @@ Message::Passing::Input::Null - Null input
=head1 SYNOPSIS
- logstash --input Null --output STDOUT
+ message-passing --input Null --output STDOUT
+ # Nothing ever happens..
=head1 DESCRIPTION
@@ -25,10 +26,6 @@ Does nothing (for testing).
L<Message::Passing>
-=head1 AUTHOR
-
-Tomas (t0m) Doran <bobtfish at bobtfish.net>
-
=head1 SPONSORSHIP
This module exists due to the wonderful people at Suretec Systems Ltd.
@@ -37,15 +34,9 @@ VoIP division called SureVoIP <http://www.surevoip.co.uk/> for use with
the SureVoIP API -
<http://www.surevoip.co.uk/support/wiki/api_documentation>
-=head1 COPYRIGHT
-
-Copyright Suretec Systems 2012.
+=head1 AUTHOR, COPYRIGHT AND LICENSE
-Logstash (upon which many ideas for this project is based, but
-which we do not reuse any code from) is copyright 2010 Jorden Sissel.
-
-=head1 LICENSE
-
-XX - TODO
+See L<Message::Passing>.
=cut
+
diff --git a/lib/Message/Passing/Input/STDIN.pm b/lib/Message/Passing/Input/STDIN.pm
index 5ff0541..4b46fa8 100644
--- a/lib/Message/Passing/Input/STDIN.pm
+++ b/lib/Message/Passing/Input/STDIN.pm
@@ -29,7 +29,7 @@ Message::Passing::Input::STDIN - STDIN input
=head1 SYNOPSIS
- logstash --input STDIN --output STDOUT
+ message-passing --input STDIN --output STDOUT
{"foo": "bar"}
{"foo":"bar"}
@@ -39,10 +39,6 @@ Message::Passing::Input::STDIN - STDIN input
L<Message::Passing>
-=head1 AUTHOR
-
-Tomas (t0m) Doran <bobtfish at bobtfish.net>
-
=head1 SPONSORSHIP
This module exists due to the wonderful people at Suretec Systems Ltd.
@@ -51,15 +47,8 @@ VoIP division called SureVoIP <http://www.surevoip.co.uk/> for use with
the SureVoIP API -
<http://www.surevoip.co.uk/support/wiki/api_documentation>
-=head1 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.
-
-=head1 LICENSE
+=head1 AUTHOR, COPYRIGHT AND LICENSE
-XX - TODO
+See L<Message::Passing>.
=cut
diff --git a/lib/Message/Passing/Manual.pod b/lib/Message/Passing/Manual.pod
index 821db32..6863207 100644
--- a/lib/Message/Passing/Manual.pod
+++ b/lib/Message/Passing/Manual.pod
@@ -8,7 +8,7 @@ Message::Passing::Manual - table of contents for Message::Passing documentation
=item L<Message::Passing::Manual::Concepts>
-How (and why) logstash works.
+How (and why) the message passing library works.
=item L<Message::Passing::Manual::Cookbook>
@@ -20,7 +20,7 @@ Writing your own inputs, filters and outputs.
=back
-=head1 AUTHOR & COPYRIGHT
+=head1 AUTHOR, COPYRIGHT & LICENSE
See L<Message::Passing>.
diff --git a/lib/Message/Passing/Manual/Concepts.pod b/lib/Message/Passing/Manual/Concepts.pod
index 99f6187..9cf0097 100644
--- a/lib/Message/Passing/Manual/Concepts.pod
+++ b/lib/Message/Passing/Manual/Concepts.pod
@@ -101,17 +101,17 @@ The example above becomes:
=head1 Event loop
-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
+L<AnyEvent> has been mentioned, and it's expected that scripts will use a supported event
+loop. This implies that your 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<Message::Passing::Manual::Workers>.
+and easy to wire up (on one or more hosts). This is documented more fully in L<Message::Passing::Manual::Workers> XXX FIXME TODO.
=head1 ZeroMQ
-L<ZeroMQ> is the recommended transport for logstash messages, and L<Message::Passing::Output::ZeroMQ> is designed to work
+L<ZeroMQ> is the recommended transport for messages, and L<Message::Passing::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.
@@ -121,4 +121,9 @@ application, or having to use or run the AnyEvent event loop.
Recipies for achieving common tasks
+=head1 AUTHOR, COPYRIGHT & LICENSE
+
+See L<Message::Passing>.
+
=cut
+
diff --git a/lib/Message/Passing/Manual/Cookbook.pod b/lib/Message/Passing/Manual/Cookbook.pod
index 76a2a01..6c666f3 100644
--- a/lib/Message/Passing/Manual/Cookbook.pod
+++ b/lib/Message/Passing/Manual/Cookbook.pod
@@ -31,7 +31,7 @@ You can use L<Log::Dispatch>, or any log system which will output into L<Log::Di
As simple as using the command line interface:
- logstash --input ZeroMQ --input_options '{"socket_bind":"tcp://192.168.0.1:5558"}' \
+ message-passing --input ZeroMQ --input_options '{"socket_bind":"tcp://192.168.0.1:5558"}' \
--output File --output_options '{"filename":"/tmp/mylog"}'
And you've now got a multi-host log aggregation system for your application!
@@ -40,7 +40,7 @@ And you've now got a multi-host log aggregation system for your application!
Assuming that you've got a regular syslogd setup and working, then you probably want to keep that.
Having B<some of> the log files on individual hosts can be very useful. Also, we'd like to avoid
-logstash being a privileged user (which would be needed to get the standard port).
+the script being a privileged user (which would be needed to get the standard port).
Therefore, we'll run a syslog listener on a high port (5140), and get the regular syslogd to ship
messages to it. The listener will then forward from each host to a central aggregate logger
@@ -48,7 +48,7 @@ messages to it. The listener will then forward from each host to a central aggre
=head2 On host collector
- logstash --input Syslog --output ZeroMQ --output_options '{"connect":"tcp://192.168.0.1:5558"}'
+ message-passing --input Syslog --output ZeroMQ --output_options '{"connect":"tcp://192.168.0.1:5558"}'
=head2 Configuring your syslogd
@@ -63,6 +63,8 @@ If you have hosts with both applications and syslog that you want to aggregate,
do both at once. This also means that your apps ship logs to a local buffer process rather than
directly across the network - which is more resilient to short network outages.
-This
+=head1 AUTHOR, COPYRIGHT & LICENSE
+
+See L<Message::Passing>.
=cut
diff --git a/lib/Message/Passing/Output/File.pm b/lib/Message/Passing/Output/File.pm
index f806df2..9fb50cc 100644
--- a/lib/Message/Passing/Output/File.pm
+++ b/lib/Message/Passing/Output/File.pm
@@ -54,7 +54,7 @@ Message::Passing::Output::File - File output
=head1 SYNOPSIS
- logstash --input STDIN --output File
+ message-passing --input STDIN --output File --output_options '{"filename": "/tmp/my.log"}'
{"foo": "bar"}
{"foo":"bar"}
diff --git a/lib/Message/Passing/Output/Null.pm b/lib/Message/Passing/Output/Null.pm
index 3a03197..9a4cde8 100644
--- a/lib/Message/Passing/Output/Null.pm
+++ b/lib/Message/Passing/Output/Null.pm
@@ -11,11 +11,11 @@ __PACKAGE__->meta->make_immutable;
=head1 NAME
-Message::Passing::Output::Null - /dev/null for logstash messages
+Message::Passing::Output::Null - /dev/null for messages
=head1 SYNOPSIS
- logstash --input STDIN --output Null
+ message-passing --input STDIN --output Null
{"foo": "bar"}
# Note noting is printed...
diff --git a/lib/Message/Passing/Output/STDOUT.pm b/lib/Message/Passing/Output/STDOUT.pm
index 320947f..6244eae 100644
--- a/lib/Message/Passing/Output/STDOUT.pm
+++ b/lib/Message/Passing/Output/STDOUT.pm
@@ -19,7 +19,7 @@ Message::Passing::Output::STDOUT - STDOUT output
=head1 SYNOPSIS
- logstash --input STDIN --output STDOUT
+ message-passing --input STDIN --output STDOUT
{"foo": "bar"}
{"foo":"bar"}
diff --git a/lib/Message/Passing/Types.pm b/lib/Message/Passing/Types.pm
index f6faf9f..03f105c 100644
--- a/lib/Message/Passing/Types.pm
+++ b/lib/Message/Passing/Types.pm
@@ -32,4 +32,3 @@ MooseX::Getopt::OptionTypeMap->add_option_type_to_map(
);
1;
-
--
libmessage-passing-perl Debian packaging
More information about the Pkg-perl-cvs-commits
mailing list