Mojo::Log

Mojo::Log模块是Mojo项目的简单日志记录器。并且它是Mojo::EventEmitter的一个子类。

语法概要

use Mojo::Log 

# Log to STDERR
my $log = Mojo::Log->new;


# Customize log file location and minimum log level
my $log = Mojo::Log->new( path => '/var/log/mojo.log', level => 'warn');

# Log messages
$log->debug('Not sure what is happening here');
$log->info('FYI: it happened again');
$log->warn('This might be a problem');
$log->error('Garden variety error');
$log->fatal('Boom');

事件

Mojo::Log从Mojo::EventEmitter中继承了所有的事件，并实现了一个新的事件message。

$log->on(message => sub {
  my ($log, $level, @lines) = @_;
  ...
});

当有一个新的日志到达时会触发这个事件。

属性

Mojo::Log 拥有以下属性：format、handle、history、level、max_history_size、path、short。下面分别进行介绍。

format

my $cb = $log->format;
$log   = $log->format(sub {...});

用于对日志信息进行格式化的回调函数。

$log->format(sub {
  my ($time, $level, @lines) = @_;
  return "[Thu May 15 17:47:04 2014] [info] I ♥ Mojolicious\n";
});

handle

my $handle = $log->handle;
$log       = $log->handle(IO::Handle->new);

为默认的“message”事件写日志提供的写日志信息的文件句柄，默认情况下使用“path”属性或STDERR。

history

my $history = $log->history;
$log        = $log->history([[time, 'debug', 'That went wrong']]);

最新的N条日志记录。

level

my $level = $log->level;
$log      = $log->level('debug');

日志级别，默认为debug，可用的日志级别有：debug、info、warn、error、fatal；请注意MOJO_LOG_LEVEL环境变量可以覆盖默认的日志级别。

max_history_size

my $size = $log->max_history_size;
$log     = $log->max_history_size(5);

在“history”属性中记录的最大日志数据。

path

my $path = $log->path
$log     = $log->path('/var/log/mojo.log');

日志文件的路径，被“handle”属性使用得到日志文件的句柄。

short

my $bool = $log->short;
$log     = $log->short($bool);

生成没有时间戳的短日志信息，适用于systemd，默认值为环境变量MOJO_LOG_SHORT的值。

方法

Mojo::Log继承了Mojo::EventEmitter中的所有方法，并实现了以下方法。

append

$log->append("[Thu May 15 17:47:04 2014] [info] I ♥ Mojolicious\n");

添加日志信息到“handle”属性中。

debug

$log = $log->debug('You screwed up, but that is ok');
$log = $log->debug('All', 'cool');

触发“message”事件，并且记录“debug”级别的日志。

error

触发“message”事件，并且记录“error”级别的日志。

error

$log = $log->error('You really screwed up this time');
$log = $log->error('Wow', 'seriously');

触发“message”事件，并且记录“debug”级别的日志。

fatal

$log = $log->fatal('Its over...');
$log = $log->fatal('Bye', 'bye');

触发“message”事件，并且记录“fatal”级别的日志。

info

$log = $log->info('You are bad, but you prolly know already');
$log = $log->info('Ok', 'then');

触发“message”事件，并且记录“info”级别的日志。

is_level

my $bool = $log->is_level('debug');

检查日志的级别。

# True
$log->level('debug')->is_level('debug');
$log->level('debug')->is_level('info');

# False
$log->level('info')->is_level('debug');
$log->level('fatal')->is_level('warn');

当参数中的日志级别大于等于当前Mojo::Log对象的日志级别时返回true，否则返回false。

new

my $log = Mojo::Log->new;

构造一个新的日志对象，并使用默认的日志记录器事件"message"。

warn

$log = $log->warn('Dont do that Dave...');
$log = $log->warn('No', 'really');

触发“message”事件，并且记录“warn”级别的日志。