Monitis::ExternalMonitors - External monitors manipulation
use Monitis::ExternalMonitors;
Monitis::ExternalMonitors implements following attributes:
Monitis::ExternalMonitors implements following methods:
my $response = $api->external_monitors->add( type => 'http', name => 'New Test', url => 'http://google.com', interval => 10, timeout => 10000, locationIds => '1,11', tag => 'new tag' );
Add new external monitor.
Mandatory parameters:
type name url interval timeout locationIds tag
Optional parameters:
detailedTestType overSSL postData contentMatchFlag contentMatchString params
Normal response is:
{ "status" => "ok", "data" => { "startDate" => "2010-10-18 15 => 18", "testId" => 36958, "isTestNew" => "1" } }
my $response = $api->external_monitors->edit( testId => 36958, name => 'Old test', timeout => 4000 );
testId name url locationIds timeout tag
contentMatchString maxValue
my $response = $api->external_monitors->delete( testIds => '36958,36959' );
Delete external monitors.
testIds
{"status" => "ok"}
my $response = $api->external_monitors->suspend( testIds => '36958,36959' );
Suspend external monitors.
testIds or tag
{ "status" => "ok", "data" => {"failedToSuspend" => [10405, 86758, 35748]} }
my $response = $api->external_monitors->activate( testIds => '36958,36959' );
Activate external monitors.
my $response = $api->external_monitors->get_locations;
Get locations list.
[ { "id" => 5, "name" => "US-MID", "minCheckInterval" => 1 }, # ... ]
my $response = $api->external_monitors->get_monitors;
Get monitors list.
{ "testList" => [ { "id" => 2755, "name" => "yahoo_http_444", "isSuspended" => 0, "type" => "http" }, # ... ] }
my $response = $api->external_monitors->get_monitor_info(testId => 2755);
Get monitor info.
testId
{ "startDate" => "2010-03-10 08 => 42", "timeout" => 5, "type" => "dns", "postData" => null, "testId" => 25871, "match" => null, "matchText" => null, "params" => { "3" => "aa", "bbb" => "cccc", "dddd" => "eeee" }, "tag" => "tag1", "detailedType" => null, "url" => "google.com", "name" => "google_dns", "locations" => [ { "checkInterval" => 5, "fullName" => "Australia", "name" => "AU", "id" => 6 }, # ... ] }
my $response = $api->external_monitors->get_monitor_results( testId => 2755, day => 12, month => 5, yea => 2011 );
testId day month year
locationIds timezone
[ { "id" => 7, "locationName" => "DE", "trend" => { "min" => 65.0, "okcount" => 1440, "max" => 3154.0, "oksum" => 110721.0, "nokcount" => 1 }, "data" => [ ["2010-03-16 00 => 00", 115.0, "OK"], ["2010-03-16 00 => 01", 117.0, "OK"], # ... ["2010-03-16 23 => 58", 0.0, "NOK"], ["2010-03-16 23 => 59", 146.0, "OK"] ], "adddatas" => [["Connection lasted more than 10 seconds.", 1]] } # ... ]
my $response = $api->external_monitors->get_snapshot;
Get latest test values.
locationIds
[ { "locationName" => "US-MID", "id" => 6, "data" => [ { "time" => "9 Mar 2010 14 => 58 => 33 GMT", "tag" => "aaaa", "perf" => 736.0, "status" => "OK", "name" => "yahoo.com_http", "id" => 15613, "timeout" => 10000 }, # ... ] }, # ... ]
my $response = $api->external_monitors->get_top_results;
Get test top results.
timezoneoffset limit tag
{ "tags" => [ "Default", "EC2", # ... ], "tests" => [ { "id" => 5481, "testName" => "google.com_http", "lastCheckTime" => "13 => 05", "result" => 603.0, "status" => "OK" }, # ... ] }
my $response = $api->external_monitors->get_tags;
Get monitor tag list.
{ "tags" => [ { "rank" => 12, "title" => "EC2" }, # ... ] }
my $response = $api->external_monitors->get_by_tag(tag => 'my tag');
Get tests by tag.
Mandaytory parameters:
tag
{ "testList" => [ { "id" => 38965, "name" => "c2-99-168-239-273.compute-1.amazonaws.com_ssh" }, # ... ] }
Monitis
Official API page: http://monitis.com/api/api.html#addExternalMonitor
Yaroslav Korshak <ykorshak@gmail.com> Alexandr Babenko <foxcool@cpan.org>
<ykorshak@gmail.com>
<foxcool@cpan.org>
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.
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.
To install Monitis, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Monitis
CPAN shell
perl -MCPAN -e shell install Monitis
For more information on module installation, please visit the detailed CPAN module installation guide.