commit e41fbc35c0a7589095ef6dd8e4408100d75f28d0 Author: Mario Fetka Date: Sun Feb 25 14:27:18 2018 +0100 Imported Upstream version 1.3.1 diff --git a/Build.PL b/Build.PL new file mode 100644 index 0000000..16855c4 --- /dev/null +++ b/Build.PL @@ -0,0 +1,12 @@ +# ========================================================================= +# THIS FILE IS AUTOMATICALLY GENERATED BY MINILLA. +# DO NOT EDIT DIRECTLY. +# ========================================================================= + +use 5.008_001; +use strict; + +use Module::Build::Tiny 0.035; + +Build_PL(); + diff --git a/Changes b/Changes new file mode 100644 index 0000000..74edad3 --- /dev/null +++ b/Changes @@ -0,0 +1,23 @@ +Revision history for Perl extension Log-Dispatch-Gelf + +1.3.1 2018-02-01T12:31:14Z + - add Params::Validate to cpanfile + +1.3.0 2016-03-01T13:59:38Z + - use Log::GELF::Util (ADAMC) + +1.2.0 2016-02-18T10:13:10Z + - custom additional fields in log method (ADAMC) + +1.1.0 2016-02-15T13:51:56Z + - compression (ADAMC) + - UDP chunking (ADAMC) + +1.0.0 2016-01-21T11:28:23Z + + - support for direct logging through Graylog's UDP or TCP socket + +0.1.0 2015-05-04T12:27:24Z + + - original version + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..e0c822c --- /dev/null +++ b/LICENSE @@ -0,0 +1,378 @@ +This software is copyright (c) 2015 by Miroslav Tynovsky . + +This is free software; you can redistribute it and/or modify it under +the same terms as the Perl 5 programming language system itself. + +Terms of the Perl programming language system itself + +a) the GNU General Public License as published by the Free + Software Foundation; either version 1, or (at your option) any + later version, or +b) the "Artistic License" + +--- The GNU General Public License, Version 1, February 1989 --- + +This software is Copyright (c) 2015 by Miroslav Tynovsky . + +This is free software, licensed under: + + The GNU General Public License, Version 1, February 1989 + + GNU GENERAL PUBLIC LICENSE + Version 1, February 1989 + + Copyright (C) 1989 Free Software Foundation, Inc. + 51 Franklin St, Suite 500, Boston, MA 02110-1335 USA + + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The license agreements of most software companies try to keep users +at the mercy of those companies. By contrast, our General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. The +General Public License applies to the Free Software Foundation's +software and to any other program whose authors commit to using it. +You can use it for your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Specifically, the General Public License is designed to make +sure that you have the freedom to give away or sell copies of free +software, that you receive source code or can get it if you want it, +that you can change the software or use pieces of it in new free +programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of a such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must tell them their rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any program or other work which +contains a notice placed by the copyright holder saying it may be +distributed under the terms of this General Public License. The +"Program", below, refers to any such program or work, and a "work based +on the Program" means either the Program or any work containing the +Program or a portion of it, either verbatim or with modifications. Each +licensee is addressed as "you". + + 1. You may copy and distribute verbatim copies of the Program's source +code as you receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice and +disclaimer of warranty; keep intact all the notices that refer to this +General Public License and to the absence of any warranty; and give any +other recipients of the Program a copy of this General Public License +along with the Program. You may charge a fee for the physical act of +transferring a copy. + + 2. You may modify your copy or copies of the Program or any portion of +it, and copy and distribute such modifications under the terms of Paragraph +1 above, provided that you also do the following: + + a) cause the modified files to carry prominent notices stating that + you changed the files and the date of any change; and + + b) cause the whole of any work that you distribute or publish, that + in whole or in part contains the Program or any part thereof, either + with or without modifications, to be licensed at no charge to all + third parties under the terms of this General Public License (except + that you may choose to grant warranty protection to some or all + third parties, at your option). + + c) If the modified program normally reads commands interactively when + run, you must cause it, when started running for such interactive use + in the simplest and most usual way, to print or display an + announcement including an appropriate copyright notice and a notice + that there is no warranty (or else, saying that you provide a + warranty) and that users may redistribute the program under these + conditions, and telling the user how to view a copy of this General + Public License. + + d) You may charge a fee for the physical act of transferring a + copy, and you may at your option offer warranty protection in + exchange for a fee. + +Mere aggregation of another independent work with the Program (or its +derivative) on a volume of a storage or distribution medium does not bring +the other work under the scope of these terms. + + 3. You may copy and distribute the Program (or a portion or derivative of +it, under Paragraph 2) in object code or executable form under the terms of +Paragraphs 1 and 2 above provided that you also do one of the following: + + a) accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of + Paragraphs 1 and 2 above; or, + + b) accompany it with a written offer, valid for at least three + years, to give any third party free (except for a nominal charge + for the cost of distribution) a complete machine-readable copy of the + corresponding source code, to be distributed under the terms of + Paragraphs 1 and 2 above; or, + + c) accompany it with the information you received as to where the + corresponding source code may be obtained. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form alone.) + +Source code for a work means the preferred form of the work for making +modifications to it. For an executable file, complete source code means +all the source code for all modules it contains; but, as a special +exception, it need not include source code for modules which are standard +libraries that accompany the operating system on which the executable +file runs, or for standard header files or definitions files that +accompany that operating system. + + 4. You may not copy, modify, sublicense, distribute or transfer the +Program except as expressly provided under this General Public License. +Any attempt otherwise to copy, modify, sublicense, distribute or transfer +the Program is void, and will automatically terminate your rights to use +the Program under this License. However, parties who have received +copies, or rights to use copies, from you under this General Public +License will not have their licenses terminated so long as such parties +remain in full compliance. + + 5. By copying, distributing or modifying the Program (or any work based +on the Program) you indicate your acceptance of this license to do so, +and all its terms and conditions. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the original +licensor to copy, distribute or modify the Program subject to these +terms and conditions. You may not impose any further restrictions on the +recipients' exercise of the rights granted herein. + + 7. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of the license which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +the license, you may choose any version ever published by the Free Software +Foundation. + + 8. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 9. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 10. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to humanity, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + + To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively convey +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) 19yy + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 1, or (at your option) + any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program; if not, write to the Free Software + Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301 USA + + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) 19xx name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the +appropriate parts of the General Public License. Of course, the +commands you use may be called something other than `show w' and `show +c'; they could even be mouse-clicks or menu items--whatever suits your +program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + program `Gnomovision' (a program to direct compilers to make passes + at assemblers) written by James Hacker. + + , 1 April 1989 + Ty Coon, President of Vice + +That's all there is to it! + + +--- The Artistic License 1.0 --- + +This software is Copyright (c) 2015 by Miroslav Tynovsky . + +This is free software, licensed under: + + The Artistic License 1.0 + +The Artistic License + +Preamble + +The intent of this document is to state the conditions under which a Package +may be copied, such that the Copyright Holder maintains some semblance of +artistic control over the development of the package, while giving the users of +the package the right to use and distribute the Package in a more-or-less +customary fashion, plus the right to make reasonable modifications. + +Definitions: + + - "Package" refers to the collection of files distributed by the Copyright + Holder, and derivatives of that collection of files created through + textual modification. + - "Standard Version" refers to such a Package if it has not been modified, + or has been modified in accordance with the wishes of the Copyright + Holder. + - "Copyright Holder" is whoever is named in the copyright or copyrights for + the package. + - "You" is you, if you're thinking about copying or distributing this Package. + - "Reasonable copying fee" is whatever you can justify on the basis of media + cost, duplication charges, time of people involved, and so on. (You will + not be required to justify it to the Copyright Holder, but only to the + computing community at large as a market that must bear the fee.) + - "Freely Available" means that no fee is charged for the item itself, though + there may be fees involved in handling the item. It also means that + recipients of the item may redistribute it under the same conditions they + received it. + +1. You may make and give away verbatim copies of the source form of the +Standard Version of this Package without restriction, provided that you +duplicate all of the original copyright notices and associated disclaimers. + +2. You may apply bug fixes, portability fixes and other modifications derived +from the Public Domain or from the Copyright Holder. A Package modified in such +a way shall still be considered the Standard Version. + +3. You may otherwise modify your copy of this Package in any way, provided that +you insert a prominent notice in each changed file stating how and when you +changed that file, and provided that you do at least ONE of the following: + + a) place your modifications in the Public Domain or otherwise make them + Freely Available, such as by posting said modifications to Usenet or an + equivalent medium, or placing the modifications on a major archive site + such as ftp.uu.net, or by allowing the Copyright Holder to include your + modifications in the Standard Version of the Package. + + b) use the modified Package only within your corporation or organization. + + c) rename any non-standard executables so the names do not conflict with + standard executables, which must also be provided, and provide a separate + manual page for each non-standard executable that clearly documents how it + differs from the Standard Version. + + d) make other distribution arrangements with the Copyright Holder. + +4. You may distribute the programs of this Package in object code or executable +form, provided that you do at least ONE of the following: + + a) distribute a Standard Version of the executables and library files, + together with instructions (in the manual page or equivalent) on where to + get the Standard Version. + + b) accompany the distribution with the machine-readable source of the Package + with your modifications. + + c) accompany any non-standard executables with their corresponding Standard + Version executables, giving the non-standard executables non-standard + names, and clearly documenting the differences in manual pages (or + equivalent), together with instructions on where to get the Standard + Version. + + d) make other distribution arrangements with the Copyright Holder. + +5. You may charge a reasonable copying fee for any distribution of this +Package. You may charge any fee you choose for support of this Package. You +may not charge a fee for this Package itself. However, you may distribute this +Package in aggregate with other (possibly commercial) programs as part of a +larger (possibly commercial) software distribution provided that you do not +advertise this Package as a product of your own. + +6. The scripts and library files supplied as input to or produced as output +from the programs of this Package do not automatically fall under the copyright +of this Package, but belong to whomever generated them, and may be sold +commercially, and may be aggregated with this Package. + +7. C or perl subroutines supplied by you and linked into this Package shall not +be considered part of this Package. + +8. The name of the Copyright Holder may not be used to endorse or promote +products derived from this software without specific prior written permission. + +9. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED +WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF +MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + +The End diff --git a/MANIFEST b/MANIFEST new file mode 100644 index 0000000..311a07e --- /dev/null +++ b/MANIFEST @@ -0,0 +1,14 @@ +Build.PL +Changes +LICENSE +META.json +README.md +cpanfile +lib/Log/Dispatch/Gelf.pm +minil.toml +t/00_compile.t +t/01_log_format.t +t/02_socket.t +t/03_chunked.t +META.yml +MANIFEST \ No newline at end of file diff --git a/META.json b/META.json new file mode 100644 index 0000000..ab41287 --- /dev/null +++ b/META.json @@ -0,0 +1,88 @@ +{ + "abstract" : "Log::Dispatch plugin for Graylog's GELF format.", + "author" : [ + "Miroslav Tynovsky " + ], + "dynamic_config" : 0, + "generated_by" : "Minilla/v3.0.4", + "license" : [ + "perl_5" + ], + "meta-spec" : { + "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", + "version" : "2" + }, + "name" : "Log-Dispatch-Gelf", + "no_index" : { + "directory" : [ + "t", + "xt", + "inc", + "share", + "eg", + "examples", + "author", + "builder" + ] + }, + "prereqs" : { + "configure" : { + "requires" : { + "Module::Build::Tiny" : "0.035" + } + }, + "develop" : { + "requires" : { + "Test::CPAN::Meta" : "0", + "Test::MinimumVersion::Fast" : "0.04", + "Test::PAUSE::Permissions" : "0.04", + "Test::Pod" : "1.41", + "Test::Spellunker" : "v0.2.7" + } + }, + "runtime" : { + "recommends" : { + "JSON::XS" : "2.0" + }, + "requires" : { + "Log::Dispatch" : "0", + "Log::GELF::Util" : "0.90", + "Params::Validate" : "0", + "perl" : "5.010" + } + }, + "test" : { + "requires" : { + "JSON" : "0", + "Mock::Quick" : "1.107", + "Test::Exception" : "0.31", + "Test::More" : "0.98" + } + } + }, + "provides" : { + "Log::Dispatch::Gelf" : { + "file" : "lib/Log/Dispatch/Gelf.pm", + "version" : "v1.3.1" + } + }, + "release_status" : "stable", + "resources" : { + "bugtracker" : { + "web" : "https://github.com/avast/log-dispatch-gelf/issues" + }, + "homepage" : "https://github.com/avast/log-dispatch-gelf", + "repository" : { + "url" : "git://github.com/avast/log-dispatch-gelf.git", + "web" : "https://github.com/avast/log-dispatch-gelf" + } + }, + "version" : "1.3.1", + "x_contributors" : [ + "Jan Seidl ", + "Adam Clarke ", + "tynovsky ", + "Mohelníková Lucie " + ], + "x_serialization_backend" : "JSON::PP version 2.94" +} diff --git a/META.yml b/META.yml new file mode 100644 index 0000000..3f2e14c --- /dev/null +++ b/META.yml @@ -0,0 +1,50 @@ +--- +abstract: "Log::Dispatch plugin for Graylog's GELF format." +author: + - 'Miroslav Tynovsky ' +build_requires: + JSON: '0' + Mock::Quick: '1.107' + Test::Exception: '0.31' + Test::More: '0.98' +configure_requires: + Module::Build::Tiny: '0.035' +dynamic_config: 0 +generated_by: 'Minilla/v3.0.4, CPAN::Meta::Converter version 2.150010' +license: perl +meta-spec: + url: http://module-build.sourceforge.net/META-spec-v1.4.html + version: '1.4' +name: Log-Dispatch-Gelf +no_index: + directory: + - t + - xt + - inc + - share + - eg + - examples + - author + - builder +provides: + Log::Dispatch::Gelf: + file: lib/Log/Dispatch/Gelf.pm + version: v1.3.1 +recommends: + JSON::XS: '2.0' +requires: + Log::Dispatch: '0' + Log::GELF::Util: '0.90' + Params::Validate: '0' + perl: '5.010' +resources: + bugtracker: https://github.com/avast/log-dispatch-gelf/issues + homepage: https://github.com/avast/log-dispatch-gelf + repository: git://github.com/avast/log-dispatch-gelf.git +version: 1.3.1 +x_contributors: + - 'Jan Seidl ' + - 'Adam Clarke ' + - 'tynovsky ' + - 'Mohelníková Lucie ' +x_serialization_backend: 'CPAN::Meta::YAML version 0.018' diff --git a/README.md b/README.md new file mode 100644 index 0000000..74083be --- /dev/null +++ b/README.md @@ -0,0 +1,102 @@ +[![Build Status](https://travis-ci.org/avast/log-dispatch-gelf.svg?branch=master)](https://travis-ci.org/avast/log-dispatch-gelf) +# NAME + +Log::Dispatch::Gelf - Log::Dispatch plugin for Graylog's GELF format. + +# SYNOPSIS + + use Log::Dispatch; + + my $sender = ... # e.g. RabbitMQ queue. + my $log = Log::Dispatch->new( + outputs => [ + #some custom sender + [ + 'Gelf', + min_level => 'debug', + additional_fields => { facility => __FILE__ }, + send_sub => sub { $sender->send($_[0]) }, + ], + #or send to graylog via TCP/UDP socket + [ + 'Gelf', + min_level => 'debug', + additional_fields => { facility => __FILE__ }, + socket => { + host => 'graylog.server', + port => 21234, + protocol => 'tcp', + } + ] + ], + ); + $log->info('It works'); + + $log->log( + level => 'info', + message => "It works\nMore details.", + additional_fields => { test => 1 } + ); + +# DESCRIPTION + +Log::Dispatch::Gelf is a Log::Dispatch plugin which formats the log message +according to Graylog's GELF Format version 1.1. It supports sending via a +socket (TCP or UDP) or a user provided sender. + +# CONSTRUCTOR + +The constructor takes the following parameters in addition to the standard +parameters documented in [Log::Dispatch::Output](https://metacpan.org/pod/Log::Dispatch::Output): + +- additional\_fields + + optional hashref of additional fields of the gelf message (no need to prefix + them with \_, the prefixing is done automatically). + +- chunked + + optional scalar. An integer specifying the chunk size or the special + string values 'lan' or 'wan' corresponding to 8154 or 1420 respectively. + A zero chunk size means no chunking will be applied. + + Chunking is only applicable to UDP connections. + +- compress + + optional scalar. If a true value the message will be gzipped with + IO::Compress::Gzip. + +- send\_sub + + mandatory sub for sending the message to graylog. It is triggered after the + gelf message is generated. + +- socket + + optional hashref create tcp or udp (default behavior) socket and set + `send_sub` to sending via socket + +# METHODS + +## $log->log( level => $, message => $, additional\_fields => \\% ) + +In addition to the corresponding method in [Log::Dispatch::Output](https://metacpan.org/pod/Log::Dispatch::Output) this +subclassed method takes an optional hashref of additional\_fields for the +gelf message. As in the corresponding parameter on the constructor there is +no need to prefix them with an \_. If the same key appears in both the +constructor's and method's additional\_fields then the method's value will +take precedence overriding the constructor's value for the current call. + +The subclassed log method is still called with all parameters passed on. + +# LICENSE + +Copyright (C) Avast Software. + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +# AUTHOR + +Miroslav Tynovsky diff --git a/cpanfile b/cpanfile new file mode 100644 index 0000000..a4c11e3 --- /dev/null +++ b/cpanfile @@ -0,0 +1,14 @@ +requires 'perl', '5.010'; +requires 'Log::Dispatch'; +requires 'Log::GELF::Util', '>= 0.90'; +requires 'Params::Validate'; + +recommends 'JSON::XS', '2.0'; + +on 'test' => sub { + requires 'Test::More', '0.98'; + requires 'Mock::Quick', '1.107'; + requires 'Test::Exception', '0.31'; + requires 'JSON'; +}; + diff --git a/lib/Log/Dispatch/Gelf.pm b/lib/Log/Dispatch/Gelf.pm new file mode 100755 index 0000000..1a4737b --- /dev/null +++ b/lib/Log/Dispatch/Gelf.pm @@ -0,0 +1,268 @@ +package Log::Dispatch::Gelf; +use 5.010; +use strict; +use warnings; + +our $VERSION = '1.3.1'; + +use base qw(Log::Dispatch::Output); +use Params::Validate qw(validate SCALAR HASHREF CODEREF BOOLEAN); + +use Log::GELF::Util qw( + parse_size + compress + enchunk + encode +); +use Sys::Hostname; + +sub new { + my $proto = shift; + my $class = ref $proto || $proto; + + my $self = bless {}, $class; + + $self->_basic_init(@_); + $self->_init(@_); + + return $self; +} + +sub _init { + my $self = shift; + + Params::Validate::validation_options(allow_extra => 1); + my %p = validate( + @_, + { + send_sub => { type => CODEREF, optional => 1 }, + additional_fields => { type => HASHREF, optional => 1 }, + host => { type => SCALAR, optional => 1 }, + compress => { type => BOOLEAN, optional => 1 }, + chunked => { type => SCALAR, default => 0 }, + socket => { + type => HASHREF, + optional => 1, + callbacks => { + protocol_is_tcp_or_udp_or_default => sub { + my ($socket) = @_; + + $socket->{protocol} //= 'udp'; + die 'socket protocol must be tcp or udp' unless $socket->{protocol} =~ /^(?:tcp|udp)$/; + }, + host_must_be_set => sub { + my ($socket) = @_; + + die 'socket host must be set' unless exists $socket->{host} && length $socket->{host} > 0; + }, + port_must_be_number_or_default => sub { + my ($socket) = @_; + + $socket->{port} //= 12201; + die 'socket port must be integer' unless $socket->{port} =~ /^\d+$/; + }, + } + } + } + ); + + $p{chunked} = parse_size($p{chunked}); + + if (!defined $p{socket} && !defined $p{send_sub}) { + die 'Must be set socket or send_sub'; + } + + if ( defined $p{socket} + && defined $p{chunked} + && $p{socket}{protocol} ne 'udp' + ) { + die 'chunked only applicable to udp'; + } + + $self->{host} = $p{host} // hostname(); + $self->{additional_fields} = $p{additional_fields} // {}; + $self->{send_sub} = $p{send_sub}; + $self->{gelf_version} = '1.1'; + $self->{chunked} = $p{chunked}; + + if ($p{socket}) { + my $socket = $self->_create_socket($p{socket}); + + $self->{send_sub} = sub { + my ($msg) = @_; + + $msg = compress($msg) if $p{compress}; + $socket->send($_) foreach enchunk($msg, $self->{chunked}); + }; + } + + return; +} + +sub _create_socket { + my ($self, $socket_opts) = @_; + + require IO::Socket::INET; + my $socket = IO::Socket::INET->new( + PeerAddr => $socket_opts->{host}, + PeerPort => $socket_opts->{port}, + Proto => $socket_opts->{protocol}, + ) or die "Cannot create socket: $!"; + + return $socket; +} + +sub log_message { + my ($self, %p) = @_; + (my $short_message = $p{message}) =~ s/\n.*//s; + + my %additional_fields; + while (my ($key, $value) = each %{ $self->{additional_fields} }) { + $additional_fields{"_$key"} = $value; + } + + while (my ($key, $value) = each %{ $p{additional_fields} }) { + $additional_fields{"_$key"} = $value; + } + + my $log_unit = { + version => $self->{gelf_version}, + host => $self->{host}, + short_message => $short_message, + level => $p{level}, + full_message => $p{message}, + %additional_fields, + }; + + $self->{send_sub}->(encode($log_unit)); + + return; +} + +sub log { + my $self = shift; + + my %p = validate( + @_, { + additional_fields => { + type => HASHREF, + optional => 1, + }, + } + ); + + $self->SUPER::log(@_); +} + +1; +__END__ + +=encoding utf-8 + +=head1 NAME + +Log::Dispatch::Gelf - Log::Dispatch plugin for Graylog's GELF format. + +=head1 SYNOPSIS + + use Log::Dispatch; + + my $sender = ... # e.g. RabbitMQ queue. + my $log = Log::Dispatch->new( + outputs => [ + #some custom sender + [ + 'Gelf', + min_level => 'debug', + additional_fields => { facility => __FILE__ }, + send_sub => sub { $sender->send($_[0]) }, + ], + #or send to graylog via TCP/UDP socket + [ + 'Gelf', + min_level => 'debug', + additional_fields => { facility => __FILE__ }, + socket => { + host => 'graylog.server', + port => 21234, + protocol => 'tcp', + } + ] + ], + ); + $log->info('It works'); + + $log->log( + level => 'info', + message => "It works\nMore details.", + additional_fields => { test => 1 } + ); + +=head1 DESCRIPTION + +Log::Dispatch::Gelf is a Log::Dispatch plugin which formats the log message +according to Graylog's GELF Format version 1.1. It supports sending via a +socket (TCP or UDP) or a user provided sender. + +=head1 CONSTRUCTOR + +The constructor takes the following parameters in addition to the standard +parameters documented in L: + +=over + +=item additional_fields + +optional hashref of additional fields of the gelf message (no need to prefix +them with _, the prefixing is done automatically). + +=item chunked + +optional scalar. An integer specifying the chunk size or the special +string values 'lan' or 'wan' corresponding to 8154 or 1420 respectively. +A zero chunk size means no chunking will be applied. + +Chunking is only applicable to UDP connections. + +=item compress + +optional scalar. If a true value the message will be gzipped with +IO::Compress::Gzip. + +=item send_sub + +mandatory sub for sending the message to graylog. It is triggered after the +gelf message is generated. + +=item socket + +optional hashref create tcp or udp (default behavior) socket and set +C to sending via socket + +=back + +=head1 METHODS + +=head2 $log->log( level => $, message => $, additional_fields => \% ) + +In addition to the corresponding method in L this +subclassed method takes an optional hashref of additional_fields for the +gelf message. As in the corresponding parameter on the constructor there is +no need to prefix them with an _. If the same key appears in both the +constructor's and method's additional_fields then the method's value will +take precedence overriding the constructor's value for the current call. + +The subclassed log method is still called with all parameters passed on. + +=head1 LICENSE + +Copyright (C) Avast Software. + +This library is free software; you can redistribute it and/or modify +it under the same terms as Perl itself. + +=head1 AUTHOR + +Miroslav Tynovsky Etynovsky@avast.comE + +=cut diff --git a/minil.toml b/minil.toml new file mode 100644 index 0000000..aeee4e4 --- /dev/null +++ b/minil.toml @@ -0,0 +1,4 @@ +name = "Log-Dispatch-Gelf" +badges = ["travis"] +module_maker="ModuleBuildTiny" + diff --git a/t/00_compile.t b/t/00_compile.t new file mode 100644 index 0000000..2d04eaa --- /dev/null +++ b/t/00_compile.t @@ -0,0 +1,9 @@ +use strict; +use Test::More 0.98; + +use_ok $_ for qw( + Log::Dispatch::Gelf +); + +done_testing; + diff --git a/t/01_log_format.t b/t/01_log_format.t new file mode 100644 index 0000000..2197e00 --- /dev/null +++ b/t/01_log_format.t @@ -0,0 +1,80 @@ +use strict; +use Test::More; +use Test::Exception; + +use Log::Dispatch; +use JSON; + +my $LAST_LOG_MSG; + +my $log = Log::Dispatch->new( + outputs => [ [ + 'Gelf', + min_level => 'debug', + additional_fields => { facility => __FILE__ }, + send_sub => sub { $LAST_LOG_MSG = $_[0] }, + ] ], +); + +$log->info("It works\nMore details."); + +note "formatted message: $LAST_LOG_MSG"; + +my $msg = decode_json($LAST_LOG_MSG); +is($msg->{level}, 6, 'correct level info'); +is($msg->{short_message}, 'It works', 'short_message correct'); +is($msg->{full_message}, "It works\nMore details.", 'full_message correct'); +is($msg->{_facility}, __FILE__, 'facility correct'); +ok($msg->{host}, 'host is there'); +ok($msg->{timestamp}, 'timestamp is there'); +ok($msg->{version}, 'version is there'); + +dies_ok { + $log->log( + level => 'info', + message => "It works\nMore details.", + additional_fields => 'not a hashref' + ); +} +'additional_fields wrong type'; + +$log->log( + level => 'info', + message => "It works\nMore details.", + additional_fields => { additional => 1 } +); + +note "formatted message: $LAST_LOG_MSG"; + +$msg = decode_json($LAST_LOG_MSG); +is($msg->{level}, 6, 'correct level info'); +is($msg->{short_message}, 'It works', 'short_message correct'); +is($msg->{full_message}, "It works\nMore details.", 'full_message correct'); +is($msg->{_facility}, __FILE__, 'facility correct'); +is($msg->{_additional}, 1, 'additional log field correct'); +ok($msg->{host}, 'host is there'); +ok($msg->{timestamp}, 'timestamp is there'); +ok($msg->{version}, 'version is there'); + +$log->log( + level => 'info', + message => "It works\nMore details.", + additional_fields => { facility => 'override' } +); + +note "formatted message: $LAST_LOG_MSG"; + +$msg = decode_json($LAST_LOG_MSG); +is($msg->{_facility}, 'override', 'facility overridden correctly'); + +$log->log( + level => 'info', + message => "It works\nMore details.", +); + +note "formatted message: $LAST_LOG_MSG"; + +$msg = decode_json($LAST_LOG_MSG); +is($msg->{_facility}, __FILE__, 'override is temporary'); + +done_testing(18); diff --git a/t/02_socket.t b/t/02_socket.t new file mode 100755 index 0000000..0f740e1 --- /dev/null +++ b/t/02_socket.t @@ -0,0 +1,165 @@ +use strict; +use warnings; + +use Test::More; + +use Log::Dispatch; +use JSON; +use Test::Exception; +use Mock::Quick; +use IO::Uncompress::Gunzip qw(gunzip $GunzipError); + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', min_level => 'debug', + ] + ], + ); +} +qr/^Must be set socket or send_sub/, 'empty socket'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + 'socket' => {} + ] + ], + ); +} +qr/socket host must be set/, 'undefined socket host'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + 'socket' => { + host => '' + } + ] + ], + ); +} +qr/socket host must be set/, 'empty socket host'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + 'socket' => { + host => 'test', + port => 'x', + } + ] + ], + ); +} +qr/socket port must be integer/, 'invalid socket port'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + 'socket' => { + host => 'test', + port => '111111', + protocol => 'invalid', + } + ] + ], + ); +} +qr/socket protocol must be tcp or udp/, 'invalid protocol'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + 'socket' => { + host => 'test', + port => '111111', + protocol => 'xxx-udp', + } + ] + ], + ); +} +qr/socket protocol must be tcp or udp/, 'invalid protocol 2'; + +my $LAST_LOG_MSG; +my $class_inet = qclass( + -implement => 'IO::Socket::INET', + new => sub { + my ($obj, %options) = @_; + + is_deeply(\%options, { PeerAddr => 'test', PeerPort => 12201, Proto => 'udp' }, 'connect opts'); + + return bless {}, $obj; + }, + send => sub { + my ($self, $msg) = @_; + + $LAST_LOG_MSG = $msg; + } +); + +my $log = Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + socket => { + host => 'test', + } + ] + ], +); + +$log->info("It works\nMore details."); + +note("formatted message: $LAST_LOG_MSG"); + +my $msg = decode_json($LAST_LOG_MSG); +is($msg->{level}, 6, 'correct level info'); +is($msg->{short_message}, 'It works', 'short_message correct'); +is($msg->{full_message}, "It works\nMore details.", 'full_message correct'); + +$log = Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + compress => 1, + socket => { + host => 'test', + } + ] + ], +); + +$log->info("Compressed\nMore details."); + +my $output; +gunzip \$LAST_LOG_MSG => \$output + or die "gunzip failed: $GunzipError\n"; + +note("formatted message: $output"); + +$msg = decode_json($output); +is($msg->{level}, 6, 'correct level info'); +is($msg->{short_message}, 'Compressed', 'short_message correct'); +is($msg->{full_message}, "Compressed\nMore details.", 'full_message correct'); + +done_testing(14); diff --git a/t/03_chunked.t b/t/03_chunked.t new file mode 100644 index 0000000..5add65e --- /dev/null +++ b/t/03_chunked.t @@ -0,0 +1,162 @@ +use strict; +use warnings; + +use Test::More; + +use Log::Dispatch; +use Log::GELF::Util qw(dechunk decode_chunk uncompress); +use JSON; +use Test::Exception; +use Mock::Quick; +use IO::Uncompress::Gunzip qw(gunzip $GunzipError); + +my @ACCUMULATOR; +my $MESSAGE; +my $class_inet = qclass( + -implement => 'IO::Socket::INET', + new => sub { + my ($obj, %options) = @_; + @ACCUMULATOR = undef; + $MESSAGE = undef; + return bless {}, $obj; + }, + send => sub { + my ($self, $encoded_chunk) = @_; + + $MESSAGE = dechunk( + \@ACCUMULATOR, + decode_chunk($encoded_chunk) + ); + + $MESSAGE = uncompress($MESSAGE) if $MESSAGE; + + } +); + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + chunked => 'WAN', + 'socket' => { + host => 'test', + protocol => 'tcp', + } + ] + ], + ); +} +qr/chunked only applicable to udp/, 'invalid protocol for chunking'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + chunked => 'xxx', + 'socket' => { + host => 'test', + protocol => 'udp', + } + ] + ], + ); +} +qr/chunk size must be "lan", "wan", a positve integer, or 0 \(no chunking\)/, 'invalid chunked value'; + +throws_ok { + Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + chunked => '-1', + 'socket' => { + host => 'test', + protocol => 'udp', + } + ] + ], + ); +} +qr/chunk size must be "lan", "wan", a positve integer, or 0 \(no chunking\)/, 'invalid integer'; + +new_ok ( 'Log::Dispatch', [ + outputs => [ + [ + 'Gelf', + min_level => 'debug', + chunked => 'WAN', + socket => { + host => 'test', + } + ] + ] + ] +); + +new_ok ( 'Log::Dispatch', [ + outputs => [ + [ + 'Gelf', + min_level => 'debug', + chunked => 'lan', + socket => { + host => 'test', + } + ] + ] + ] +); + +my $log = Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + chunked => 4, + socket => { + host => 'test', + } + ] + ], +); + +$log->info("Uncompressed - chunked\nMore details."); + +note("formatted message: $MESSAGE"); + +my $msg = decode_json($MESSAGE); + +is($msg->{level}, 6, 'correct level info'); +is($msg->{short_message}, 'Uncompressed - chunked', 'short_message correct'); +is($msg->{full_message}, "Uncompressed - chunked\nMore details.", 'full_message correct'); + +$log = Log::Dispatch->new( + outputs => [ + [ + 'Gelf', + min_level => 'debug', + compress => 1, + chunked => 4, + socket => { + host => 'test', + } + ] + ], +); + +$log->info("Compressed - chunked\nMore details."); + +note("formatted message: $MESSAGE"); + +$msg = decode_json($MESSAGE); + +is($msg->{level}, 6, 'correct level info'); +is($msg->{short_message}, 'Compressed - chunked', 'short_message correct'); +is($msg->{full_message}, "Compressed - chunked\nMore details.", 'full_message correct'); + +done_testing(11);