=================================
MONITISCLT V 1.0 - Monitis Inc.
README
=================================
-----------------------------------------
TABLE OF CONTENT
-----------------------------------------
ABOUT 1
USING MONITISCLT 2
COMMANDS 3
LOGIN a
LOGOUT b
HELP c
LOCATIONS d
EXTMONITORS e
EXTMONITORINFO f
EXTMONITORRESULT g
EXTSNAPSHOT h
INTSNAPSHOT i
TOPDRIVE j
TOPLOAD1 k
TOPLOAD5 l
TOPLOAD15 m
TOPCPU n
TOPEXTERNAL o
TOPMEMORY p
OUTPUT q
EXAMPLES 4
HELPFUL LINKS 5
-----------------------------------------
1 - ABOUT
Monitis CLT is designed to allow users to view and export data through command prompt using
few simple commands.
2 - USING MONITIS CLT
Steps to start using monitisclt:
1. Unpack monitisclt.zip to some folder.
2. Install java on your computer if you don't have it yet. (at least version 1.5 is required)
3. Make java command available from the monitisclt folder.
Now you are ready to use monitisclt(Monitis command line tools).
For each running command there is a special batch file (*.sh for linux machines and *.bat for windows).
Run the command you like by calling the correspondent batch file and pass arguments to it if needed.
Below you can find available arguments list for each command.
You can also run monitisclt.sh (monitisclt.bat) batch file and pass the command to the shell script as the first argument.
You can also choose output type (it can be either table view or CSV format) and then save the output into a file in your system.
3 - COMMANDS
a) LOGIN
Login is the first required command. After a successful authentication you will be able to
utilize all the other commands.
The usage of the command is as follows:
For Windows
login.bat email password
monitisclt.bat login email password
For Linux
login.sh email password
monitisclt.sh login email password
email - email used for your Monitis account
password - your password within your Monitis account
b) LOGOUT
Use logout command if you want to logout for any reason, e.g. the computer
is public and you don't want anyone to be able to access your account data under Monitis or
if you have several accounts and want to login with another account.
The usage is as follows:
For Windows
logout.bat
monitisclt.bat logout
For Linux
logout.sh
monitisclt.sh logout
c) HELP
The help command lists all available commands along with their short descriptions.
The usage is as follows:
For Windows
help.bat [command]
monitisclt.bat help [command]
For Linux
help.sh [command]
monitisclt.sh help [command]
command - this is an optional parameter. If specified the detailed description of the specified command will be displayed.
d) LOCATIONS
The LOCATIONS command lists all available locations along with their IDs.
The usage is as follows:
For Windows
locations.bat
monitisclt.bat locations
For Linux
locations.sh
monitisclt.sh locations
e) EXTMONITORS
This command is used for listing available external monitors along with their IDs.
The usage is as follows:
For Windows
extmonitors.bat
monitisclt.bat extmonitors
For Linux
extmonitors.sh
monitisclt.sh extmonitors
f) EXTMONITORINFO
Use this command to get specific information about an external monitor. Information such as start date,
test ID, match text, tag name, etc. will be displayed.
The usage of the command is as follows:
For Windows
extmonitorinfo.bat testId
monitisclt.bat extmonitorinfo testId
For Linux
extmonitorinfo.sh testId
monitisclt.sh extmonitorinfo testId
testId - the id of test. Testid is shown in the output of EXTMONITORS command.
g) EXTMONITORRESULT
The command outputs the results of a specific test for a specific date for specified locations.
The usage of the command is as follows:
For Windows
extmonitorresult.bat testId [date] [locations] [outputtype]
monitisclt.bat extmonitorresult testId [date] [locations] [outputtype]
For Linux
extmonitorinfo.sh testId [date] [locations] [outputtype]
monitisclt.sh extmonitorresult testId [date] [locations] [outputtype]
testId - the id of test. Testid is shown in the output of EXTMONITORS command.
date - Format is as follows: dd-mm-yyyy. If missed current date will be considered.
locations - location ids seperated via coma (e.g. locationId_1,locationsId_2).
Location ids can be taken from LOCATIONS or EXTMONITORINFO command.
If missed all available locations will be considered.
outputtype - If you want to get all detailed data don't specify anything, in case you want to get
only trend (average results) write trend.
h) EXTSNAPSHOT
The EXTSNAPSHOT command is used to display the snapshot view (last check results) of all external monitors.
The usage of the command is as follows:
For Windows
extsnapshot.bat [locations]
monitisclt.bat extsnpashot [locations]
For Linux
extsnapshot.sh [locations]
monitisclt.sh extsnapshot [locations]
locations - location ids seperated via coma (e.g. locationId_1,locationsId_2).
Location ids can be taken from LOCATIONS or EXTMONITORINFO command.
If missed all available locations will be considered.
i) INTSNAPSHOT
The INTSNAPSHOT command is used to display the snapshot view (last check results) of all internal monitors.
The usage of the command is as follows:
For Windows
intsnapshot.bat
monitisclt.bat intsnpashot
For Linux
intsnapshot.sh
monitisclt.sh intsnapshot
j) TOPDRIVE
Lists top 10 devices by storage utilization.
The usage of the command is as follows:
For Windows
topdrive.bat
monitisclt.bat topdrive
For Linux
topdrive.sh
monitisclt.sh topdrive
k) TOPLOAD1
Lists top 10 devices by load average during last minute.
The usage of the command is as follows:
For Windows
topload1.bat
monitisclt.bat topload1
For Linux
topload1.sh
monitisclt.sh topload1
l) TOPLOAD5
Lists top 10 devices by load average during last 5 minutes.
The usage of the command is as follows:
For Windows
topload5.bat
monitisclt.bat topload5
For Linux
topload5.sh
monitisclt.sh topload5
m) TOPLOAD15
Lists top 10 devices by load average during last 15 minutes.
The usage of the command is as follows:
For Windows
topload15.bat
monitisclt.bat topload15
For Linux
topload15.sh
monitisclt.sh topload15
n) TOPCPU
Lists top 10 devices by CPU utilization.
The usage of the command is as follows:
For Windows
topcpu.bat
monitisclt.bat topcpu
For Linux
topcpu.sh
monitisclt.sh topcpu
o) TOPEXTERNAL
Lists top 10 URL/IPs by response time.
The usage of the command is as follows:
For Windows
topexternal.bat
monitisclt.bat topexternal
For Linux
topexternal.sh
monitisclt.sh topexternal
p) TOPMEMORY
Lists top 10 devices by memory utilization.
The usage of the command is as follows:
For Windows
topmemory.bat
monitisclt.bat topmemory
For Linux
topmemory.sh
monitisclt.sh topmemory
q) OUTPUT
Changes output format.
The usage of the command is as follows:
For Windows
output.bat outputtype
monitisclt.bat output outputtype
For Linux
output.sh outputtype
monitisclt.sh output outputtype
outputtype - paramater can be either TABLE or CSV.
4 - EXAMPLES
Here are some examples that may help you.
Suppose you have properly installed java on your linux machine. You download Monitis Command Line Tools and
extract it to /opt/monitisclt folder. Now lets see how we use monitisclt commands and get results.
cd /opt/monitisclt //go to monitisclt directory
./login.sh demo@monitis.com demomonitis //login to your Monitis account typing your username and password
Successful authentication. //in case you have typed valid username-password you will see this output
Now when we are logged in we can use all other commands to get Monitis data. Lets try few.
./extmonitors.sh //output is the list of all external monitors
------------------------------------------------------------------
| List of Available Monitors |
------------------------------------------------------------------
| ID | Name |
------------------------------------------------------------------
| 11093 | google.com_http |
| 11094 | yahoo.com_http |
------------------------------------------------------------------
./extmonitorinfo.sh 11093 //display all available info about google.com_http monitor
-----------------------------------------------------------------------
| Monitor Properties |
-----------------------------------------------------------------------
| Property | Value |
-----------------------------------------------------------------------
| Timeout | 10 |
| Start Date | 2009-07-07 10:27 |
| Text to Match | |
| Type | http |
| Tag | Default |
| Post Data | |
| Detailed Type | get |
| Id | 11093 |
| URL | google.com |
| Name | google.com_http |
-----------------------------------------------------------------------
------------------------------------------
| Locations |
------------------------------------------
| ID | Name | Check Interval (min) |
------------------------------------------
| 1 | US | 5 |
------------------------------------------
./extmonitorresult.sh 11093 23-07-2009 1 //display avg results for 11093 monitor for day 23-07-2009 for location 1 (US)
----------------------------------------------------------------
| Location: US Date:23-7-2009 |
----------------------------------------------------------------
| Time | Response(ms) | Status |
----------------------------------------------------------------
| 00:03 | 69.0 | OK |
| 00:08 | 109.0 | OK |
| 00:13 | 107.0 | OK |
| 00:18 | 67.0 | OK |
| 00:23 | 109.0 | OK |
| 00:28 | 118.0 | OK |
| 00:33 | 74.0 | OK |
| 00:38 | 110.0 | OK |
| 00:43 | 109.0 | OK |
| 00:48 | 67.0 | OK |
| 00:53 | 110.0 | OK |
| 00:58 | 110.0 | OK |
| 01:03 | 110.0 | OK |
| 01:08 | 52.0 | OK |
| 01:13 | 52.0 | OK |
| 01:18 | 48.0 | OK |
| 01:23 | 67.0 | OK |
| 01:28 | 67.0 | OK |
| 01:33 | 66.0 | OK |
| 01:38 | 110.0 | OK |
| 01:43 | 110.0 | OK |
| 01:48 | 67.0 | OK |
| 01:53 | 110.0 | OK |
| 01:58 | 112.0 | OK |
| 02:03 | 110.0 | OK |
| 02:08 | 47.0 | OK |
| 02:13 | 48.0 | OK |
| 02:18 | 48.0 | OK |
| 02:23 | 109.0 | OK |
| 02:28 | 108.0 | OK |
| 02:33 | 71.0 | OK |
| 02:38 | 71.0 | OK |
| 02:43 | 67.0 | OK |
| 02:48 | 66.0 | OK |
| 02:53 | 47.0 | OK |
| 02:58 | 47.0 | OK |
| 03:03 | 47.0 | OK |
| 03:08 | 111.0 | OK |
| 03:13 | 109.0 | OK |
| 03:18 | 67.0 | OK |
| 03:23 | 66.0 | OK |
| 03:28 | 70.0 | OK |
| 03:33 | 108.0 | OK |
| 03:38 | 110.0 | OK |
| 03:43 | 114.0 | OK |
| 03:48 | 48.0 | OK |
| 03:53 | 68.0 | OK |
| 03:58 | 70.0 | OK |
| 04:03 | 129.0 | OK |
| 04:08 | 111.0 | OK |
| 04:13 | 110.0 | OK |
| 04:18 | 109.0 | OK |
| 04:23 | 118.0 | OK |
| 04:28 | 112.0 | OK |
| 04:33 | 49.0 | OK |
| 04:38 | 67.0 | OK |
| 04:43 | 67.0 | OK |
| 04:48 | 67.0 | OK |
| 04:53 | 67.0 | OK |
| 04:58 | 67.0 | OK |
| 05:03 | 109.0 | OK |
| 05:08 | 48.0 | OK |
| 05:13 | 47.0 | OK |
| 05:18 | 66.0 | OK |
| 05:23 | 46.0 | OK |
| 05:28 | 48.0 | OK |
| 05:33 | 112.0 | OK |
| 05:38 | 48.0 | OK |
| 05:43 | 48.0 | OK |
| 05:48 | 48.0 | OK |
| 05:53 | 47.0 | OK |
| 05:58 | 47.0 | OK |
| 06:03 | 109.0 | OK |
| 06:08 | 50.0 | OK |
| 06:13 | 47.0 | OK |
| 06:18 | 108.0 | OK |
| 06:23 | 46.0 | OK |
| 06:28 | 49.0 | OK |
| 06:33 | 50.0 | OK |
| 06:38 | 109.0 | OK |
| 06:43 | 109.0 | OK |
| 06:48 | 48.0 | OK |
| 06:53 | 142.0 | OK |
| 06:58 | 112.0 | OK |
| 07:03 | 110.0 | OK |
----------------------------------------------------------------
----------------------------------------------------------------------------------------
| Location: US Date:23-7-2009 |
----------------------------------------------------------------------------------------
| Uptime(%) | Avg Response(ms) | Min Response(ms) | Max Response(ms) |
----------------------------------------------------------------------------------------
| 0 | 80 | 46.0 | 142.0 |
----------------------------------------------------------------------------------------
5 - HELPFUL LINKS
http://portal.monitis.com/web/guest/resources
http://blog.monitis.com/index.php/2009/07/23/monitis-command-line-tools-creates-new-opportunities-for-it-administrators/