Endpoints

Synthetic monitoring also provides availability checks for custom URLs without the use of agents. You can configure a custom URL by either uploading a postman collection or manually entering the configuration details. You can group these endpoints under a group and can view the overall status as the aggregated state of all the metrics. You can see that the URL availability column is color coded based on the conditional rules that you have defined.

Viewing groups

  1. Navigate to Synthetic monitoring > Endpoints. The Availability tab is selected by default.
  2. Click All groups tab. Information related to the groups is available.
  3. Select the Avg health Status drop-down list and select the status you want to view.
  4. Sort by Group name, Avg health Status, and Number of endpoints from the Group name drop-down list.
  5. Click the    icon to delete or add endpoint to the group.

Creating a group and adding an endpoint

  1. Navigate to Synthetic monitoring > Endpoints. The Availability tab is selected by default.
  2. Click Create group. You can also click the    icon to search for an existing group.
  3. In the Create group window, enter a group name in the Group name field.
note

Do not enter special characters in the group name.

  1. Click Create group.

  2. Click Add endpoint to the group to check the endpoint availability.

  3. In the Add endpoint window, select the group from the drop-down list to which you want to add the endpoint.

  4. Do either of the following:

    7a. Select Upload postman collection by either uploading it or dragging and dropping the JSON file.

    7b. Select Fill details and manually enter the following endpoint details.

    WindowAction
    Basic Information:Enter the Endpoint(URL), Endpoint type, and the URL alias and click Next.
    Authorization detailsSelect authorization type from the Authorization type drop-down list and click Next. Selecting OAuth2.0 allows you to configure authorization token for an application’s endpoint so that you can authorise endpoint monitoring to obtain limited access to the endpoint.
    Request Details:Select Endpoint check type, enter Expected status code, and HTTP headers and click Next. Note: Click + Add Key and Value to add more rows.
    Additional options:Enter Check interval (seconds), Timeout (seconds), and Permalink URL.

  5. Set the values for availability and response time in good (Green font) and poor (Red font) state in the Conditional rules window.

  6. Click Save endpoint.

    note

    You cannot add more than 100 endpoints and groups.

Adding an endpoint to an existing group

  1. Navigate to Synthetic monitoring > Endpoints. The Availability tab and the All groups tab are selected by default.

  2. The groups you have already created are listed under Showing all groups.

  3. Click the    icon in the group you want to add an endpoint.

  4. Click Àdd endpoint.

  5. In the Add endpoint window, select the group from the drop-down list to which you want to add the endpoint.

  6. Do either of the following:

    6a. Select Upload postman collection by either uploading it or dragging and dropping the JSON file.

    6b. Select Fill details and manually enter the following endpoint details.

WindowAction
Basic Information:Enter the Endpoint(URL), Endpoint type, and the URL alias and click Next.
Authorization detailsSelect authorization type from the Authorization type drop-down list and click Next. Selecting OAuth2.0 allows you to configure authorization token for an application’s endpoint so that you can authorise endpoint monitoring to obtain limited access to the endpoint.
Request Details:Select Endpoint check type, enter Expected status code, and HTTP headers and click Next. Note: Click + Add Key and Value to add more rows.
Additional options:Enter Check interval (seconds), Timeout (seconds), and Permalink URL.
  1. Set the values for availability and response time in good (Green font) and poor (Red font) state in the Conditional rules window.
  2. Click Save endpoint.

Deleting a group

  1. Navigate to Synthetic monitoring > Endpoints. The Availability tab and the All groups tab are selected by default.
  2. The groups you have already created are listed under Showing all groups.
  3. Click the    icon in the group you want to delete.
  4. Click Delete.
  5. Confirm that you want to go ahead with the deletion.
  6. Click Delete group.

Managing endpoints

  1. Navigate to Synthetic monitoring > Endpoints. The Availability tab is selected by default.

  2. Click All endpoints. All the endpoints are listed.

  3. Click the    icon visible at the end of the endpoint row.

  4. Perform any of the following actions:

    4a. Click Delete endpoint to delete an endpoint. In the Delete endpoint window click Delete endpoint.

    4b. Click Edit endpoint to edit an endpoint. In the Edit endpoint window, edit the fields with the required details and click Apply changes.

    4c. Click Duplicate endpoint to duplicate an endpoint. In the Duplicate endpoint window, check the endpoint configurations and click Save endpoint.

    4d. Click Endpoint details to view the endpoint details.

  5. Click the Schedule test icon to schedule a test and enter the following details in the Schedule test screen.

    • The Title field is prefilled with the endpoint name.
    • Select the test plan ID from the Test plan ID drop-down list.
    • Enter the date and time in the Cron format for the test to execute automatically at the specified time and date.

For each configured endpoint, a synthetic test (similar to the above defined tests) can be created and scheduled multiple times as jobs. The reports for these tests define the success/failure and total time taken for each test step.

With these capabilities, Synthetic monitoring can proactively ensure that your web application is not affecting the real-user experience by providing you with the visibility into performance, errors, and availability.