Log-Dispatch-Configurator-Any-1.122640000755001750001750 012026606412 17376 5ustar00oliveroliver000000000000README100644001750001750 1070112026606412 20356 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640NAME Log::Dispatch::Configurator::Any - Configurator implementation with Config::Any VERSION version 1.122640 PURPOSE Use this module in combination with Log::Dispatch::Config to allow many formats of configuration file to be loaded, via the Config::Any module. SYNOPSIS In the traditional Log::Dispatch::Config way: use Log::Dispatch::Config; # loads Log::Dispatch use Log::Dispatch::Configurator::Any; my $config = Log::Dispatch::Configurator::Any->new('log.yml'); Log::Dispatch::Config->configure($config); # nearby piece of code my $log = Log::Dispatch::Config->instance; $log->alert('Hello, world!'); Alternatively, without a config file on disk: use Log::Dispatch::Config; # loads Log::Dispatch use Log::Dispatch::Configurator::Any; my $confhash = { dispatchers => ['screen]', screen = { class => 'Log::Dispatch::Screen', min_level => 'debug', }, }; my $config = Log::Dispatch::Configurator::Any->new($confhash); Log::Dispatch::Config->configure($config); # nearby piece of code my $log = Log::Dispatch::Config->instance; $log->alert('Hello, world!'); DESCRIPTION Log::Dispatch::Config is a wrapper for Log::Dispatch and provides a way to configure Log::Dispatch objects with configuration files. Somewhat like a lite version of log4j and Log::Log4perl it allows multiple log destinations. The standard configuration file format for Log::Dispatch::Config is AppConfig. This module plugs in to Log::Dispatch::Config and allows the use of other file formats, in fact any format supported by the Config::Any module. As a bonus you can also pass in a configuration data structure instead of a file name. USAGE Follow the examples in the "SYNOPSIS". If you are using an external configuration file, be aware that you are required to use a filename extension (e.g. ".yml" for YAML). Below are a couple of tips and tricks you may find useful. Fall-back default config Being able to use a configuration data structre instead of a file on disk is handy when you want to provide application defaults which the user then replaces with their own settings. For example you could have the following: my $defaults = { dispatchers => ['screen'], screen => { class => 'Log::Dispatch::Screen', min_level => 'debug', }, }; my $config_file = '/etc/myapp_logging.conf'; my $config = $ENV{MYAPP_LOGGING_CONFIG} || $ARGV[0] || ( -e $config_file ? $config_file : $defaults); Log::Dispatch::Config->configure_and_watch( Log::Dispatch::Configurator::Any->new($config) ); my $dispatcher = Log::Dispatch::Config->instance; With the above code, your application will check for a filename in an environment variable, then a filename as a command line argument, then check for a file on disk, and finally use its built-in defaults. Dealing with a "dispatchers" list Log::Dispatch::Config requires that a global setting "dispatchers" have a list value (i.e. your list of dispatchers). A few config file formats do not support list values at all, or list values at the global level (two examples being Config::Tiny and Config::General). This module allows you to have a small grace when there is only one dispatcher in use. Write the configuration file normally, and the single-item "dispatchers" value will automatically be promoted to a list. In other words: # myapp.ini dispatchers = screen # this becomes a config of: $config = { dispatchers => 'screen', ... }; # so this module promotes it to: $config = { dispatchers => ['screen'], ... }; If you want more than one dispatcher, you then need to use a config file format which supports these lists natively, I'm afraid. A good suggestion might be YAML. THANKS My thanks to "miyagawa" for writing Log::Dispatch::Config, from where I also took some tests. Also thanks to Florian Merges for his YAML Configurator, which was a useful example and saved me much time. AUTHOR Oliver Gorwits COPYRIGHT AND LICENSE This software is copyright (c) 2012 by University of Oxford. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. Changes100644001750001750 276612026606412 20765 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.1226401.122640 2012-09-20 13:33:11 Europe/London * Remove YAML::XS dependency from requirements 1.122530 2012-09-09 16:05:25 Europe/London * POD fix * Use YAML::XS instead of YAML::Tiny for test 1.110690 2011-03-10 20:22:36 Europe/London * port to Dist::Zilla * add dependency on Log::Dispatch 2.23 (rt.cpan #49103) liblog-dispatch-configurator-any-perl (1.0005) UNRELEASED; urgency=low * Set min version of Config::Any to 0.15 so we get flatten_to_hash, use_ext -- Oliver Gorwits Tue, 28 Jul 2009 12:02:55 +0100 liblog-dispatch-configurator-any-perl (1.0004) UNRELEASED; urgency=low * stupid-head, I had flatten_to_hash on but was still checking for ARRAY * fixes to test plans, and YAML::Tiny tests skip if missing -- Oliver Gorwits Mon, 13 Apr 2009 02:14:45 +0100 liblog-dispatch-configurator-any-perl (1.0003) UNRELEASED; urgency=low * Fix MANIFEST to include test config files -- Oliver Gorwits Sat, 27 Dec 2008 12:41:05 +0000 liblog-dispatch-configurator-any-perl (1.0002) UNRELEASED; urgency=low * Fix to ptee docs so the YAML is actually valid YAML * Add examples dir with that YAML config * Add THANKS section to pod -- Oliver Gorwits Fri, 26 Dec 2008 21:50:40 +0000 liblog-dispatch-configurator-any-perl (1.0001) UNRELEASED; urgency=low * Initial release. -- Oliver Gorwits Fri, 26 Dec 2008 16:08:31 +0000 t000755001750001750 012026606412 17562 5ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640pod.t100644001750001750 21412026606412 20646 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/t#!perl -T use Test::More; eval "use Test::Pod 1.14"; plan skip_all => "Test::Pod 1.14 required for testing POD" if $@; all_pod_files_ok(); LICENSE100644001750001750 4373012026606412 20513 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640This software is copyright (c) 2012 by University of Oxford. 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) 2012 by University of Oxford. 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, Fifth Floor, Boston, MA 02110-1301 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) 2012 by University of Oxford. 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 META.yml100644001750001750 153012026606412 20727 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640--- abstract: 'Configurator implementation with Config::Any' author: - 'Oliver Gorwits ' build_requires: Config::Tiny: 0 Log::Dispatch::Config: 0 Test::More: 0 configure_requires: ExtUtils::MakeMaker: 6.30 dynamic_config: 0 generated_by: 'Dist::Zilla version 4.200013, CPAN::Meta::Converter version 2.112150' license: perl meta-spec: url: http://module-build.sourceforge.net/META-spec-v1.4.html version: 1.4 name: Log-Dispatch-Configurator-Any requires: Carp: 0 Config::Any: 0.15 Log::Dispatch: 2.23 Log::Dispatch::Configurator: 0 Sys::Syslog: 0.25 resources: bugtracker: https://rt.cpan.org/Public/Dist/Display.html?Name=Log-Dispatch-Configurator-Any homepage: https://github.com/ollyg/Log-Dispatch-Configurator-Any/wiki repository: git://github.com/ollyg/Log-Dispatch-Configurator-Any.git version: 1.122640 MANIFEST100644001750001750 42212026606412 20566 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640Changes LICENSE MANIFEST META.json META.yml Makefile.PL README examples/ptee.yml lib/Log/Dispatch/Configurator/Any.pm script/ptee t/10-load.t t/20-file.t t/21-not-hashref-in-file.t t/30-hashref.t t/31-not-hashref.t t/cfg_file.ini t/cfg_file_bad.yml t/pod-coverage.t t/pod.t META.json100644001750001750 271512026606412 21105 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640{ "abstract" : "Configurator implementation with Config::Any", "author" : [ "Oliver Gorwits " ], "dynamic_config" : 0, "generated_by" : "Dist::Zilla version 4.200013, CPAN::Meta::Converter version 2.112150", "license" : [ "perl_5" ], "meta-spec" : { "url" : "http://search.cpan.org/perldoc?CPAN::Meta::Spec", "version" : "2" }, "name" : "Log-Dispatch-Configurator-Any", "prereqs" : { "configure" : { "requires" : { "ExtUtils::MakeMaker" : "6.30" } }, "runtime" : { "requires" : { "Carp" : 0, "Config::Any" : "0.15", "Log::Dispatch" : "2.23", "Log::Dispatch::Configurator" : 0, "Sys::Syslog" : "0.25" } }, "test" : { "requires" : { "Config::Tiny" : 0, "Log::Dispatch::Config" : 0, "Test::More" : 0 } } }, "release_status" : "stable", "resources" : { "bugtracker" : { "web" : "https://rt.cpan.org/Public/Dist/Display.html?Name=Log-Dispatch-Configurator-Any" }, "homepage" : "https://github.com/ollyg/Log-Dispatch-Configurator-Any/wiki", "repository" : { "type" : "git", "url" : "git://github.com/ollyg/Log-Dispatch-Configurator-Any.git", "web" : "https://github.com/ollyg/Log-Dispatch-Configurator-Any" } }, "version" : "1.122640" } script000755001750001750 012026606412 20623 5ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640ptee100644001750001750 605212026606412 21646 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/script#!/usr/bin/perl use strict; use warnings FATAL => 'all'; use Log::Dispatch::Config; use Log::Dispatch::Configurator::Any; our $VERSION = '1.0003'; $VERSION = eval $VERSION; # numify for warning-free dev releases # $Id$ my $defaults = { dispatchers => ['screen'], screen => { class => 'Log::Dispatch::Screen', min_level => 'debug', max_level => 'emergency', stderr => 0, }, }; my $config_file = '/etc/ptee.yml'; my $config = $ENV{PTEE_CONFIG} || $ARGV[0] || ( -e $config_file ? $config_file : $defaults); Log::Dispatch::Config->configure_and_watch( Log::Dispatch::Configurator::Any->new($config) ); my $dispatcher = Log::Dispatch::Config->instance; $| = 1; while (<>) { $dispatcher->notice($_); } exit 0; __END__ =head1 NAME ptee - multicast your logs =head1 VERSION This document refers to version 1.0003 of ptee =head1 PURPOSE Use this program somewhat like the unix tee(1) command, to send text input to multiple destinations, for example a log file, Syslog, and so on. =head1 DESCRIPTION The unix tee(1) command accepts text on standard input, and emits that same text back out on standard output whilst also appending it to a log file. This program is similar, but more flexible, in that you can specify other destinations, and have as many as you like. By default it operates in pass-through mode; text received is simply emitted straight back out on standard output. =head1 USAGE Configuration is provided in the format used by the Perl module L. This is a wrapper around the excellent L perl module, which is the tool that provides all your output destinations. The best thing to do is read the manual page for these two modules - don't worry they are not complicated. Once you have done that, you can write your own configuration file. You can use many different formats of configuration file. Please read the L Perl module manual for more details. Here is a simple example which will emit logs to standard output and a file, much like the unix utility tee(1): dispatchers : [file, screen] file: class : 'Log::Dispatch::File' min_level : debug filename : '/path/to/log' mode : append format : '[%d] [%p] %m at %F line %L%n' screen: class : 'Log::Dispatch::Screen' min_level : info stderr : 1 format : '%m' The above file is in YAML format, a good choice, and so if you save this as C it will be loaded and used. Alternatively, you can specify the file name in the C environment variable, or as the first command line parameter to C itself. This gives you the ability to use a different file format, but please read the manual page for the L Perl module in that case to avoid a couple of minor pitfalls. =head1 AUTHOR Oliver Gorwits C<< >> =head1 COPYRIGHT & LICENSE Copyright (c) The University of Oxford 2008. This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut 20-file.t100644001750001750 110612026606412 21243 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/tuse strict; use Test::More tests => 3; use Log::Dispatch::Config; use Log::Dispatch::Configurator::Any; SKIP: { eval { require Config::Tiny }; skip 'no Config::Tiny installed', 3 if $@; my $cfg_file = 't/cfg_file.ini'; ok(-f $cfg_file, "Config exists"); my $config = Log::Dispatch::Configurator::Any->new($cfg_file); isa_ok($config, 'Log::Dispatch::Configurator::Any'); Log::Dispatch::Config->configure($config); { my $disp = Log::Dispatch::Config->instance; isa_ok $disp->{outputs}->{syslog}, 'Log::Dispatch::Syslog'; } } 10-load.t100644001750001750 20212026606412 21216 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/t#!/usr/bin/env perl use strict; use warnings; use Test::More tests => 1; BEGIN { use_ok( 'Log::Dispatch::Configurator::Any' ); } Makefile.PL100644001750001750 234612026606412 21436 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640 use strict; use warnings; use ExtUtils::MakeMaker 6.30; my %WriteMakefileArgs = ( 'ABSTRACT' => 'Configurator implementation with Config::Any', 'AUTHOR' => 'Oliver Gorwits ', 'BUILD_REQUIRES' => { 'Config::Tiny' => '0', 'Log::Dispatch::Config' => '0', 'Test::More' => '0' }, 'CONFIGURE_REQUIRES' => { 'ExtUtils::MakeMaker' => '6.30' }, 'DISTNAME' => 'Log-Dispatch-Configurator-Any', 'EXE_FILES' => [], 'LICENSE' => 'perl', 'NAME' => 'Log::Dispatch::Configurator::Any', 'PREREQ_PM' => { 'Carp' => '0', 'Config::Any' => '0.15', 'Log::Dispatch' => '2.23', 'Log::Dispatch::Configurator' => '0', 'Sys::Syslog' => '0.25' }, 'VERSION' => '1.122640', 'test' => { 'TESTS' => 't/*.t' } ); unless ( eval { ExtUtils::MakeMaker->VERSION(6.56) } ) { my $br = delete $WriteMakefileArgs{BUILD_REQUIRES}; my $pp = $WriteMakefileArgs{PREREQ_PM}; for my $mod ( keys %$br ) { if ( exists $pp->{$mod} ) { $pp->{$mod} = $br->{$mod} if $br->{$mod} > $pp->{$mod}; } else { $pp->{$mod} = $br->{$mod}; } } } delete $WriteMakefileArgs{CONFIGURE_REQUIRES} unless eval { ExtUtils::MakeMaker->VERSION(6.52) }; WriteMakefile(%WriteMakefileArgs); cfg_file.ini100644001750001750 16312026606412 22141 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/tdispatchers = syslog [syslog] class = Log::Dispatch::Syslog min_level = debug facility = local6 ident = conntrack 30-hashref.t100644001750001750 112112026606412 21742 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/tuse strict; use Test::More tests => 2; use Log::Dispatch::Config; use Log::Dispatch::Configurator::Any; my $defaults = { dispatchers => ['screen'], screen => { class => 'Log::Dispatch::Screen', min_level => 'debug', max_level => 'emergency', stderr => 0, }, }; my $config = Log::Dispatch::Configurator::Any->new($defaults); isa_ok($config, 'Log::Dispatch::Configurator::Any'); Log::Dispatch::Config->configure($config); { my $disp = Log::Dispatch::Config->instance; isa_ok $disp->{outputs}->{screen}, 'Log::Dispatch::Screen'; } pod-coverage.t100644001750001750 31612026606412 22442 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/t#!perl -T use Test::More; eval "use Test::Pod::Coverage 1.04"; plan skip_all => "Test::Pod::Coverage 1.04 required for testing POD coverage" if $@; all_pod_coverage_ok( {also_private => [ qr/./, ]} ); examples000755001750001750 012026606412 21135 5ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640ptee.yml100644001750001750 41312026606412 22733 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/examplesdispatchers : [file, screen] file: class : 'Log::Dispatch::File' min_level : debug filename : '/path/to/log' mode : append format : '[%d] [%p] %m at %F line %L%n' screen: class : 'Log::Dispatch::Screen' min_level : info stderr : 1 format : '%m' 31-not-hashref.t100644001750001750 65012026606412 22527 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/tuse strict; use Test::More tests => 1; use Log::Dispatch::Config; use Log::Dispatch::Configurator::Any; my $defaults = [ dispatchers => ['screen'], screen => { class => 'Log::Dispatch::Screen', min_level => 'debug', max_level => 'emergency', stderr => 0, }, ]; eval{ Log::Dispatch::Configurator::Any->new($defaults) }; like($@, qr/Config must be hashref or filename/); cfg_file_bad.yml100644001750001750 2212026606412 22743 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/t- foo - bar - baz 21-not-hashref-in-file.t100644001750001750 62412026606412 24050 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/tuse strict; use Test::More tests => 2; use Log::Dispatch::Config; use Log::Dispatch::Configurator::Any; SKIP: { eval { require YAML::XS }; skip 'no YAML::XS installed', 2 if $@; my $cfg_file = 't/cfg_file_bad.yml'; ok(-f $cfg_file, "Config exists"); eval{ Log::Dispatch::Configurator::Any->new($cfg_file) }; like($@, qr/does not build a Hash/, 'does not build a Hash'); } Configurator000755001750001750 012026606412 25007 5ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/lib/Log/DispatchAny.pm100644001750001750 1352212026606412 26257 0ustar00oliveroliver000000000000Log-Dispatch-Configurator-Any-1.122640/lib/Log/Dispatch/Configuratorpackage Log::Dispatch::Configurator::Any; { $Log::Dispatch::Configurator::Any::VERSION = '1.122640'; } use strict; use warnings FATAL => 'all'; use base 'Log::Dispatch::Configurator'; use Config::Any; use Carp; sub new { my($class, $file) = @_; my $self = {}; # allow passing of hashref or filename if (ref $file) { croak "Config must be hashref or filename" if ref $file ne 'HASH'; $self = bless { file => undef, _config => $file }, $class; } else { $self = bless { file => $file }, $class; $self->parse_file; } return bless $self, $class; } sub parse_file { my $self = shift; my $file = $self->{'file'}; my $config = eval{ Config::Any->load_files({ files => [$file], use_ext => 1, flatten_to_hash => 1, })->{$file} }; croak "Config '$file' does not build a Hash" if $@ or (ref $config ne 'HASH'); $self->{'_config'} = $config; } sub reload { my $self = shift; return if !defined $self->{file}; $self->parse_file; } sub get_attrs_global { my $self = shift; my $attrs; foreach (keys %{$self->{_config}}) { next if ref $self->{'_config'}->{$_} eq 'HASH'; $attrs->{$_} = $self->{'_config'}->{$_}; } # fix for Config::General squashing single item list to a scalar $attrs->{dispatchers} = [$attrs->{dispatchers}] if ! ref $attrs->{dispatchers}; return $attrs; } sub get_attrs { my($self, $name) = @_; return $self->{'_config'}->{$name}; } 1; # ABSTRACT: Configurator implementation with Config::Any __END__ =pod =head1 NAME Log::Dispatch::Configurator::Any - Configurator implementation with Config::Any =head1 VERSION version 1.122640 =head1 PURPOSE Use this module in combination with L to allow many formats of configuration file to be loaded, via the L module. =head1 SYNOPSIS In the traditional Log::Dispatch::Config way: use Log::Dispatch::Config; # loads Log::Dispatch use Log::Dispatch::Configurator::Any; my $config = Log::Dispatch::Configurator::Any->new('log.yml'); Log::Dispatch::Config->configure($config); # nearby piece of code my $log = Log::Dispatch::Config->instance; $log->alert('Hello, world!'); Alternatively, without a config file on disk: use Log::Dispatch::Config; # loads Log::Dispatch use Log::Dispatch::Configurator::Any; my $confhash = { dispatchers => ['screen]', screen = { class => 'Log::Dispatch::Screen', min_level => 'debug', }, }; my $config = Log::Dispatch::Configurator::Any->new($confhash); Log::Dispatch::Config->configure($config); # nearby piece of code my $log = Log::Dispatch::Config->instance; $log->alert('Hello, world!'); =head1 DESCRIPTION L is a wrapper for L and provides a way to configure Log::Dispatch objects with configuration files. Somewhat like a lite version of log4j and L it allows multiple log destinations. The standard configuration file format for Log::Dispatch::Config is AppConfig. This module plugs in to Log::Dispatch::Config and allows the use of other file formats, in fact any format supported by the L module. As a bonus you can also pass in a configuration data structure instead of a file name. =head1 USAGE Follow the examples in the L. If you are using an external configuration file, be aware that you are required to use a filename extension (e.g. C<.yml> for YAML). Below are a couple of tips and tricks you may find useful. =head2 Fall-back default config Being able to use a configuration data structre instead of a file on disk is handy when you want to provide application defaults which the user then replaces with their own settings. For example you could have the following: my $defaults = { dispatchers => ['screen'], screen => { class => 'Log::Dispatch::Screen', min_level => 'debug', }, }; my $config_file = '/etc/myapp_logging.conf'; my $config = $ENV{MYAPP_LOGGING_CONFIG} || $ARGV[0] || ( -e $config_file ? $config_file : $defaults); Log::Dispatch::Config->configure_and_watch( Log::Dispatch::Configurator::Any->new($config) ); my $dispatcher = Log::Dispatch::Config->instance; With the above code, your application will check for a filename in an environment variable, then a filename as a command line argument, then check for a file on disk, and finally use its built-in defaults. =head2 Dealing with a C list L requires that a global setting C have a list value (i.e. your list of dispatchers). A few config file formats do not support list values at all, or list values at the global level (two examples being L and L). This module allows you to have a small grace when there is only one dispatcher in use. Write the configuration file normally, and the single-item C value will automatically be promoted to a list. In other words: # myapp.ini dispatchers = screen # this becomes a config of: $config = { dispatchers => 'screen', ... }; # so this module promotes it to: $config = { dispatchers => ['screen'], ... }; If you want more than one dispatcher, you then need to use a config file format which supports these lists natively, I'm afraid. A good suggestion might be YAML. =head1 THANKS My thanks to C for writing Log::Dispatch::Config, from where I also took some tests. Also thanks to Florian Merges for his YAML Configurator, which was a useful example and saved me much time. =head1 AUTHOR Oliver Gorwits =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2012 by University of Oxford. This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =cut