SiteScope User's Guide

FTP Monitor

The SiteScope FTP Monitor attempts to log into an FTP server and retrieve a specified file. A successful file retrieval assures you that your FTP server is functioning properly.

In addition to retrieving specific files, the FTP Monitor can help you verify that the contents of files, either by matching the contents for a piece of text, or by checking to see if the contents of the file ever changes comapred to a reserve copy of the file.

Usage Guidelines

If you provide FTP access to files, it's important to make sure that your FTP server is working properly. There's nothing more frustrating for a customer than to finally find the file they want, but then be unable to get it. The FTP monitor insures that you're the first to know if there's a problem.

To use this monitor you will need to:

have network access to an FTP server
know the relative paths, if any, to the files on the FTP server
know an applicable username and password to access the files
know the filenames of one or more files available for FTP transfer

While you may have many files available for FTP from your site, it's not necessary to monitor every one. It is recommeded that you check one small file and one large file.

A common strategy is to monitor a small file every 10 minutes or so just to verify that the server is functioning. Then schedule a separate monitor instance to FTP a large file once or twice a day. This allows you test the ability to FTP a large file without negatively impacting your machine's performance. You can schedule additional monitors that watch files for content and size changes to run every 15 minutes to half hour. Choose an interval that makes you comfortable.

If you have very important files available, you may also want to monitor them occasionally to verify that their contents and size don't change. If the file does change, you can create a SiteScope alert that will run a script to automatically replace the changed file with a back-up file.

Status

The reading is the current value of the monitor. Possible values are:

OK
unknown host name
unable to reach server
unable to connect to server
timed out reading
content match error
login failed
file not found
contents changed

The status is logged as either good or error. An error status is returned if the current value of the monitor is anything other than OK.

Completing the FTP Monitor Form

To display the FTP Monitor Form, either click the Edit link for an existing FTP Monitor in a monitor table, or click the add a Monitor link on a group's detail page and choose the "Add FTP Monitor" link.

Complete the items on the FTP Monitor form as follows. When the required items are complete, click the "Add Monitor" button.

FTP Server: Enter the IP address or the name of the FTP server that you want to monitor. For example, you could enter either 206.168.191.22 or ftp.thiscompany.com.
File: Enter the file name to retrieve in this box, for example /pub/docs/mydoc.txt.
User Name: Enter the name used to log into the FTP server in this box. A common username for general FTP access is username anonymous.
Password: Enter the password used to log into the FTP server in this box. If using the anonymous login, the password is also anonymous.
Update every: Enter how frequently the monitor should check this FTP server. The drop-down list to the right of the text box lets you specify time increments of seconds, minutes, hours, or days. You must specify a time increment of at least 15 seconds.
Title (Optional): Enter a name for this monitor. This name appears in the Name text box on the monitor table when you open the group's detail page. If you don't enter a name, a default name will be created.

Advanced Options

The advanced options give you the ability to customize error and warning thresholds, or complete optional settings.

Disable

Check this box to temporarily disable this monitor and any associated alerts. To enable the monitor again, clear the box.

Timeout

The number of seconds that the FTP monitor should wait for a file to complete downloading before timing-out. Once this time period passes, the FTP monitor will log an error and report an error status.

FTP Proxy

You may instruct SiteScope to run the FTP through a proxy server. Generally, if you use an FTP proxy you will have it set up in your browser. Enter that same information here. For example, proxy.thiscompany.com:8080. Remember to include the port.

Passive Mode

Check this box if you want SiteScope to use FTP passive mode. This mode usually allows FTP to work through firewalls.

Match Content

Enter a string of text to check for in the returned file. If the text is not contained in the file, the monitor will display "no match on content". The search is case sensitive. You may also perform a Perl regular expression match by enclosing the string in forward slashes, with an "i" after the trailing slash indicating case-insensitive matching. (for example, "/Size \d\d/" or "/size \d\d/i").

Check for Content Changes

Unless this is set to "no content checking" (the default) SiteScope will record a checksum of the document the first time the monitor runs and then does a checksum comparison each subsequent time it runs. If the checksum changes, the monitor will have a status of "content changed error" and go into error. If you want to check for content changes, you will usually want to use "compare to saved contents".

The options for this setting are:

no content checking - (default) SiteScope doesn't check for content changes
compare to last contents - The new checksum will be recorded as the default after the initial error "content changed error" occurs, so the monitor will return to OK until the checksum changes again
compare to saved contents - The checksum is a snapshot of a given page (retrieved either during the initial or a specific run of the monitor). If the contents change, the monitor will get a "content changed error" and will stay in error until the contents return to the original contents, or the snapshot is update by resetting the saved contents
reset saved contents - Takes a new snapshot of the page and saves the resulting checksum on the first monitor run after this option is chosen. After taking the snapshot, the monitor will revert to "compare to saved contents" mode.

Proxy Server User Name

If the proxy server requires a name and password to access the file, enter the name here. Technical note: your proxy server must support Proxy-Authenticate for these options to function.

Proxy Server Password

If the proxy server requires a name and password to access the file, enter the password here. Technical note: your proxy server must support Proxy-Authenticate for these options to function.

Verify Error

Check this box if you want SiteScope to automatically run this monitor again if it detects an error. When an error is detected, the monitor will immediately be scheduled to run again once.

Note: In order to change the run frequency of this monitor when an error is detected, use the Update every (on errors) option below.

Note: The status returned by the Verify Error run of the monitor will replace the status of the originally scheduled run that detected an error. This may cause the loss of important performance data if the data from the verify run is different than the initial error status.

Warning: Use of this option across many monitor instances may result in significant monitoring delays in the case that multiple monitors are rescheduled to verify errors at the same time.

Update Every (on error)

This options allows you to set a new monitoring interval for monitors that have registered an error condition. For example, you may want SiteScope to monitor this item every 10 minutes normally, but as often as every 2 minutes if an error has been detected. Note that this increased scheduling will also affect the number of alerts generated by this monitor.

Schedule (Optional)

By default, SiteScope's monitors are enabled every day of the week. You may, however, schedule your monitors to run only on certain days or on a fixed schedule. Choose the Edit schedule link to create or edit a monitor schedule. For information about creating schedules, read these instructions.

Monitor Description (Optional)

Enter additional information about this monitor. The Monitor Description can include HTML tags such as the <BR> <HR>, and <B> tags to control display format and style. The description will appear on the Monitor Detail page.

Report Description (Optional)

Enter a description for this monitor that will make it easier to understand what this monitor does. The description will appear on Management Reports and on the info list for a monitor.

Depends On (Optional)

To make the running of this monitor dependent on the status of another monitor or monitor group, use the drop-down list to select the monitor or group on which this monitor is dependent. Select None to remove any dependency.

Depends Condition (Optional)

If you choose to make the running of this monitor dependent on the status of another monitor, choose the status condition that the other monitor or monitor group should have in order for the current monitor to run normally. The current monitor will be run normally as long as the monitor or group on which it depends reports the condition selected in this option.

List Order (Optional)

By default, new monitors are listed last on the Monitor Detail page. You may use this drop-down list to choose a different placement for this monitor.

Error if

By default, SiteScope generates an error if the returned status indicates anything other than a successful retrieval of the file. You may choose to have SiteScope generate an error based on the round trip retrieval time. Enter the shortest retrieval time (in milliseconds) that should generate an error. Enter a comparison value and use the comparison operator list to specify an error threshold such as: >= (greater than or equal to), != (not equal to), or < (less than).

Warning if

By default, SiteScope does not generate warnings for FTP monitors. You may choose to generate a warning based on round trip retrieval time. Enter the shortest retrieval time (in milliseconds) that should generate a warning. The symbols in the comparison value list are the same as those for Error if.

Good if

By default this monitor returns a good reading if the monitor returns a status of 200. You can change this to be tied to either file size or round-trip time. Choose the option you prefer from the drop-down list and then set the threshold using the comparison value list. The symbols in the comparison value list are the same as those for Error if.