- PLUGIN DEVELOPMENT
- SEE ALSO
- COPYRIGHT AND LICENSE
Log::Any::Plugin - Adapter-modifying plugins for Log::Any
use Log::Any::Adapter; use Log::Any::Plugin; # Create your adapter as normal Log::Any::Adapter->set( 'SomeAdapter' ); # Add plugin to modify its behaviour Log::Any::Plugin->add( 'Stringify' ); # Multiple plugins may be used together Log::Any::Plugin->add( 'Levels', level => 'debug' );
Log::Any::Plugin is a method for augmenting arbitrary instances of Log::Any::Adapters.
Log::Any::Plugins work much in the same manner as Moose 'around' modifiers to augment logging behaviour of pre-existing adapters.
Many of the Log::Any::Adapters have extended functionality, such as being able to selectively disable various log levels, or to handle multiple arguments.
In order for Log::Any to be truly 'any', only the common subset of adapter functionality can be used. Any specific adapter functionality must be avoided if there is a possibility of using a different adapter at a later date.
Log::Any::Plugins provide a method to augment adapters with missing functionality so that a superset of adapter functionality can be used.
This is the single method for adding plugins to adapters. It works in a similar function to Log::Any::Adapter->set()
The plugin class to add to the currently active adapter. If the class is in the Log::Any::Plugin:: namespace, you can simply specify the name, otherwise prefix a '+'.
These are plugin specific arguments. See the individual plugin documentation for what options are supported.
You must have cpanm installed.
On initial check out of the project, set-up the required dependencies as follows:
# Get dependencies dzil authordeps --missing | cpanm dzil listdeps --author | cpanm
Next run a basic test suite:
Install the necessary missed dependencies as needed via
cpanm and rerun tests till they execute successfully.
See the error logs as directed in the
A plugin's entry point is via its
install method which has the signature:
install($class, $adapter_class, %args)
$adapter_class is the Log::Any::Adapter adapter class to be used, e.g.
%args is a hash of arguments to configure or customise the plugin.
Plugins add new facilities or augment existing facilities, so it's hard to define confines of their scope. This module packages in several use-case driven plugins that may serve as examples — check the SEE ALSO section.
Once a plugin is implemented, and tests added, re-run the Setup Dependencies steps to get any new required dependencies.
Next, run the full suite of tests through a sequence of:
dzil test dzil test --author dzil test --release
Finally to remove any temporarily generated artifacts, run:
Thanks to Strategic Data for sponsoring the development of this module.
Stephen Thirlwall <email@example.com>
This software is copyright (c) 2019, 2017, 2016, 2015, 2014, 2013, 2011 by Stephen Thirlwall.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
José Joaquín Atria <firstname.lastname@example.org>
Kamal Advani <email@example.com>