Log::Handler::Config - The main config loader.
use Log::Handler; my $log = Log::Handler->new(); # Config::General $log->config(config => 'file.conf'); # Config::Properties $log->config(config => 'file.props'); # YAML $log->config(config => 'file.yaml');
Or
use Log::Handler; my $log = Log::Handler->new(); $log->config( config => 'file.conf' plugin => 'YAML', );
This module makes it possible to load the configuration from a file. The configuration type is determined by the file extension. It's also possible to mix file extensions with another configuration types.
Plugin name File extensions ------------------------------------------ Config::General cfg, conf Config::Properties props, jcfg, jconf YAML yml, yaml
If the extension is not defined then Config::General is used by default.
Config::General
With this method it's possible to load the configuration for your outputs.
The following options are valid:
With this option you can pass a file name or the configuration as a hash reference.
$log->config(config => 'file.conf'); # or $log->config(config => \%config);
With this option it's possible to say which plugin you want to use. Maybe you want to use the file extension conf with YAML, which is reserved for the plugin Config::General.
conf
YAML
Examples:
# this would use Config::General $log->config( config => 'file.conf' ); # this would force .conf with YAML $log->config( config => 'file.conf', plugin => 'YAML' );
If you want to write the configuration into a global configuration file then you can create a own section for the logger:
<logger> <file> <mylog> filename = file.log minlevel = 0 maxlevel = 7 </mylog> </file> </logger> <another_script_config> foo = bar bar = baz baz = foo </another_script_config>
Now your configuration is placed in the logger section. You can load this section with
logger
$log->config( config => 'file.conf', section => 'logger', ); # or if you load the configuration yourself to %config $log->config( config => \%config, section => 'logger', ); # or just $log->config( config => $config{logger} );
Note that the section mylog is used as an alias. Later you access the output with
mylog
alias
my $file_output = $log->output('mylog'); $file_output->log(message => 'your message');
Config::General - inspired by the well known apache config format Config::Properties - Java-style property files YAML - optimized for human readability
For each output it must exist an own section. Here a example as hash:
my %config = ( # the configuration for a file file => { foo => { filename => 'file1.log', maxlevel => 'info', minlevel => 'warn', }, bar => { filename => 'file2.log', maxlevel => 'error', minlevel => 'emergency', } } # the configuration for email email => { baz => host => 'foo.example', from => 'me@me.example', to => 'you@foo.example', maxlevel => 'error', minlevel => 'emergency', }, # and_so_on ... } );
You can store your configuration to a file and loads it. There are different config plugins available.
It's possible to define a section called default for each output. This options are used as default if this options are not set. Example:
default
my %config = ( # the configuration for a file file => { default => { mode => 'append', }, foo => { filename => 'file1.log', maxlevel => 'info', minlevel => 'warn', }, bar => { filename => 'file2.log', maxlevel => 'error', minlevel => 'emergency', }, baz => { filename => 'file3.log', maxlevel => 'debug', minlevel => 'debug', mode => 'trunc', }, }, # the configuration for dbi dbi => { default => { ... } } );
The option mode is set to append for the log file file1.log and file2.log. The configuration for file3.log will be set to trunc.
mode
append
file1.log
file2.log
file3.log
trunc
<file> <mylog> fileopen = 1 reopen = 1 permissions = 0640 maxlevel = info minlevel = warn mode = append timeformat = %b %d %H:%M:%S debug_mode = 2 filename = example.log message_layout = '%T %H[%P] [%L] %S: %m' newline = 1 </mylog> </file>
--- file: mylog: debug_mode: 2 filename: example.log fileopen: 1 maxlevel: info minlevel: warn mode: append newline: 1 permissions: 0640 message_layout: '%T %H[%P] [%L] %S: %m' reopen: 1 timeformat: '%b %d %H:%M:%S'
file.mylog.reopen = 1 file.mylog.fileopen = 1 file.mylog.maxlevel = info file.mylog.minlevel = warn file.mylog.permissions = 0640 file.mylog.mode = append file.mylog.timeformat = %b %d %H:%M:%S file.mylog.debug_mode = 2 file.mylog.filename = example.log file.mylog.newline = 1 file.mylog.message_layout = '%T %H[%P] [%L] %S: %m'
The config (Config::General)
<output> <file> <default> newline = 1 permissions = 0640 timeformat = %b %d %H:%M:%S fileopen = 1 reopen = 1 mode = append message_layout = "%T %H[%P] [%L] %S: %m" debug_mode = 2 </default> <common> filename = example.log maxlevel = info minlevel = warn </common> <error> filename = example-error.log maxlevel = warn minlevel = emergency </error> <debug> filename = example-debug.log maxlevel = debug minlevel = debug </debug> </file> </output>
Load the config
$log->config( config => 'file.conf', section => 'output', );
<file> <default> newline = 1 permissions = 0640 timeformat = %b %d %H:%M:%S fileopen = 1 reopen = 1 mode = append message_layout = "%T %H[%P] [%L] %S: $m" debug_mode = 2 </default> <common> filename = example.log maxlevel = info minlevel = warn </common> <error> filename = example-error.log maxlevel = warn minlevel = emergency </error> <debug> filename = example-debug.log maxlevel = debug minlevel = debug </debug> </file>
$log->config(config => 'file.conf');
$log->config( config => { file => { default => { newline => 1, permissions => '0640', timeformat => '%b %d %H:%M:%S', fileopen => 1, reopen => 1, mode => 'append', message_layout => '%T %H[%P] [%L] %S: %m', debug_mode => 2, }, common => { filename => 'example.log', maxlevel => 'info', minlevel => 'warn', }, error => { filename => 'example-error.log', maxlevel => 'warn', minlevel => 'emergency', }, debug => { filename => 'example-debug.log', maxlevel => 'debug', minlevel => 'debug', } } } );
<output> <file> <default> newline = 1 permissions = 0640 timeformat = %b %d %H:%M:%S fileopen = 1 reopen = 1 mode = append message_layout = "%T %H[%P] [%L] %S: %m" debug_mode = 2 </default> <common> filename = example.log maxlevel = info minlevel = warn </common> <error> filename = example-error.log maxlevel = warn minlevel = emergency </error> </file> </output>
Carp Params::Validate UNIVERSAL::require
No exports.
Please report all bugs to <jschulz.cpan(at)bloonix.de>.
If you send me a mail then add Log::Handler into the subject.
Jonny Schulz <jschulz.cpan(at)bloonix.de>.
Copyright (C) 2007 by Jonny Schulz. All rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install Log::Handler, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Log::Handler
CPAN shell
perl -MCPAN -e shell install Log::Handler
For more information on module installation, please visit the detailed CPAN module installation guide.