Updated documentation.
authorStanislaw Klekot <dozzie@jarowit.net>
Fri, 28 Dec 2012 22:23:14 +0000 (23:23 +0100)
committerStanislaw Klekot <dozzie@jarowit.net>
Fri, 28 Dec 2012 22:23:14 +0000 (23:23 +0100)
lib/Log/Log4perl/Appender/Fluent.pm

index 37f888b..16a6341 100644 (file)
@@ -39,7 +39,7 @@ our $VERSION = '0.01';
 
 =head1 USAGE
 
-Available options:
+Following options are available in L<Log::Log4perl(3)> config:
 
 =cut
 
@@ -47,21 +47,43 @@ Available options:
 
 =over
 
-=item I<socket>
+=item I<socket> (default: I<none>)
+
+Path to UNIX socket, where Fluentd listens. If specified, communication with
+Fluentd instance will go through this socket, otherwise TCP protocol will be
+used.
 
 =item I<host>, I<port> (default: C<localhost>, C<24224>)
 
+Fluentd instance's address. If neither host/port nor socket is specified,
+due to default values, TCP communication will take place.
+
 =item I<message_field> (default: C<message>)
 
-=item I<hostname_field>
+Communication with Fluentd imposes using hashes as messages. This option
+tells how should be named key if the message is not a L<Log::Message::JSON(3)>
+object.
+
+=item I<hostname_field> (default: I<none>)
+
+Fluentd on its own doesn't provide the information where the record comes
+from. Setting I<hostname_field> will make this module to add (replace)
+necessary field in messages.
 
-=item I<tag_prefix>, I<tag>
+=item I<tag_prefix>, I<tag> (default: I<none>, I<none>)
 
-B<Already implemented>.
+If I<tag> is set, this will be the tag for messages. If I<tag_prefix> is set,
+message will have the tag set to this prefix plus message's category. If
+neither I<tag> nor I<tag_prefix> is set, message's tag is equal to category.
 
-=item I<category_field>, I<level_field>
+I<tag> has the precedence from these two if both set.
 
-B<TODO>
+=item I<category_field>, I<level_field> (default: I<none>, I<none>)
+
+B<TODO>: Unimplemented yet.
+
+These options, similarly to I<hostname_field>, specify where to put message's
+category and level.
 
 =back
 
@@ -157,6 +179,10 @@ by the Free Software Foundation; or the Artistic License.
 
 See http://dev.perl.org/licenses/ for more information.
 
+=head1 SEE ALSO
+
+http://fluentd.org/, L<Log::Log4perl(3)>, L<Log::Message::JSON(3)>.
+
 =cut
 
 #-----------------------------------------------------------------------------