IMPORTANT - READ ME FIRST!|
Before you purchase the Ultra Monitor iPhoneTM application you should first download
and install our free server-side Ultra Monitor software and ensure it works by trying it
in TEST mode.
Click here for full instructions
Assuming you have followed the above important read-me note, and have verified that our server-side code works for you in TEST mode, the following are additional requirements for this program:
- Works on any model iPhone or Touch that has internet access (either via cellular or wifi).
- Requires network access to the servers you wish to monitor on the ports you have set them to be monitored on.
The main screen shown on the iPhone display has the following layout and functionality:
- The right side of the screen contains the navigation icons:
- Reload - Tap this to reload (refresh) the currently displayed server
- Ping Diagnostics - Tap this to ping all your servers and 5 additional servers
- Settings - Tap this to configure global settings
- Server List - Tap this to get a listing of all your servers
- Add Server - Tap this to add a new server to your server list
- Previous Server - Tap this to move to the previous server on your list
- Next Server - Tap this to move to the next server on your list
When viewing a server, tap the server name at the top to edit the server information.
When information is displayed in the center PARTITIONS, PROCESSES, and USERS windows, tap, hold and drag to view information that may be below the view.
Tap the CPU meter on the left side of the screen to view the CPU Graph for the current server. Tap it again to hide the graph.
Tap the bottom "Ultra Monitor © Cookware Inc." to visit the Ultra Monitor website (Safari pops up). If the red Trouble Console appears here instead, tap it to view the current trouble console log.
When you tap most icons in the Ultra Monitor application, additional windows appear that we call panes. Each pane slides in for you to use, and slide out again when you are done. In most cases, you can tap any other icon to close a pane (or tap the same icon again that you used to open a pane, to close it).
| ADDING A SERVER|
The first time, after purchase, that you run the iPhone Ultra Monitor application, the ADD SERVER PANE will automatically slide into view. The screen, after launch, will look like this:
If you do not wish to add a server, you can dismiss the pane by tapping the ADD SERVER ICON (plus sign) again.
To add a new server at any time, simply tap the ADD SERVER ICON (plus sign) and the ADD SERVER PANE will slide into view again.
When the ADD SERVER PANE is visible, it contains three fields and two switches. These fields and switches have the following function:
Once you have entered all the fields and set the switches as you want, click the green SAVE in the upper right of the pane to save this server. To abort and not save the server, click the red CANCEL in the upper left corner of the pane, or tap the ADD PANE ICON again (or any other icon).
- Tap the Short Name field to display a keyboard. Enter a name for this server. This name is what is shown to you while that server is being monitored. When you are finished, tap the blue Done in the lower right of the keyboard.
- Tap the Address field to display a keyboard. Enter an IP address or domain name for the server you wish to monitor. Do not enter a full URL (e.g., do not include the http or https), just the IP address or the domain name.
If the server is running on a non-standard port (e.g., not 80 or 443) put a colon after the IP address/domain name followed by the port number.
The following are all valid examples:
In the first example above, only an IP address is entered. In the second the IP address is followed by a colon and the port number. The third example shows just a domain name, and the fourth shows a domain name with a colon and the port number.
When you are finished, tap the blue Done in the lower right of the keyboard.
- The Binary field can normally be left to it's default um. However, if you have changed the name of the server-side Ultra Monitor binary (the executables name), tap this field and modify it to be the same as the name of your cgi-bin (you only need to do this if you are not using the server-side code in stand-alone mode, and you have changed the executables name for increased security).
When you are finished, tap the blue Done in the lower right of the keyboard.
- The SECURE switch should be used if you are using the server-side code as a CGI-BIN. Set the switch to HTTPS (green 'Y') if you have a secure certificate (SSL) and wish the access to be encrypted (it will automatically be directed to port 443 unless you overrode the port assignment in the Address field).
If you do not have a secure certificate, tap the SECURE switch till it reads HTTP (red 'N'). This causes normal access to the server via the web port 80, unless you have overrode the port assignment in the Address field.
Note that this only affects Ultra Monitor when it is run as a cgi-bin (never as a stand-alone server, in which case the setting on this switch doesn't matter).
- The MONITOR switch sets whether or not you want this server to be actively monitored. If set to the green "Y", once saved it will be added to the list to monitor. If set to the red "N", once saved it will be skipped over until monitoring is turned back on.
EDITING A SERVER
Once you have added one or more servers, you can edit any server which is the current server being shown by tapping the server name at the top of the iPhone display. Once you tap a server name, a pane will slide down from the top that allows you to edit all the settings for that server:
The three fields and two switches are identical to the ADD SERVER PANE and you modify the information in the same way (refer to the instructions under the ADD SERVER PANE above).
Once you are done making your changes tap the green SAVE to save the changes or the red CANCEL to cancel the save.
Under the fields and switches is another button marked DELETE SERVER. Tap this button to remove the server completely from your list of servers being modified.
| || VIEWING SERVERS|
By default the Ultra Monitor application will be set to view the first server in your list. (Note that you can have it automatically sequence through your servers by turning on BOUNCE mode in the SETTINGS pane).
You can view other servers in your list by tapping the PREVIOUS SERVER (left arrow icon) or NEXT SERVER (right arrow icon) at the lower right of the iPhone display. If you reach the end (or beginning) it will wrap around.
When you are displaying a server, the following information areas of the screen are active:
- At the very upper left corner of the screen is the CPU % display and the current CPU load of the server you are viewing. If the load is under the limits set on the server, it will be GREEN. If it is in the yellow warning area, it will be YELLOW and if it is the alarm area, it will be RED.
- At the very top center of the iPhone display is the Short Name for the current server being modified. Tapping the name lets you edit the server.
To the left of the name is a Date with a Time just below. This is the date and time of the latest query of the server. This lets you see if the information is stale (old) or not.
To the right of the name is the word LAG with a number of seconds shown above it. This is the amount of time, in seconds, for the request to the remote server to be made and the response to be received (round-trip time). On a WIFI network, this is normally zero to 2 seconds. On a cellular network this might be much larger (4 to 10 seconds). Use this to determine if there are problems in the network causing lag or other delays.
- In the very upper right corner is a blue or green HEART. If the heart is green, it is facing slightly to the left. If the heart is blue, it is facing slightly to the right. This is the HEARTBEAT and is an indicator as to when Ultra Monitor is fetching a new round of data. If you do not see the hearbeat moving after each server scan (all servers) then something is wrong with the program.
- On the very left side is the current CPU load shown as a colored graphic. Three dots, a green, yellow, and red dot are to the left of the graphic and indicate the OK, YELLOW WARNING, and RED ALERT limits as specified in the server setup. To the right of the graphic and the dots are the corresponding load values for those limits (green isn't shown, it is assumed to be zero).
The current CPU load is shown in the graphic as a gradient going from green to yellow and into red, depending on how high the current load is.
Tapping the CPU graphic will slide in a CPU GRAPH pane that shows the last 250 data points as a small graph (the top of the graph is the most recent data). Tap it again to revert to the original graphic (more on this below).
- In the middle of the display are three black windows titled PARTITIONS, PROCESSES, and USERS. During the display of a server, these windows will show the revelant information, and the information will be colored to indicate normal values or warning/alarm values. If there is more information than will fit in the visible window, tap hold and drag the window to view the rest of the contents.
- You can force an immediate refresh of the current servers data (this also forces a refresh of all the servers) by tapping the RELOAD (circular) icon just below the heartbeat.
| THE SERVER LIST PANE|
Tap the LIST SERVER icon to have the LIST SERVER Pane slide in from the right side. This pane lists all your servers that are being monitored and gives a synopsis of information about each server:
All your servers are shown. If there are more than will fit on the display, tap hold and drag to view the other servers.
The server name is listed (and it will show the word PAUSED if it is not being monitored). Below the name is the current CPU load, total number of monitored processes, and total number of monitored users.
You can tap any server in the list, to have that server immediately be displayed on the main iPhone display.
To dismiss this pane, tap the LIST SERVER icon again or any other icon.
Note that once you display this list, it does not automatically update until
the pane is hidden and redisplayed, or until you hit the yellow REFRESH button.
| THE SETTING PANE|
Tap the SETTINGS Icon to display the SETTINGS Pane. This pane lets you change global settings that affect all the servers you are monitoring. This is specific to your iPhone only (not the servers themselves).
This pane features a number of switches and buttons and a scroll wheel for picking delays:
Note that any changes made to the Settings Pane take place instantly. There is no need to save or cancel.
- The VIBRATE switch - This switch lets you specify if your phone should vibrate if it detects a warning or alert condition with your servers or the network connection. Set this to green (Y) to turn vibrate on and red (N) to turn vibrate off.
- The PING switch - This switch is an audio method of letting you know that the Ultra Monitor application is up and running, even if you are not looking at your phone. When PING is turned on (green "Y") a pleasing little 'ping' sound will play periodically. If PING is turned off (red "N") no ping sound is periodically played.
Depending on how frequently your servers are scanned (see the SCROLL WHEEL and BOUNCE controls below) will depend on the frequency of the ping sound.
If you are scanning servers faster than once a minute, the ping sound will only be played once per minute.
If you are scanning servers slower than once a minute, the ping sound will be played each time after all the servers have been scanned.
- The AUDIO switch - This switch controls whether or not warnings and alerts cause an audio message to be played. If this is set to the green "Y", than some form of audio alert will be played (depending on the TYPE buttons). If this is set to red "N", no audio alert will be played (thus, the only way of seeing an alert would be either visually or by having vibrate turned on).
- The TYPE buttons - These two buttons, one marked CHIME and one marked VOICE work in conjunction with the AUDIO switch. If AUDIO is turned off (red "N") then these buttons are ignored. However, if AUDIO is turned on (green "Y") these two buttons determine the type of audio sound.
If TYPE is set to VOICE than a spoken voice message is heard. If TYPE is set to CHIME than a deep CHIME sound is played for a warning or alert.
The various spoken words include the following:
- If there is a network outage or no internet, it will speak "Internet Alert"
- If there is a warning or alarm it will speak "Alert"
- If there was a problem and there no longer is, it will speak "Problem Solved"
- The BOUNCE switch - This switch gives you an alternative way of viewing your servers. With BOUNCE set to red "N", BOUNCE is turned off. In this mode, all servers are polled but only the 'current' server is shown to you. Use the NEXT/PREVIOUS arrow icons or the SERVER LIST icon to change which server you are viewing.
When BOUNCE is turned on (green "Y") it will bounce from server to server as each server is polled, automatically showing you the current server as it moves along. This is a very nice hands-free mode of monitoring all your servers.
- The SCROLL WHEEL - At the very bottom of the Settings Pane is a scroll wheel. This sets the amount of time either between server polls or at the end of server polls, depending on how you are using BOUNCE.
If BOUNCE is turned off (red "N") then the scroll wheel selects the amount of time that the program delays after it has polled ALL servers. In other words, all the servers will be polled, one after another, and once they are all done, the program will delay the amount specified by the scroll wheel. In this mode, the scroll wheel says things like "Wait 5 seconds after scanning all servers".
If BOUNCE is turned on (green "Y") then the scroll wheel selects the amount of time that the program delays BETWEEN each server. This basically is the amount of time that you have to view the screen before it updates to the next server. In this mode, the scroll wheel says things like "Wait 5 seconds between each server".
| THE PING DIAGNOSTICS PANE|
Tapping the PING DIAGNOSTICS Icon will cause the DIAGNOSTICS Pane to slide out from the right.
If you are experiencing problems with any of your connections, this pane can be useful to determine if other networks are having similar problems.
This Pane will show you a list of all your servers, followed by 5 additional servers. For each server in the list, a TCP PING will be performed up to 3 times (3 passes). The millisecond time for the ping is displayed, otherwise an error is displayed.
If the display is a green number, this is the ping time. If the display is a red or yellow word, it has the following meanings:
- param - Parameters were incorrect (contact Cookware Inc),
- socket - A socket could not be created (try rebooting your iPhone).
- host - The host is unknown or there is a connection error.
- timeout - The host is known but timedout during the response.
Once all the ping times have been determined for all the servers in the DIAGNOSTICS PANE, the ping stops. To start it again, tap the green REFRESH button in the upper left corner of the Pane, or close and reopen the Pane.
You will notice that after each of your servers are pinged, 5 additional servers are pinged. This allows you to test other networks to see if the problem is specific to your network, or in general to all internet access.
By default, the 5 additional servers are:
These were chosen because they are usually ping-able and usually up. However, you can customize the 5 additional servers by tapping the orange SETUP button in the upper right of the DIAGNOSTICS Pane. This will display the following setup pane:
This is the PING SETUP Pane and it is used to setup the 5 additional servers. Simply tap a server field and enter the desired IP address or domain name of the server you wish to ping. Leaving a server blank (no address) will cause that slot to be skipped in the ping tests.
For each server that is being monitored, Ultra Monitor tracks the most recent 250 cpu loads. You can view a graph of the cpu loads by tapping the normal CPU bar chart on the left side. Once you tap it, a CPU GRAPH Pane will slide up from the bottom that looks like this:
This pane shows three lines, a green one on the left, a yellow one in the middle, and a red one at the right. These correspond to 0 CPU load (green line), your YELLOW ALERT LIMIT (yellow line) and your RED ALERT LIMIT (red line).
To top of the graph is the most recent data, with the bottom of the graph being the oldest. The graph scrolls downwards as new data is added.
To get rid of the CPU GRAPH Pane, simply tap it again.
If a warning or alert occurs for one or more of the servers you are monitoring, a red TROUBLE CONSOLE window will scroll up from the bottom, with just the title visible like this:
Tapping anywhere on the title of the TROUBLE CONSOLE will cause the entire TROUBLE CONSOLE Pane to scroll up from the bottom.
The TROUBLE CONSOLE Pane will list each server that has a problem, and then each problem that it discovered under that server, like this:
Note that problems are also shown in other windows by color.
If, in the next poll, all the problems suddenly go away, the TROUBLE PANE will automatically dismiss and disappear (thus, if there is no TROUBLE PANE visible, there is no trouble with the servers as far as Ultra Monitor is concerned).
You can get the TROUBLE CONSOLE to scroll back down again by tapping the title. You can NOT totally dismiss the TROUBLE CONSOLE unless there is no more trouble.
Ultra Monitor is meant to be used and viewed in the landscape (horizontal) positon. Normally, when people have an iPhone in their pockets, they have it in the portrait (vertical) position.
While monitoring your servers with Ultra Monitor, with the iPhone in your pocket, it would be preferable if accidental taps to the scren did not interrupt the program. To accomplish this, whenever the iPhone is not in the normal landscape position, the screen will automatically be locked and the following image will be displayed:
To unlock the screen, simply rotate the phone back to the proper landscape (horizontal) position.
While in the locked position, the program continues to operate as normal but refuses all screen input until unlocked.
Depending on how many servers you are monitoring and how frequently you have the program set to monitor, Ultra Monitor can run your battery down rather quickly.
To get the most out of your battery life while running Ultra Monitor, try the following tips:
- Turn "Ping" off in the Ultra Monitor Settings Pane (avoids unnecessary audio)
- Set a longer, rather than shorter delay on the Scroll Wheel in the Settings Pane
- Avoid using BOUNCE mode (especially if you are not looking at the display)
- Set the iPhone display to as dim as possible while still being able to read the display
- Use only WIFI or Cellular, not both (and turn the other off)
- Set Location Services off (iPhone Settings, General)
- Set Bluetooth off (iPhone Settings, General)
- Turn off 3G and only use EDGE (iPhone Settings, General, Network)
To see a list of frequently asked questions and troubleshooting tips, click here.
home page | user manual | server setup | support | contact | download
© 2009 Cookware Inc.
Apple®, the Apple logo, iPod, iPhone, and iTunes are trademarks of Apple Inc., registered in the U.S. and other countries.