|
NAMEMooseX::Role::Loggable - Extensive, yet simple, logging role using Log::DispatchouliVERSIONversion 0.114SYNOPSISpackage My::Object; use Moose; # or Moo with 'MooseX::Role::Loggable'; sub do_this { my $self = shift; $self->set_prefix('[do_this] '); $self->log_debug('starting...'); ... $self->log_debug('more stuff'); $self->clear_prefix; } DESCRIPTIONThis is a role to provide logging ability to whoever consumes it using Log::Dispatchouli. Once you consume this role, you have attributes and methods for logging defined automatically.package MyObject; use Moose # Moo works too with 'MooseX::Role::Loggable'; sub run { my $self = shift; $self->log('Trying to do something'); # this only gets written if debug flag is on $self->log_debug('Some debugging output'); $self->log( { level => 'critical' }, 'Critical log message', ); $self->log_fatal('Log and die'); } This module uses Moo so it takes as little resources as it can by default, and can seamlessly work with both Moo or Moose. Propagating logging definitionsSometimes your objects create additional object which might want to log using the same settings. You can simply give them the same logger object.package Parent; use Moose; with 'MooseX::Role::Loggable'; has child => ( is => 'ro', isa => 'Child', lazy => 1, builder => '_build_child', ); sub _build_child { my $self = shift; return Child->new( logger => $self->logger ); } ATTRIBUTESdebugA boolean for whether you're in debugging mode or not.Default: no. Read-only. logger_facilityThe facility the logger would use. This is useful for syslog.Default: local6. logger_identThe ident the logger would use. This is useful for syslog.Default: calling object's class name. Read-only. log_to_fileA boolean that determines if the logger would log to a file.Default location of the file is in /tmp. Default: no. Read-only. log_to_stdoutA boolean that determines if the logger would log to STDOUT.Default: no. log_to_stderrA boolean that determines if the logger would log to STDERR.Default: no. log_fileThe leaf name for the log file.Default: undef log_pathThe path for the log file.Default: undef log_pidWhether to append the PID to the log filename.Default: yes log_fail_fatalWhether failure to log is fatal.Default: yes log_mutedWhether only fatals are logged.Default: no log_quiet_fatalFrom Log::Dispatchouli: 'stderr' or 'stdout' or an arrayref of zero, one, or both fatal log messages will not be logged to these.Default: stderr loggerA Log::Dispatchouli object.METHODSAll methods here are imported from Log::Dispatchouli. You can read its documentation to understand them better.has_log_fileDetermines if "log_file" was specified.has_log_pathDetermines if "log_path" was specified.logLog a message.log_debugLog a message only if in debug mode.log_fatalLog a message and die.set_debugSet the debug flag.clear_debugClear the debug flag.set_prefixSet a prefix for all next messages.clear_prefixClears the prefix for all next messages.set_mutedSets the mute property, which makes only fatal messages logged.clear_mutedClears the mute property.BUILDARGSYou shouldn't care about this. It takes care of propagating attributes from a given logger (if you provided one) to the attributes this role provides.log_fieldsDEPRECATED.Please pass the logger attribute instead: SomeObject->new( logger => $parent->logger ); DEBUGGINGOccassionally you might encounter the following error:no ident specified when using Log::Dispatchouli at Loggable.pm line 117. The problem does not stem from MooseX::Role::Loggable, but from a builder calling a logging method before the logger is built. Since Moo and Moose do not assure order of building attributes, some attributes might not yet exist by the time you need them. This specific error happens when the "ident" attribute isn't built by the time a builder runs. In order to avoid it, the attribute which uses the builder should be made lazy, and then called in the "BUILD" method. Here is an example: package Stuff; use Moose; with 'MooseX::Role::Logger'; has db => ( is => 'ro', lazy => 1, builder => '_build_db', } sub _build_db { my $self = shift; $self->log_debug('Building DB'); ... } sub BUILD { my $self = shift; $self->db; } This makes the "db" attribute non-lazy, but during run-time. This will assure that all the logging attributes are created before you build the "db" attribute and call "log_debug". AUTHORSawyer X <xsawyerx@cpan.org>COPYRIGHT AND LICENSEThis software is copyright (c) 2017 by Sawyer X.This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Visit the GSP FreeBSD Man Page Interface. |