gitpan / app-unicheck Goto Github PK

NAME
    App::Unicheck - Mini data collection framework!

VERSION
    Version 0.04

SYNOPSIS
    App::Unicheck is a mini framework to collect data. The main purpose was
    to provide a pluggable, easy to use systems data source with consistent
    interface that is independent from specific systems monitoring solutions
    but can still be used by them.

    On object construction all modules inside the App::Unicheck::Modules
    namespace are loaded and new() is called on them.

        use App::Unicheck;

        # create object and load modules
        my $unicheck = App::Unicheck->new;

ATTRIBUTES
  modules
    Hash reference containing all loaded modules with module names as keys
    and module instances as values.

        # print out loaded modules
        say for keys $unicheck->modules;

METHODS
  run
    Runs a check module's run() method with parameters.

        $unicheck->run($module, @params);

  info
    Show information on loaded modules. Calls the help() method of the
    modules and formats the output.

        # show info of all modules
        say $unicheck->info;

        # show info of specific module
        say $unicheck->info($module);

AUTHOR
    Matthias Krull, "<<m.krull at uninets.eu>>"

BUGS
    Please report any bugs or feature requests to "bug-app-unicheck at
    rt.cpan.org", or through the web interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-Unicheck>. I will
    be notified, and then you'll automatically be notified of progress on
    your bug as I make changes.

    Alternatively report bugs or feature requests at
    <https://github.com/uninets/App-Unicheck/issues>.

SUPPORT
    You can find documentation for this module with the perldoc command.

        perldoc App::Unicheck

    You can also look for information at:

    *   RT: CPAN's request tracker (report bugs here)

        <http://rt.cpan.org/NoAuth/Bugs.html?Dist=App-Unicheck>

    *   AnnoCPAN: Annotated CPAN documentation

        <http://annocpan.org/dist/App-Unicheck>

    *   CPAN Ratings

        <http://cpanratings.perl.org/d/App-Unicheck>

    *   Search CPAN

        <http://search.cpan.org/dist/App-Unicheck/>

    *   Github

        <https://github.com/uninets/App-Unicheck/>

ACKNOWLEDGEMENTS
LICENSE AND COPYRIGHT
    Copyright 2013 Matthias Krull.

    This program is free software; you can redistribute it and/or modify it
    under the terms of the the Artistic License (2.0). You may obtain a copy
    of the full license at:

    <http://www.perlfoundation.org/artistic_license_2_0>

    Any use, modification, and distribution of the Standard or Modified
    Versions is governed by this Artistic License. By using, modifying or
    distributing the Package, you accept this license. Do not use, modify,
    or distribute the Package, if you do not accept this license.

    If your Modified Version has been derived from a Modified Version made
    by someone other than you, you are nevertheless required to ensure that
    your Modified Version complies with the requirements of this license.

    This license does not grant you the right to use any trademark, service
    mark, tradename, or logo of the Copyright Holder.

    This license includes the non-exclusive, worldwide, free-of-charge
    patent license to make, have made, use, offer to sell, sell, import and
    otherwise transfer the Package with respect to any patent claims
    licensable by the Copyright Holder that are necessarily infringed by the
    Package. If you institute patent litigation (including a cross-claim or
    counterclaim) against any party alleging that the Package constitutes
    direct or contributory patent infringement, then this Artistic License
    to you shall terminate on the date that such litigation is filed.

    Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER
    AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES.
    THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
    PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY
    YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR
    CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR
    CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE,
    EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.