Open topic with navigation
In AlertSite UXM, API monitors test SOAP and REST web services to make sure they are working correctly. API monitors are powered by Ready! API or SoapUI tests, and have a number of settings that control the monitoring behavior.
The monitor name that appears in dashboards and reports. For example, Customer Login.
– the monitor is enabled.
– the monitor is disabled.
– the monitor sends alerts. You can specify which alerts to send (availability, performance or both) in the Alerts section.
– the monitor does not send any alerts.
Download Project, Upload Project
Use these buttons to download the SoapUI project to your computer, and upload a new project. See Managing the SoapUI Project below.
The monitoring plan used for this monitor.
Run Interval (Minutes)
How often the monitor checks your website. Possible values depend on your monitoring plan.
Leave a note for yourself or other users. This note will appear on the AlertSite Dashboard when you hover over the icon. Note text can be up to 255 characters long.
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.
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.
- Rotated locations are not available for monitors that use Private Node Server locations (private monitoring stations installed on your local network).
- 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
If Rotate Locations is selected, you need to specify the number (subset) of 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 is Round Robin or SLA (MultiPOP), you need at least 2 locations per interval.
Enable Local Retry
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 to suppress the retry on errors.
Note: The retry consumes extra measurement credits.
Allow AlertSite QA Testing
Before releasing AlertSite updates, SmartBear runs regression tests to make sure that both existing and new functionality work correctly. Select 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.
AlertSite can keep SoapUI logs from test runs for later analysis. The logs include complete requests and responses (URL, headers, body, HTTP status code) and the details of any errors occurred. This can help troubleshoot failed tests.
Select the level of logs to store:
- Disabled – Do not store SoapUI test logs.
- Errors Only – (Default) Store SoapUI logs for just failed test steps.
- All Steps on Error – Store SoapUI logs for all test steps, but only if the test failed.
- All Steps – Always store SoapUI logs, even for successful runs.
The last 2 values are available for Usage-Based Monitoring accounts only, and consume 0.5 measurement credits per capture.
You can view SoapUI logs:
- in the test step details on the Monitor Runs dashboard,
- in the Detail report by clicking the camera icon.
You can also have the SoapUI log attached to email alerts if you configure alert recipients with the Attach server response to e-mail alerts option. This does not depend on the monitor’s Capture Level.
Optional. Used only for APIs accessible over HTTPS.
If you need to use a specific SSL or TLS version, select it from the list. Otherwise select Auto-Detect, and the monitor and server will select the protocol automatically.
Use Client Certificate
If your API server requires a client-side SSL certificate to access it, you need to upload your certificate or Java keystore file 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 Keystores. This approach works if you use AlertSite’s public locations.
If you use Private Node Server (InSite) locations, please send the certificate to SmartBear Support, along with your API monitor name, and your company name and customer ID from the > 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.
Enable Transaction Trace
This option enables or disables AppDynamics transaction tracing for the monitor (see AppDynamics Integration). If it is selected, AppDynamics captures server-side transaction snapshots for all API calls made by the monitor. The snapshots contain code-level details like the slowest methods and SQL queries, and can help troubleshoot performance issues. You can access these snapshots from the Monitor Runs dashboard.
Note: AppDynamics transaction tracing is supported in AlertSite Enterprise only.
This section shows various information about the SoapUI test the monitor runs, including:
- the project name,
- the test suite name,
- the test case name,
- the names of the steps in the test case.
This information is read-only. To select another test case to run, upload the project and select a new test case.
Select one or more locations to monitor you website from. For details, see Selecting Locations for Monitoring.
Here you can configure availability and performance alerts for the monitor or individual steps. 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.
Monitor Alerts and Step Level Alerts
If the monitor has multiple steps, you can configure alerts for the whole monitor or individual steps. Use these tabs to switch between monitor-level and step-level configuration.
Select the recipient groups that will receive alerts from this monitor. The recipient groups must have been previously created in Alerts > Alert Recipients.
If the monitor is not assigned to any recipient group, it sends alerts to all the recipients configured in your AlertSite account.
Note that 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.
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.
Monitor-specific notes that can be included in email and JSON alerts (availability alerts only), up to 255 characters long. Note that to actually add these notes to alerts, you need to configure alert templates to include the $ALERT_NOTE variable.
Select this to send alerts 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. Note that, for multi-step monitors, the response time thresholds should include the total response time for all test steps.
Click Download Project to download the zipped SoapUI project used by the monitor to your computer. You can open the downloaded project in Ready! API or SoapUI by using the File > Import Packed Project menu item.
To upload an updated or new SoapUI project for the monitor: