Create a Monitor

To set up the Synthetic Monitoring feature, you must create a monitor to monitor the availability and performance of your application across geographical locations and send metrics to Oracle Cloud Infrastructure.

If you want to create the Scripted Browser and Scripted REST monitor types, you must ensure that you've created a script. For information, see Create a Script.

To create a monitor:

  1. Navigate to the Synthetic Monitoring page.
  2. On the left pane, ensure that Monitors is selected.
  3. On the left pane, select the compartment and the APM domain in which you want to create the monitor.
  4. Click Create Monitor.
    The Create Monitor wizard is displayed.
  5. On the Monitor Definition page:
    1. Name: Enter a unique name for the monitor.
    2. Type: Select one of the following monitor types:
      • Browser: Tests the performance of a single URL loaded by a browser.
      • Scripted Browser: Tests the performance of a complete user transaction workflow recorded in a .side script file.
      • REST: Tests the performance of a single URL loaded by a REST call.
      • Scripted REST: Tests the performance of a complete user transaction workflow recorded in a .js script file.
    3. Update the fields displayed based on the monitor type selected in the previous step:
      • For the Browser monitor type:
        1. Base URL: Specify the base URL on which to run the monitor.
        2. Verify Response ContentOptional: Optionally, add a string to verify expected response content.
        3. Options: Optionally, select the following check boxes:
          • Verify SSL: Select this option to verify the validity of the SSL certificate.
          • Override DNS: Select this option to specify the IP address to which the target's domain name will resolve, instead of using the standard DNS resolution.
      • For the Scripted Browser monitor type:
        1. Script: Select a script file from the drop-down list, which is populated with the names of the .side scripts you've created.
        2. Base URLOptional: Based on the selected .side script file, this field is populated with the base URL on which the monitor is to be run. Optionally, you can also specify the base URL in this field.
        3. Script Parameters: If script parameters are defined in the contents of the script file, then they are displayed in the Script Parameter fields and you can choose to replace the parameter values. Note that the parameter value is not displayed if the Value is secret option is used when creating or uploading the script.
        4. Options: Optionally, select the following check boxes:
          • Verify SSL: Select this option to verify the validity of the SSL certificate.
          • Override DNS: Select this option to specify the IP address to which the target's domain name will resolve, instead of using the standard DNS resolution.
      • For the REST monitor type:
        1. Base URL: Specify the base URL on which to run the monitor.
        2. Request Configuration Method: Select a request configuration method: GET or POST. For the POST method, you can optionally enter the request payload information in the Request Body field.
        3. Authentication Type: Select a type of authentication:
          • None: Select this option if no authentication is required.
          • Basic Auth: Select this option if basic authentication is required and specify the User Name and Password.
          • Bearer Token: Select this option if bearer authentication is required and specify the Token.
          • OAuth: Select this option if open authentication is required and specify the Authentication Scheme and information in the fields that are displayed based on the authentication scheme.
        4. Query Parameters: Optionally, specify the request configuration query parameters.
        5. Header Parameters: Optionally, specify the request configuration header parameters.
        6. Response Validations: Optionally, select:
          • Response Code and specify valid HTTP status codes such as 200 and 401.
          • Verify Response Content to add a string or REGEX to verify expected response in response headers and body.
        7. Options: Optionally, select the following check boxes:
          • Verify SSL: Select this option to verify the validity of the SSL certificate.
          • Follow Redirects: Select this option to follow redirects.
          • Override DNS: Select this option to specify the IP address to which the target's domain name will resolve, instead of using the standard DNS resolution.
      • For the Scripted REST monitor types:
        1. Script: Select a script file from the drop-down list, which is populated with the names of the .js scripts you've created.
        2. Base URLOptional: Based on the selected .js script file, this field is populated with the base URL on which the monitor is to be run. Optionally, you can also specify the base URL in this field.
        3. Script Parameters: If script parameters are defined in the contents of the script file, then they are displayed in the Script Parameter fields and you can choose to replace the parameter values. Note that the parameter value is not displayed if the Value is secret option is used when creating or uploading the script.
        4. Options: Optionally, select the following check box:
          • Override DNS: Select this option to specify the IP address to which the target's domain name will resolve, instead of using the standard DNS resolution.

    Click Next.

  6. On the Run Settings page:
    1. Vantage Points: Select the vantage points on which you want the monitor to run. If you've set up a Dedicated Vantage Point, then it is also listed in the drop-down list and can be selected. For information on Dedicated Vantage Points, see Use Dedicated Vantage Points.
    2. Select one of the following radio buttons to determine the frequency of monitor runs:
      • Interval: Select this radio button to determine the interval of time between each monitor run.
      • Run Once: Select this radio button if you want the monitor to run only once. If the Run Once radio button is selected, the Scheduling Policy drop-down list and the Interval Between Runs (minutes) field are disabled.
    3. Scheduling Policy: Select one of the following options to stagger the monitor runs on the selected vantage points:
      • All: Select this option to run the monitor simultaneously on all selected vantage points.
      • Round Robin: Select this option to schedule the monitor run sequentially on each vantage point. This functionality works in tandem with the value specified in the Interval Between Runs (minutes) field. For example, if 10 minutes is specified in the Interval Between Runs (minutes) field and the monitor is to run on five vantage points, then the monitor will run on the vantage points sequentially with an interval of ten minutes between each run. The total duration of the monitor runs on all vantage points will then be 50 minutes, after which the sequential monitor run will begin again.
      • Batched Round Robin: Select this option to schedule the monitor run sequentially on batches of vantage points. This functionality works in tandem with the values specified in the Interval Between Runs (minutes) and Sub-interval Between Runs (minutes) fields. In this scenario, monitors are scheduled to run on batches of vantage points and the interval between each run is specified in the Sub-interval Between Runs (minutes) field. The value in the Interval Between Runs (minutes) field denotes the total time taken for the monitor run on all batches.

        The number of vantage points in each batch is automatically calculated based on the number of selected vantage points and the values specified in the Interval Between Runs (minutes) and Sub-interval Between Runs (minutes) fields. For example, if there are 7 vantage points, Interval Between Runs (minutes) = 10 minutes, and Sub-interval Between Runs (minutes) = 5 minutes, then two batches are created. The first batch of vantage points will have four vantage points and the second batch will have three.


        Batch Round Robin

    4. Interval Between Runs (minutes): Specify the number of minutes between monitor runs. The default interval duration is 10 minutes. For the REST monitor type, you can specify one minute as the minimum duration of the interval between monitor runs, and for the other monitor types, you can specify five minutes as the minimum duration.

      Note that if the Batched Round Robin option is selected in the Scheduling Policy drop-down list, then the value selected in the Interval Between Runs (minutes) field denotes the total time taken for the monitor run on all batches.

    5. Sub-interval Between Runs (minutes): Specify the number of minutes between monitor runs on batches of vantage points. Note that this field is only displayed if the Batched Round Robin option is selected in the Scheduling Policy drop-down list.
    6. Timeout: Specify the timeout value. This denotes the maximum runtime allowed and if the monitor runtime does not complete within this time, it will be stopped and marked as a failure. Note that the Interval Between Runs value must be about three times more than the Timeout value.
    7. Enable Retry: Select this check box to retry execution in case of failure. Note that this check box is selected by default.
    8. Enable Network Collection: Select this check box to enable data collection from the network and monitor network performance. Note that for a Scripted REST monitor, this check box is only displayed if the Base URL is specified on the Monitor Definition page:

      On selecting the Enable Network Collection check box, the following options are displayed:

      • Protocol: Select a network protocol.
      • Probe Mode: Select a probe mode for the TCP network protocol. Note that the Probe Mode option is only available for the TCP network protocol.
      • Probe Per Hop: Specify the number of probe packets sent per hop.

    Click Next.

  7. On the Tags (Optional) page, you can choose to use the Tagging metadata system to organize and track the monitors, and click Next.
    If tags are added to the monitor, you can filter and view monitors on the Monitors page using Tag Filters on the left pane.

    For information on Tagging, see Tagging Overview.

  8. On the Summary page, review the summary of the monitor, and click Create.
The <name of the monitor> page is displayed. This page includes two tabs: Monitor Information with information such as the interval value or Run Once option, timeout value, vantage points, the type of monitor, and the OCID assigned to it. Note that for the REST monitor type, the Monitor Information also includes Configuration information such as the Authentication Type and Request Configuration Method, and you can click View Details to view the configuration details specified when creating the REST monitor type. The Tags tab has information about the tags added to the monitor, if any.

You can also use the options available on the top of the page to perform the following actions on the monitor:

  • Edit: Click to edit monitor information.
  • Clone: Click to clone the monitor.
  • Disable: Click to disable the monitor.
  • Add Tags: Click to add tags to the monitor.
  • Delete: Click to delete the monitor.

On navigating back to the Monitors page, you'll find the newly created monitor listed. You can select the monitor and click Actions to perform the same tasks listed in the preceding list. In addition, one of the following options will also be listed in the Actions menu:

  • Run Once: Click to run the monitor. This option is only displayed if the Run Once check box was selected when creating the monitor.
  • Run Now: Click to run the monitor immediately. This option is only displayed for monitors that have scheduled monitor runs and is not displayed if the Run Once option was selected when creating the monitor. If you select the Run Now option, a new instance of the monitor is created and is executed just once. This does not impact the existing monitor run schedule, and for the Run Now mode, a separate set of results is listed in a new row on the Monitors page.