Monitoring endpoints with Synthetic tests

Creating a test by using the wizard

To create a Synthetic test, complete the following steps:

1. Go to Synthetic Monitoring > Test.
2. Click Add Synthetic Test. The Create Synthetic Test wizard is displayed.
3. In Step 1: Select type, select the type of test that you want to create:
   • API Simple for an HTTP GET method to a URL of your choice. In Instana 250 and earlier versions, it is labeled as HTTPAction.
   • API Script to upload a JavaScript file or enter the script into the input box. In Instana 250 and earlier versions, it is labeled as HTTPScript.
   • Browser Simple to check a webpage for HTTP errors.
   • Browser Script to simulate user actions with your web application by using a Node.js script or a recorded Selenium IDE script.

4. Click Next, the Step 2: Request details dialog is displayed.

   • For an API Simple test, provide the URL. For the test to be run successfully, the URL must be in one of the following formats https://www.YourCompany.com or http://www.YourCompany.com. The portion https://www or http://www is required. To create a Synthetic test with a different HTTP method, use the Open API. Refer to the Synthetic monitoring section of the Open API documentation.

   

   • For an API Script test, upload a file or enter the script in the box. Basic JavaScript validation is run against the script.

• For a Browser Simple test, provide the URL of the webpage. Select the Deploy PoP to run the test at this location.

• For the Browser Script test, upload a Node.js script or a recorded Selenium IDE script. Select the Deploy PoP to run the test at this location. Basic JavaScript validation is run against the Node.js script. No validation is run for a Selenium IDE script.

• For all test types, select the locations for the test to run.

5. Click Next, the Step 3: Scheduling dialog is displayed, select the test run frequency.

Select the frequency by using the slider. You can select any interval from 1 minute to 120 minutes. The interval that you select is applied on each PoP where the test is assigned to run the test repeatedly.

6. Click Next, Step 4: Provide details dialog is displayed, identify the test.

Give the test a name (required) and a description (optional). If the test is associated with an application that is also monitored by Instana, you can select the application name from the list, or use the search button to find the correct application name. You need not assign a name for the application. You can create a Synthetic test that is not associated with an application.

Creating a test by using advanced mode

To create a Synthetic test, complete the following steps:

1. Go to Synthetic Monitoring > Test.
2. Click Add Synthetic Test. The Create Synthetic Test wizard is displayed.
3. Click Switch to Advanced Mode.
4. Complete one of the following steps:
   • To test an API, select API then select one of the following test types:
     • To test a single REST API, select API Simple Test.
     • To test the sequence of multiple REST APIs, select API Script Test.

• To test a webpage, select Browser then select one of the following test types:
  • To test a single webpage, select Browser Simple Test.
  • To test web applications, select Browser Script Test.

• To test an SSL Certificate, select SSL Certificate, then click on Select button since test type is selected by default.

5. In Configuration: How will this test work?, enter the details depending on the test type that is selected in step 4.

   • For API Simple test, provide the URL or API endpoint. For the test to run successfully, the URL or API endpoint must begin with 'https://www.YourCompany.com' or 'http://www.YourCompany.com'. The portion 'https://www' or 'http://www' is required. To create a Synthetic test with a different HTTP method, use the Open API. See Synthetic monitoring section in the Open API documentation.

   Optional: Define the following elements for an API Simple test:

   • Header: You can add one or multiple header elements. Each header element is added to the test by the PoPs when the test is run. You can also use $secure to refer to your user credential or $synthetic to refer to an environment variable in the Value field, such as $secure.API_TOKEN or $synthetic.LOCATION.
   • Body: You can define specific content to include in the body of the request. Only one body element can be added. The body element is added to the test by the PoPs when the test is run.
   • Validation String: You can define a string that should appear in the response when the test has run. Only one validation string element can be added. When the test is run, if the string is missing, the test fails.
   • expectStatus: You can define the expected HTTP return code for the test. If the return code does not match when the test has run, the test fails. Only one expectStatus element can be added. Use the drop-down menu to select the desired expect condition. Use Add Validation to add more than one expect condition. You can add one of each type of expect condition to a test.
   • expectMatch: You can provide a regular expression to check when the test runs. Only one expectMatch element can be added. If the expression is not matched when the test is run, the test fails. Use the drop-down menu to select expectMatch. Use Add Validation to add more than one expect condition. You can add one of each expect condition to a test.
   • expectJson: You can provide a json snippet to check when the test runs. Only one expectJson element can be added. If the json file is not matched when the test is run, the test fails. Use the drop-down menu to select expectJson. Use Add Validation to add more than one expect condition. You can add one of each expect condition to a test.
   • followRedirect: This flag is set to true by default. You can change this behavior to disallow redirection by deselecting the box.
   • allowInsecure: The flag to enable testing of HTTP endpoints. The flag is set to true by default. You can change this behavior and prevent insecure URLs for your test by deselecting this box.

   

   • For API Script test, select Add Script. An additional view is displayed where you can enter the script in the box, upload a single file, or upload a bundled set of scripts in a zip file. For more information about how to create a bundled set of scripts see Creating a bundled api script test.

   If you upload a single script file, the contents of the file appear in the text box. Basic JavaScript validation runs for a single uploaded script and a manually entered script. You can correct the script in the text box. If you uploaded the script and changed it in the text box, the script file is treated as if it was manually entered. If you upload a bundled set of scripts, you must enter the name of the main script in the input box.

6. Select Add to accept the script or bundle and return to the Configuration section view.

   

   

   • For Browser Simple test, provide the URL of the webpage to be tested. For the test to run successfully, the URL must have the form 'https://www.YourCompany.com' or 'http://www.YourCompany.com'. The portion 'https://www' or 'http://www' is required.

   

   • For Browser Script test, select Add File. An additional view is displayed where you can upload a single Node.js script, a bundle of scripts, or a single Selenium IDE script.

   If you upload a Node.js script file, the contents of the file appear in the text box. Basic JavaScript validation runs for the script. If you upload a bundle or a Selenium IDE script, no validation runs.

7. Select Add to accept the file and return to the Configuration section view.

   

   

• For SSL Certificate test, provide the hostname, port and the number of days before certificate expiration when the test should begin to fail.

  

The remaining sections in advanced mode apply to all types of tests.

8. In the Locations section, click Select Location. A list of locations that are available to you and that support the test type is displayed. Select the checkboxes for your choice of locations, or use the search box to find a location and select its checkbox. Select Add Locations to add the location and return to the Locations section. To remove a location from the selected locations, use the minus icon at the end of the row.

9. For API and Browser test types, the Schedule section is the same in advanced mode and wizard mode. Select the frequency by using the slider. You can select any interval from 1 minute to 120 minutes. The interval that you select is applied on every PoP where the test is assigned to run repeatedly.

• For SSL Certificate test in advanced mode, use the slider to select an interval from 1 hour to 24 hours. The default frequency for this test type is one run every 24 hours from each selected location.

10. In the Identify section, the Name parameter is required. The following parameters are optional:

• Description: The description of the test.
• Application: If the API or endpoint that is being tested is associated with an application that is also being monitored with Instana, you can associate the test with the application. Use the list and extend it by selecting Load more or use the search box to find the application name and select it. Only a single application name can be selected.

11. In the Custom Property section, you can specify one or more key-value pairs as custom properties. These properties become part of the test definition and the test results. You can use these properties to locate, sort, or filter tests and test results. Select Add Property to add additional custom properties. The number of properties that can be added to a test has no limit. If you add a property and want to remove it before creating the test, select the trash icon at the end of the row for that property.