API Endpoint Monitor Settings

This topic describes the configuration settings for API endpoint monitors. These monitors make an HTTP GET, POST or HEAD request to the specified URL, and track the status (OK/error) and response time. You can customize the monitoring settings and locations to adjust the monitoring process.

Notes:

Common

Monitor Name

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

Monitoring

On – the monitor is enabled.

Off – the monitor is disabled.

Alerting

On – the monitor sends alerts. You can specify which alerts to send (availability, performance or both) in the Alerts section.

Off – the monitor does not send any alerts.

Validate API Settings

Click this button to send a sample request and review the response.

Main

Basic

Measurement Plan

The monitoring plan used by the monitor. You cannot change the plan for existing monitors.

URL

The URL to send the request to.

Port

The website port number. If your website uses the default port (80 for HTTP or 443 for HTTPS), leave it blank.

Run Interval (Minutes)

How often the monitor checks your website. Possible values depend on your monitoring plan.

Timeout (Seconds)

How long AlertSite waits for your server to respond before reporting a timeout error. Default value is 30 seconds.

Monitor Note

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

Payload

Request Method

The HTTP method for the request – GET (default), POST or HEAD. For POST requests, you need to enter the POST Data (for example, JSON or web form fields) and, optionally, POST Headers. Select HEAD if you want to request only the headers but not the response content.

POST Headers

Custom headers for the POST request.

For JSON POST requests, you usually need:

Content-Type: application/json
Connection: close

You may also need the Accept: application/json header.

For SOAP 1.2 requests, use:

Content-Type: application/soap+xml; charset=utf-8
Connection: close

For SOAP 1.1 requests, use:

Content-Type: text/xml; charset=utf-8
SOAPAction: "http://your_soap_action"
Connection: close

POST Data

Enter the data to be sent in the POST request body. For example, JSON or SOAP (XML) data.

To post web form fields, you can enter the name=value pairs one per line:

firstname=John

lastname=Doe

company=ABC Corp

But, if you have several fields with the same name, enter the payload as it would be encoded in an actual HTTP request, and select POST the data as entered above. The payload is encoded as follows: combine all name=value pairs together separated by "&", replace spaces with "+", and apply URL encoding to all non-alphanumeric characters. For example, this data:

name=Anne O'Brien

email=aobrien@company.com

email=anne@mymail.com

is encoded as:

name=Anne+O%27Brian&email=aobrien%40company.com&email=anne%40mymail.com

POST the data as entered above

Select this ONLY if POST Data contains URL-encoded form fields AND POST Headers are empty.

Keywords

AlertSite can look for a text string in the response, and send alerts if this text is not found or found.

Type of Match

Plain Text or Regular Expression. For the regular expression syntax, see www.regular-expressions.info.

Keyword or Phrase

The text or regular expression to look for.

Finding This Keyword Is an Error

To alert if the text does not appear on the page, leave this check box cleared. To alert if the text appears on the page (for example, if it is an error message), select this check box.

HTTP Authentication

If the request requires basic authentication, enter the User ID and Password here.

Advanced

Monitoring

Monitoring Mode

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:

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.

Resolve DNS

DNS resolution (or DNS lookup) determines the IP address of a domain name by using the network of Domain Name Servers.

To monitor an URL with the domain name, enter the URL on the Main page and select Resolve DNS.

To monitor by an IP address, clear Resolve DNS and specify the IP address.

IP Address

Available only when Resolve DNS? is unselected. Specifies the IP address of the server to monitor.

TCP Traceroute on Error

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.

Alert on Content Change

If this is selected, AlertSite tracks the response size (in bytes), and sends an alert if the response size changed since the last check. Clear this check box to ignore response size changes.

HTTP Options

HTTP Version

The HTTP version to use for the request. 1.1 is most commonly used.

Emulate Browser

The User-Agent header for the request. For POST requests, you can specify a custom User-Agent string in POST Headers.

Report Redirects as Errors (HTTP 301/302)

If this option is selected, the monitor will report an error (status 8) if the response redirects to another URL by returning HTTP status 301 or 302. This does not apply to client-side redirects made via META refresh tags or JavaScript functions in HTML responses.

To use this option, you need to unselect Follow Redirect.

Report Authentication Challenges as Errors (HTTP 401/403)

How to handle responses that have HTTP status code 401 or 403, which means the server requires authentication. If this option is unselected, the monitor will report the OK status. If it is selected, the monitor will report an error (status 7).

Note that for Basic authentication, you can specify the User ID and Password in the monitor settings.

Use Caching – Simulates a Repeat Visitor

If this is selected, the monitor caches the response from your web server, so that subsequent monitor runs simulate a returning visitor rather than a new visitor.

Use Compression

If your web server supports gzip compression, select this check box to receive gzip-compressed data from your server to reduce the data size.

Follow Redirect

If this option is selected and the monitor gets a redirect response (HTTP status 301 or 302), it will resend the request to the new URL.

Note: Monitors follow only one redirection.

Transaction Trace

This option enables or disables AppDynamics transaction tracing for the monitor (see AppDynamics Integration). If it is selected, AppDynamics captures transaction snapshots for HTTP requests made by the monitor. The snapshots contain server-side performance details, such as the slowest code methods and SQL queries. You can access these snapshots from the Monitor Runs dashboard.

Note: AppDynamics transaction tracing is supported in AlertSite Enterprise only.

Fullpage Options

If the response is an HTML page, you can have AlertSite check both the page and its linked images, JavaScript, CSS and other files. This is called fullpage monitoring.

Fullpage Interval (Minutes)

The frequency of page objects checking. This interval must be a multiple of the Run Interval. Select -1 to disable fullpage monitoring.

Object Timeout (Seconds)

How long the monitor waits for a page asset (image, JavaScript file, CSS file, and so on) to load before reporting a timeout.

Fullpage Alerts

If you enabled fullpage monitoring, choose whether you want to receive alerts based on the status of images, JavaScript, CSS and other files used on the page (status codes 700x).

Alert on page asset errors

Select this option to send an alert if the monitor finds an error when loading a page asset.

Alert and report if page assets are missing or new

Select this option to send an alert if some page assets are missing or new assets have been added since the last check.

Alert and report if the size of a page asset changes

Select this option to send an alert if the size of some page assets has changed since the last check.

Locations

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

Alerts

Here, you can enable and disable availability and performance alerts for the monitor. Note that to receive alerts, you need to configure alert recipients. By default, the monitor sends alerts to all configured recipients, but you can target alerts to specific recipients by using recipient groups.

Availability Alerts

Select this 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

Arbitrary monitor-specific information (up to 255 characters) that can be included in availability alerts sent via email. For example, you can specify the login and password used in a transaction – so the alert recipients do not have to look them up in the monitor configuration.

Default alerts do not include these notes. You will need to configure custom alert templates that would include the $ALERT_NOTE variable.

Performance Alerts

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.

See Also

© 2016 SmartBear Software. All rights reserved.      Terms of Use · Privacy Policy