tip This documentation is for the old interface of AlertSite. If you use the new interface (AlertSite UXM), please see Create API Monitor From SoapUI Test.

API Monitoring

APIs, such as SOAP transactions, can be uploaded and managed in the AlertSite console from the ConfigureAPIs menu item. In this way AlertSite facilitates the migration of SOAP transactions from development and test within the SoapUI environment to performance measurement with AlertSite's worldwide monitoring locations.

You must have a Usage-Based Account or, if you have a Plan-Based Account, you must have an InSite Monitoring Location. In either case, you need an API Right to Use license to upload SoapUI API transactions. Contact your Sales Representative, listed in SupportAlertSite Contact, for more information.

AlertSite API Monitoring is valid with SoapUI Projects only.

The basic workflow between SoapUI and the AlertSite console can be illustrated as:

Workflow.PNG


SoapUI

This guide assumes that you are using SoapUI to create API transactions, such as SOAP, JSON, and REST. It is essential that you are knowledgeable about SoapUI before using AlertSite API.

If you do not already have SoapUI, download it from SoapUI Downloads.

Considerations for SoapUI Projects

An API monitor in AlertSite runs a single SoapUI TestCase. The TestCase needs to be properly configured, in particular, with assertions. Assertions function similarly to timeout errors (Status 2), keyword errors (Status 5), and HTTP errors (Status 7). Without assertions, AlertSite cannot determine, beyond connectivity, that the API is functioning as expected.

If your SoapUI project contains several TestSuites or TestCases, we recommend that you create and use a reduced copy of the project that contains just the TestCase you want to run in AlertSite. This is especially important when using InSite locations, as it will help reduce the load on your InSite.

The size of your SoapUI project file (the XML file) must not exceed 12,000,000 bytes.

Once you have created and configured your SoapUI project, continue below.

Exporting SoapUI Project

To get started uploading and monitoring your API transaction, export the Project from the SoapUI GUI:

  • Right-click on the Project you want to monitor.
  • Select Export Project from the menu.
  • In the dialog box, navigate to the folder you want to save the Project in.
  • Enter a name for the Project and click Save.

The Project will be saved to disk in a compressed .zip file.

This is all that is required in the SoapUI GUI at this stage.

AlertSite Console

Now that you have your SOAP transaction ready for monitoring, log in to the AlertSite Console. Hover over Configure in the menu bar and select APIs from the dropdown:

New_API_Config_Menu.PNG


From the Configuration: APIs page, click the button labeled Add a new API test in the upper right.

New_Add_API_button.PNG


You will be presented with the Add a New API Device page. This contains a field that you can browse to select a Project to upload to the AlertSite device:

New_Add_a_New_API_device.PNG


Adding a New API Device

To add an API device in the AlertSite Console, you must first upload the SoapUI Project that you exported and saved to disk from the SoapUI GUI and then follow a few simple steps to create the API device:

  • Click the Browse button next to the Project file: field.
  • Navigate to the folder where you stored the Project zip file.
  • Click on the zip file name; the File Upload dialog will close and the Project zip file will appear in the Project file: field.
  • Click the Upload Project File button.
  • The Project file section will indicate that the upload was complete and a new section for selecting the TestSuite and TestCase will appear:
    New_Upload_Complete.PNG
  • Choose the TestSuite and TestCase from each dropdown.
  • Click the Create API Device button.

A new tab with the Manage API device page will be created so that you can easily select additional TestSuites and/or TestCases from the Add a New API Device page and create additional API devices without having to re-enter the page. The Manage API device screen will appear as:

New_Newly_created_API_Device.PNG


API Device with Usage Based Monitoring Site Plan

If you are using a Usage Based Monitoring plan, you must validate the TestCase by performing a successful Test On Demand. Click the Test On Demand button to run a test of the API from a remote location

Run_TOD.PNG


The Test On Demand screen will close immediately after a successful test, and the page will display:

Successful_TOD_msg.PNG


If the test is not successful, the Test On Demand screen will persist so that you can click the View test results button to determine the nature of the error. This error must be resolved before the API device can be enabled:

  1. Modify the Project in SoapUI.
  2. Re-export it to disk.
  3. Click the Manage API Project button in the Manage API device screen.
  4. Click the Upload Project button to overwrite the failing project file.
  5. Select the modified Project by clicking the Browse button.
  6. Click the Upload Project File button to replace the failing project with the corrected one.
  7. Click the Test On Demand button to validate the API device.

After a successful Test On Demand, select Enabled from the Monitoring Is dropdown.

API Device with InSite Site Plan

If you want to monitor the device from your InSite appliance:

  1. Click the Locations button in the upper right to display the Monitoring Locations list.
  2. De-select default locations and select your InSite location, making it the Primary.
  3. Click Submit in the upper right and then return to the Manage API device screen by clicking on the API device name in the upper left.
  4. Select the InSite plan from the Site Plan dropdown.
  5. Select Enabled from the Monitoring Is dropdown.
  6. Click Submit.

A successful Test On Demand run is not required.

Using SSL Certificates and Keystores

If your API requires a client-side SSL certificate or a keystore, you need to upload the certificate or keystore to AlertSite and assign it to your API device:

  1. From the top menu, select Configure → SSL Certificates.
  2. Click Add a New Certificate and upload your certificate or keystore.
  3. Open the API device settings and select the certificate from the SSL Certificate list.
  4. Run Test on Demand to verify that AlertSite can reach your API using the provided certificate or keystore.

For details, see Using SSL Certificates and Java Keystores.

Device Settings

You may also modify any of the other Device Settings fields on the configuration page:

  • Transaction Name
  • Monitoring Type
  • Check Every (monitoring interval)
  • Monitoring Is (Enabled/Disabled)
  • Notify on Error

You may also select any of the following check boxes:

  • Disable Local Error Verification
  • Disallow AlertSite QA Testing

You may also change the Capture Level to Error Only. With this setting, Performance Reports will produce a capture of the source code when an error occurs. Viewing this source will assist in troubleshooting the cause of the error.

The soapUI Monitor Configuration section will display the TestSuite and TestCase being monitored for this SOAP transaction device.

The provisioned Manage API device page will look similar to:

New_Enabled_API_Device.PNG


Monitoring, notification, and reporting are managed the same way as site and DéjàClick devices. Timings are reported in milliseconds from SoapUI, so reports will show data out to 3 decimal places.

Managing Your API Device

Once your API device has been configured, you may make changes as needed, including downloading the SoapUI Project or overwriting the Project with another exported SoapUI Project file, or any of the other Device Settings listed above.

  • Select ConfigureAPIs in the menu bar.
  • Click on the Device Name you want to modify.
  • In the Manage API device page, click the Manage API Project button in the upper right to display the page. This adds a Manage SoapUI project file section at the top:
    Manage_Device_fields.PNG
  • Make changes as required:
    • Download the Project to your desktop so you can import it into SoapUI for modification.
    • Upload a different Project to the device, overwriting the current one.
    • Click the Locations button to change monitoring locations.
    • Modify any of the Device Settings as needed.
  • Click the Submit button to save changes.

If you change an existing API device by uploading a modified version of the Project or a different Project to the same API device, the Edit existing API Device page will be presented:

New_Modify_Existing_Device.PNG


Click the Modify Existing API Device button to overwrite the Project in the AlertSite monitoring servers. The Manage API device screen will be displayed and you will need to run Test On Demand in order to enable monitoring of the new API.

The modifications will be reflected in the Dashboard upon refresh.

Back to top
Back to index

© 2016 SmartBear Software --
Syndicate this site RSSATOM