FTP Monitor Settings

Last modified on March 27, 2024

This topic describes the configuration settings for FTP monitors. You can change the monitoring locations, run intervals, timeouts and other settings.

Notes:

  • You must be an Admin, Co-Admin, or Power User to change the monitor settings.

  • It may take a few minutes for the changes to take effect.

  • You can set the default settings for new monitors in  > Settings > Preferences > Monitor Defaults in AlertSite UXM, or in Account > Manage Account in AlertSite 1.0.

Common

Name (or Site Name in AlertSite 1.0)

The monitor name that appears in dashboards and reports. For example, Customer Login.

Monitor ID (in AlertSite UXM)

Read-only. The monitor ID that can be used in AlertSite APIs.

Enable Monitoring (or Monitoring Is in AlertSite 1.0)

AlertSite UXM

On the Main tab, select or clear the Enable Monitoring check box to enable or disable monitoring.

AlertSite 1.0

Set Monitoring Is to Enabled to enable the monitor or Disabled to disable it.

Monitor ID (in AlertSite UXM)

Read-only. The monitor ID that can be used in AlertSite APIs.

Name (or Site Name in AlertSite 1.0)

The monitor name that appears in dashboards and reports. For example, Customer Login.

Enable alerting

AlertSite UXM

Enable availability or performance alerts on the Alerts tab.

AlertSite 1.0

Set Notify on Error to Yes to enable availability alerts for this monitor or No to disable availability alerts. Performance alerts are configured separately by clicking the Performance Alerts button in the top row.

Custom Properties

This section shows custom properties defined for your monitor. You can select a value for each property from the predefined list.

Main

Basic

Measurement Plan (or Site Plan in AlertSite 1.0)

The monitoring plan used for this monitor.

Host (or URL in AlertSite 1.0)

The host name of the FTP server, optionally with a directory path. For example:

ftp.example.com
ftp.example.com/path/subpath

If a directory path is specified, the monitor will use the CWD command to change the working directory to the specified one.

Note: To monitor the server by the IP instead of the host name, leave Host blank, unselect Resolve DNS, and enter the IP Address (IPv4 only).

Run Interval (Minutes) (or Check Every in AlertSite 1.0)

How often the monitor checks your FTP server. Possible values depend on the selected Measurement Plan.

Timeout (Seconds)

The connection timeout, in seconds. If AlertSite cannot establish a connection to your server within this time interval, it will report status 1 (TCP connection failed), and an alert will be triggered. Default: 30 seconds.

Monitor Note (or Device Note in AlertSite 1.0)

Leave a note for yourself or other users. Note text can be up to 1000 characters long. This note will appear on the AlertSite Dashboard when you hover over the icon. The note can also be included in alerts.

Monitoring

Monitoring Mode (or Monitoring Type in AlertSite 1.0)

The monitoring mode controls if locations check your website simultaneously or sequentially, and when they send alerts. See Monitoring Modes for possible values and details.

Rotate Locations

For each monitor, you define a location pool. Rotation means the monitor uses a subset of this location pool (say, 2 out of 10 locations) on every run, cycling through the locations. If rotation is not used, the monitor checks from all of its locations every time.

Notes:

  • Rotated locations are not available for monitors that use Private Node Server locations (private monitoring stations installed on your local network).

  • If your monitor uses both public and private locations, location rotation applies only to the public ones. Private locations will run in the configured intervals.

  • The maximum number of locations for rotation is limited to the number of public locations.

  • Usage-Based Monitoring plan allows rotated locations for the following monitoring modes: Round Robin, SLA (MultiPOP), Global Notify, and Global Verify.

  • Legacy plans (Performance Pro, SLA) support rotating through locations only for the Round Robin and SLA (MultiPOP) modes.

Locations Per Run (or Locations per Interval in AlertSite 1.0)

If Rotate Locations is selected, you need to specify the number (subset) of public locations to use for each monitor run. This value ranges from 1 to the total number of locations you selected for the monitor.

If Monitoring Mode (or Monitoring Type in AlertSite 1.0) is Round Robin or SLA (MultiPOP), you need at least 2 locations per interval.

Enable Local Retry (or Disable Local Retry in AlertSite 1.0)

Used only for Usage-Based Monitoring plans. Controls the monitor behavior when it finds errors. Select this to retry the test from the same location to see if an error was just a temporary error. Clear (or select in AlertSite 1.0) to suppress the retry on errors. To learn more about that, see Local Retry and Global Verification.

Note: The retry consumes extra measurement credits.

Allow AlertSite QA Testing (or Disallow AlertSite QA Testing in AlertSite 1.0)

Before releasing AlertSite updates, SmartBear runs regression tests to make sure that both existing and new functionality work correctly. Select (or clear in AlertSite 1.0) this check box to include your monitor in SmartBear regression testing, so we can make sure your monitors will work correctly after AlertSite updates. Participation is voluntary.

Additional

Attempt file upload to FTP server

If this option is selected, AlertSite will test the file upload and download on your FTP server. An upload/download test works as follows: AlertSite generates a small test file with a random name, uploads this file to your tested server, then downloads this file, and compares the uploaded and downloaded files. The uploaded file will be removed afterwards.

If your FTP Host includes a subpath, such as ftp.example.com/path/subpath, AlertSite will upload the file to the specified directory on the server.

Note: File upload requires that your FTP server supports passive FTP. You also need to specify the FTP Username and FTP Password of a user with read/write permissions on your server.

Resolve DNS?

If this is selected, AlertSite will connect to your FTP server using the Host name. If this is unselected, AlertSite will use the IP Address instead.

IP Address

This option is displayed only if Resolve DNS? is unselected. It specifies the IP address (IPv4) of the tested FTP server. AlertSite will connect to the server using this IP address instead of the Host name.

Port

Optional. The port number on your FTP server that AlertSite will connect to. The default ports are 21 for FTP and 990 for FTPS (FTP over SSL).

TCP Traceroute on Error (or TCP Traceroute on Network Error in AlertSite 1.0)

If this is selected, the monitor runs a TCP traceroute to your website when it detects a network connectivity problem (status 1 or 2), and sends results to all email alert recipients. The traceroute shows the path that data packets are taking from a monitoring location to your server, and can help administrators and engineers troubleshoot problems.

Advanced

SSL Options

These options apply to FTPS (secure FTP) monitors only.

Version of SSL Protocol to use when connecting

If your FTP server requires a specific SSL or TLS version for client connections, select the desired version from the list. Otherwise, select Auto-Detect, and the monitor and your server will select the protocol automatically.

Use user-supplied client certificate when connecting

If your FTP server requires a client-side SSL certificate to access it, you need to upload your certificate to AlertSite. To do this, go to  > AlertSite 1.0 > Configure > SSL Certificates, upload the certificate, and then assign it to your monitor. For detailed instructions, see Using SSL Certificates and Java Keystores. This approach works if you use AlertSite’s public locations.

If you use private locations (Private Node Server or InSite), please send the certificate to SmartBear Support, along with your API monitor name, location name, and also your company name and customer ID from the  > Settings > Account screen. You will be informed when the certificate is in place. After that you can do a test on demand to verify the monitor.

FTP Authentication

You need to specify the FTP Username and FTP Password if your FTP server requires authentication, or if Attempt file upload to FTP server is selected. In the latter case, the specified user must have read/write permissions on your FTP server.

For anonymous access, use anonymous as the user name. Any password should work, but it is common to use the password guest or your email address. Some FTP servers explicitly require passwords in the form of an email address.

Monitor Sharing

These options are available only in AlertSite UXM.

Select the Dashboard Tile Sharing check box to generate a public link for this monitor’s dashboard tile. You can share this link with your colleagues who do not have an AlertSite account, or use it to embed the monitor tile into external dashboards. For details, see Sharing and Embedding Monitor Tiles.

Unselecting the Dashboard Tile Sharing check box will revoke the link.

Locations

Select one or more locations to monitor you FTP server from. For details, see Selecting Locations for Monitoring.

Blackouts

On this tab, you can view and edit monitor blackouts. Blackouts are time periods when the monitor either does not run or does not send alerts on errors. To learn how to create blackouts, see Scheduling Monitor Blackouts.

Existing blackouts are displayed in a table with the following columns:

Column Description

Status

The blackout status: Scheduled or Past. The column is shown if the Hide Past Blackouts check box is cleared.

Schedule

The blackout date and time.

Type

What is disabled during the blackout – the Monitor itself, or just Alerts from this monitor.

Note

Optional blackout notes. For one-time blackouts only.

Created By

The user who created this blackout. For one-time blackouts only.

Monitor blackouts

Click the image to enlarge it.

To filter out the blackouts, click the Filter by dropdown and select how to filter the blackouts:

  • By scheduling frequency: recurring or one-time blackouts.

  • By the blackout type: monitor or alert.

To remove expired blackouts from the blackouts table, select the Hide Past Blackouts check box.

Alerts

Here you can configure availability and performance alerts for the monitor. To receive alerts, you need to have alert recipients configured. By default, the monitor sends alerts to all configured recipients, but you can target alerts to specific recipients by selecting recipient groups for this monitor.

Recipient Groups (or Notifier Groups in AlertSite)

Select the recipient groups that will receive alerts from this monitor. The recipient groups must have been previously created in Alerts > Alert Recipients (or Notifiers > Notifier Groups in AlertSite 1.0).

If the monitor is not assigned to any recipient group, it sends alerts to all the recipients configured in your AlertSite account.
Note: Adding a monitor to the recipient group overrides any step-level associations for that recipient group. So if you want to add individual steps to a group, remove the monitor from that group first.

Availability Alerts (or Notify on Error? in AlertSite 1.0)

Select this check box to send alerts when the monitor detects errors like HTTP errors, timeouts, or incorrect website content. The monitor status turns red in these cases.

Alert Notes

Monitor-specific notes that can be included in email and JSON alerts (availability alerts only), up to 1000 characters long. To add these notes to alerts, you need to configure alert templates to include the $ALERT_NOTE variable. For details, see Adding Monitor-Specific Notes to Alerts.

Performance Alerts

Enable performance alerts if you wish to be notified when the monitor response time exceeds the specified value. See Performance Alerts for a description of available settings and to learn how to set up these alerts.

Notes:

  • In AlertSite 1.0, click the Performance Alerts button in the top left corner of the monitor configuration screen to view or change the performance alert settings.

  • For multi-step monitors, the response time thresholds should include the total response time for all test steps.

See Also

Creating an FTP Monitor
Monitoring Modes

Highlight search results