Log::Any::Adapter::Development - Manual for developing new Log::Any adapters |
Log::Any::Adapter::Development - Manual for developing new Log::Any adapters
version 1.040
The adapter module:
package Log::Any::Adapter::YAL; use strict; use warnings; use Log::Any::Adapter::Util (); use base qw(Log::Any::Adapter::Base);
# Optionally initialize object, e.g. for delegation # sub init { my ($self) = @_;
$self->{attr} = ...; }
# Create logging methods: debug, info, etc. # foreach my $method ( Log::Any::Adapter::Util::logging_methods() ) { no strict 'refs'; *$method = sub { ... }; }
# Create detection methods: is_debug, is_info, etc. # foreach my $method ( Log::Any::Adapter::Util::detection_methods() ) { no strict 'refs'; *$method = sub { ... }; }
and the application:
Log::Any->set_adapter('YAL');
This document describes how to implement a new Log::Any adapter.
The easiest way to start is to look at the source of existing adapters, such as Log::Any::Adapter::Log4perl and Log::Any::Adapter::Dispatch.
If you are going to publicly release your adapter, call it 'Log::Any::Adapter::something' so that users can use it with
Log::Any->set_adapter(I<something>);
If it's an internal driver, you can call it whatever you like and use it like
Log::Any->set_adapter('+My::Log::Adapter');
All adapters must directly or indirectly inherit from the Log::Any::Adapter::Base manpage.
Log::Any supports the following log levels:
If the logging mechanism used by your adapter supports different levels, it's your responsibility to map them appropriately when you implement the logging and detection methods described below. For example, if your mechanism only supports ``debug'', ``normal'' and ``fatal'' levels, you might map the levels like this:
The constructor (new
) is provided by
Log::Any::Adapter::Base. It will:
At this point, overriding the default constructor is not supported. Hopefully it will not be needed.
The constructor is called whenever a log object is requested. e.g. If the application initializes Log::Any like so:
Log::Any->set_adapter('Log::YAL', yal_object => $yal, depth => 3);
and then a class requests a logger like so:
package Foo; use Log::Any qw($log);
Then $log
will be populated with the return value of:
Log::Any::Adapter::Yal->new(yal_object => $yal, depth => 3, category => 'Foo');
This is memoized, so if the same category should be requested again (e.g.
through a separate get_logger
call, the same object will be returned.
Therefore, you should try to avoid anything non-deterministic in your init
function.
The following methods have no default implementation, and MUST be defined by your subclass:
These methods must log a message at the specified level.
To help generate these methods programmatically, you can get a list of the sub names with the Log::Any::Adapter::Util::logging_methods function.
The following methods have no default implementation, and MUST be defined by your subclass:
These methods must return a boolean indicating whether the specified level is active, i.e. whether the adapter is listening for messages of that level.
To help generate these methods programmatically, you can get a list of the sub names with the Log::Any::Adapter::Util::detection_methods function.
Aliases (e.g. ``err'' for ``error'') are handled by the Log::Any::Proxy manpage and will call the corresponding real name in your adapter class. You do not need to implement them in your adapter.
The following methods have no default implementation but MAY be provided by your subclass:
init
to create a logging object for delegation, or open a file
or socket, etc.
The following the Log::Any::Adapter::Base manpage method may be useful for defining adapters via delegation:
$method
by calling $adapter_method
on the object
contained in $self->{$slot}
.
See the Log::Any::Adapter::Dispatch manpage and the Log::Any::Adapter::Log4perl manpage for examples of usage.
The following the Log::Any::Adapter::Util manpage functions give you a list of methods that you need to implement. You can get logging methods, detection methods or both:
This software is copyright (c) 2014 by Jonathan Swartz and David Golden.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
Log::Any::Adapter::Development - Manual for developing new Log::Any adapters |