/ 
Monitis-0.9
River stage zero No dependents
/ Monitis::LoadAverage

NAME

Monitis::LoadAverage - Predefined internal load average monitors manipulation

SYNOPSIS

use Monitis::LoadAverage;

DESCRIPTION

ATTRIBUTES

Monitis::LoadAverage implements following attributes:

METHODS

Monitis::LoadAverage implements following methods:

add

my $response = $api->load_average->add(
    agentkey => 'test_agent',
    limit1   => 8.2,
    limit5   => 9.3,
    limit15  => 9.5,
    name     => 'test from api',
    tag      => 'test'
);

Create monitor.

Mandatory parameters:

agentkey limit1 limit5 limit15 name tag

Normal response is:

{   "data"   => {"testId" => 922},
    "status" => "ok"
}

edit

my $response = $api->load_average->edit(
    testId  => 922,
    limit1  => 4.2,
    limit5  => 5.3,
    limit15 => 7.5,
    name    => 'test from api',
    tag     => 'test'
);

Edit monitor.

Mandatory parameters:

testId limit1 limit5 limit15 name tag

Normal response is:

{"status" => "ok"}

get

my $response = $api->load_average->get(agentId => 922);

Get monitor details.

Mandatory parameters:

agentId

Response:

{   "id"         => 1588,
    "name"       => "load_test",
    "tag"        => "Default",
    "ip"         => "126.158.210.31",
    "maxLimit1"  => 5.0,
    "maxLimit5"  => 5.0,
    "maxLimit15" => 5.0
}

get_info

my $response = $api->load_average->get_info(monitorId => 922);

Get monitor info.

Mandatory parameters:

monitorId

Response:

See L<http://monitis.com/api/api.html#getDriveMonitorInfo>

get_results

my $response = $api->load_average->get_result(
    monitorId => 922,
    day       => 1,
    month     => 5,
    year      => 2011
);

Get monitor result.

Mandatory parameters:

monitorId day month year

Optional parameters:

timezone

Normal response is:

[   {   "time"     => "00 => 10",
        "result1"  => 5.0,
        "result5"  => 8.3,
        "result15" => 10.1,
        "status"   => "OK"
    },

    # ...

]

topload1, topload5, topload10

Aliases for get_top_results

get_top_results

my $response = $api->load_average->get_top_results('topload1');

Get monitor top results.

Optional parameters:

timezoneoffset limit tag

Normal response is:

{   "tags" => [
        "Default",    # ...
    ],
    "tests" => [
        {   "id"            => 1258,
            "testName"      => "load_test",
            "lastCheckTime" => "12 => 00",
            "result"        => 10.0,
            "status"        => "OK"
        },

        # ...
    ]
}

SEE ALSO

Monitis Monitis::Agents

Official API page: http://monitis.com/api/api.html#addLoadAvgMonitor

AUTHOR

Yaroslav Korshak <ykorshak@gmail.com> Alexandr Babenko <foxcool@cpan.org>

LICENCE AND COPYRIGHT

Copyright (C) 2006-2011, Monitis Inc.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See perlartistic.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.