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

NAME

Monitis::CustomMonitors - Custom monitors manipulation

SYNOPSIS

use Monitis::CustomMonitors;

DESCRIPTION

ATTRIBUTES

Monitis::CustomMonitors implements following attributes:

api_url

API url for Custom Monitors: http://www.monitis.com/customMonitorApi

METHODS

Monitis::CustomMonitors implements following methods:

add

my $response = $api->custom_monitors->add(
    resultParams => 'position:Position:N/A:2;difference:Difference:N/A:3',
    name     => 'test from api',
    tag      => 'test'
);

Create monitor.

Mandatory parameters:

agentkey name tag

Optional parameters:

monitorParams

Normal response is:

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

edit

my $response = $api->custom_monitors->edit(
    monitorId  => 922,
    name    => 'test from api',
    tag     => 'test'
);

Edit monitor.

Mandatory parameters:

monitorId name tag

Optional parameters:

monitorParams

Normal response is:

{   "data"   => null,
    "status" => "ok"
}

get

my $response = $api->load_average->get;

Get monitors list.

Optional parameters:

tag

Response:

[   {   "tag"  => "test",
        "name" => "simple_custom_monitor",
        "id"   => "56"
    },

    # ...
]

get_info

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

Get monitor details.

Mandatory parameters:

monitorId

Optional parameters:

excludeHidden

Response:

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

add_results

my $response = $api->custom_monitors->add_results(
    monitorId => 922,
    checktime => time,
    results   => 'position:3;time:1'
);

Add monitor results.

Mandatory parameters:

monitorId checktime results

Response:

{   "data"   => null,
    "status" => "ok"
}

get_results

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

Get monitor results.

Mandatory parameters:

monitorId day month year

Optional parameters:

timezone

Response:

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

delete

my $response = $api->custom_monitors->delete(monitorId => 922);

Delete monitor.

Response:

{   "data"   => null,
    "status" => "ok"
}

SEE ALSO

Monitis

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

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.