[libmessage-passing-zeromq-perl] 15/78: Tidy up docs
Jonas Smedegaard
js at alioth.debian.org
Mon Sep 30 09:28:18 UTC 2013
This is an automated email from the git hooks/post-receive script.
js pushed a commit to branch master
in repository libmessage-passing-zeromq-perl.
commit 67875af15e3f5d65cfee40e781f1699852c2e664
Author: Tomas Doran <bobtfish at bobtfish.net>
Date: Sun Mar 4 18:15:02 2012 +0000
Tidy up docs
---
README | 25 +++++++++----------------
lib/Log/Stash/Input/ZeroMQ.pm | 12 +++---------
lib/Log/Stash/Output/ZeroMQ.pm | 25 +++++++++++--------------
lib/Log/Stash/ZeroMQ.pm | 8 ++++----
t/author/spelling.t | 3 +++
5 files changed, 30 insertions(+), 43 deletions(-)
diff --git a/README b/README
index 44a5697..fe91f7f 100644
--- a/README
+++ b/README
@@ -18,20 +18,20 @@ DESCRIPTION
log messages across the network in a non-blocking manor.
Clients (I.e. users of the Log::Stash::Output::ZeroMQ class) connect to
- a server (I.e. a user of the "sub sockets. These are setup to be lossy
- and non-blocking, meaning that if the log-receiver process is down or
- slow, then the application will queue a small (and configurable) amount
- of logs on it's side, and after that log messages will be dropped." in
- Log::Stash::Input::ZeroMQ class) via ZeroMQ's pub
+ a server (I.e. a user of the Log::Stash::Input::ZeroMQ class) via
+ ZeroMQ's pub/sub sockets. These are setup to be lossy and non-blocking,
+ meaning that if the log-receiver process is down or slow, then the
+ application will queue a small (and configurable) amount of logs on it's
+ side, and after that log messages will be dropped.
Whilst throwing away log messages isn't a good thing to do, or something
that you want to happen regularly, in many (especially web application)
- contexts, network logging being a single point of failure is
- unaccaptable from a reliablilty and graceful degredation standpoint.
+ contexts, network logging being a single point of failure is not
+ acceptable from a reliability and graceful degradation standpoint.
The application grinding to a halt as a non-essential centralised
resource is unavailable (e.g. the log aggregation server) is
- significnalty less acceptable than the loss of non-essential logging
+ significantly less acceptable than the loss of non-essential logging
data.
HOW TO USE
@@ -66,13 +66,6 @@ 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 relicensing under less
+ please talk to us as we'd be willing to consider re-licensing under less
restrictive terms.
-POD ERRORS
- Hey! The above document had some coding errors, which are explained
- below:
-
- Around line 56:
- Unterminated L<...> sequence
-
diff --git a/lib/Log/Stash/Input/ZeroMQ.pm b/lib/Log/Stash/Input/ZeroMQ.pm
index a7a4c8b..7594477 100644
--- a/lib/Log/Stash/Input/ZeroMQ.pm
+++ b/lib/Log/Stash/Input/ZeroMQ.pm
@@ -102,21 +102,15 @@ Log::Stash::Input::ZeroMQ - input logstash messages from ZeroMQ.
=back
-=head1 AUTHOR
-
-Tomas (t0m) Doran <bobtfish at bobtfish.net>
-
=head1 SPONSORSHIP
This module exists due to the wonderful people at
L<Suretec Systems|http://www.suretecsystems.com/> who sponsored it's
development.
-=head1 COPYRIGHT
-
-Copyright Suretec Systems 2012.
+=head1 AUTHOR, COPYRIGHT AND LICENSE
-=head1 LICENSE
+See L<Log::Stash>.
-XXX - TODO
+=cut
diff --git a/lib/Log/Stash/Output/ZeroMQ.pm b/lib/Log/Stash/Output/ZeroMQ.pm
index 91a9b50..624a9d0 100644
--- a/lib/Log/Stash/Output/ZeroMQ.pm
+++ b/lib/Log/Stash/Output/ZeroMQ.pm
@@ -47,16 +47,16 @@ Log::Stash::Output::ZeroMQ - output logstash messages to ZeroMQ.
=head1 SYNOPSIS
use Log::Stash::Output::ZeroMQ;
-
+
my $logger = Log::Stash::Output::ZeroMQ->new;
$logger->consume({data => { some => 'data'}, '@metadata' => 'value' });
# You are expected to produce a logstash message format compatible message,
# see the documentation in Log::Stash for more details.
-
+
# Or see Log::Dispatch::Log::Stash for a more 'normal' interface to
# simple logging.
-
+
# Or use directly on command line:
logstash --input STDIN --output ZeroMQ
{"data":{"some":"data"},"@metadata":"value"}
@@ -72,8 +72,11 @@ a logger in normal perl applications.
You cannot send ZeroMQ messages and then call fork() and send more ZeroMQ messages!
-If you need to call fork(), and you're not going to immediately exec() another process, you B<MUST>
-call FIXME MAKE THIS WORK!!!!
+=head1 METHODS
+
+=head2 consume
+
+Sends a message.
=head1 SEE ALSO
@@ -91,21 +94,15 @@ call FIXME MAKE THIS WORK!!!!
=back
-=head1 AUTHOR
-
-Tomas (t0m) Doran <bobtfish at bobtfish.net>
-
=head1 SPONSORSHIP
This module exists due to the wonderful people at
L<Suretec Systems|http://www.suretecsystems.com/> who sponsored it's
development.
-=head1 COPYRIGHT
-
-Copyright Suretec Systems 2012.
+=head1 AUTHOR, COPYRIGHT AND LICENSE
-=head1 LICENSE
+See L<Log::Stash>.
-XXX - TODO
+=cut
diff --git a/lib/Log/Stash/ZeroMQ.pm b/lib/Log/Stash/ZeroMQ.pm
index 889f3de..ca9c801 100644
--- a/lib/Log/Stash/ZeroMQ.pm
+++ b/lib/Log/Stash/ZeroMQ.pm
@@ -54,16 +54,16 @@ Designed for use as a log transport and aggregation mechanism for perl applicati
to aggregate structured and non-structured log messages across the network in a non-blocking manor.
Clients (I.e. users of the L<Log::Stash::Output::ZeroMQ> class) connect to a server (I.e. a user of the
-L<Log::Stash::Input::ZeroMQ class) via ZeroMQ's pub/sub sockets. These are setup to be lossy and non-blocking,
+L<Log::Stash::Input::ZeroMQ> class) via ZeroMQ's pub/sub sockets. These are setup to be lossy and non-blocking,
meaning that if the log-receiver process is down or slow, then the application will queue a small (and configurable)
amount of logs on it's side, and after that log messages will be dropped.
Whilst throwing away log messages isn't a good thing to do, or something that you want to happen regularly,
in many (especially web application) contexts, network logging being a single point of failure is
-unaccaptable from a reliablilty and graceful degredation standpoint.
+not acceptable from a reliability and graceful degradation standpoint.
The application grinding to a halt as a non-essential centralised resource is unavailable (e.g. the log aggregation
-server) is significnalty less acceptable than the loss of non-essential logging data.
+server) is significantly less acceptable than the loss of non-essential logging data.
=head1 HOW TO USE
@@ -111,7 +111,7 @@ Copyright Suretec Systems 2012.
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 relicensing under
+please talk to us as we'd be willing to consider re-licensing under
less restrictive terms.
=cut
diff --git a/t/author/spelling.t b/t/author/spelling.t
index 1e30bd9..fc29d71 100644
--- a/t/author/spelling.t
+++ b/t/author/spelling.t
@@ -4,6 +4,8 @@ use Test::More;
use Test::Spelling;
add_stopwords(qw(
+ lossy
+ ZeroMQ's
Starman
ZeroMQ
API
@@ -22,6 +24,7 @@ add_stopwords(qw(
STDOUT
STDERR
logstash
+ centralised
));
set_spell_cmd('aspell list -l en');
all_pod_files_spelling_ok();
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libmessage-passing-zeromq-perl.git
More information about the Pkg-perl-cvs-commits
mailing list