Create a Monitor

You create monitors via the Functional Monitoring UI or by uploading test suites written in BAT, a Behavior Driven Development (BDD) language. Both methods enable you to create tests against one or more endpoints, and to create test schedules that run at specified intervals.

This procedure describes creating monitors via the Functional Monitoring UI.

Before You Begin

  • Ensure that your user ID has the Anypoint Monitoring User permission and that it is assigned the Exchange Administrators role. An administrator for your organization can grant this permission in Anypoint Access Management. For details, see Roles.

  • Determine which endpoints to test and by which REST methods to test them.

  • Determine the expected return status codes.

  • Determine the test interval.

    The shortest interval is 15 minutes. Monitors can also run hourly, daily, weekly, or monthly. The schedule begins immediately after creating the monitor, and you can modify the schedule after the monitor has been created. For example:

    • Set an hourly schedule to start at a certain number of minutes after the hour begins.

    • Set a daily, weekly, or monthly schedule to start at a certain time of day.

  • Determine the location in which to execute the monitor.

  • Determine if the requests should include additional headers.

  • For optional reporting, obtain one of the following pieces of information:

    Reporting Tool Required Information

    PagerDuty

    RoutingKey

    Slack

    Webhook

    SumoLogic

    Endpoint

    Email

    Email address

Procedure

To create a monitor:

  1. Click Create Monitor in the Functional Monitoring section of Anypoint Monitoring.

  2. Under Step 1 - Setup the monitor, specify a monitor name. Additionally, toggle Validate SSL Certificate to specify if the monitor needs to use self-signed certifications.

  3. Click the Step 2 - Select endpoints tab.

  4. Populate the fields with the information gathered in "Before You Begin."

    You can preview the test by clicking Run now under Preview the result of your monitor.

  5. Click the Step 3 - Set notifications tab.

  6. Optionally configure a notification.

  7. Click Create Monitor.

The Monitor Detail view appears, and includes the following actions:

  • Click Run (afm ui run button) to immediately execute a monitor.

  • Click View Monitor History (afm ui history button) to view a list of recent monitor runs.

  • Click More (afm ui more button) > Edit Monitor to modify a monitor.

  • Click More (afm ui more button) > Download Monitor to download a monitor as BAT source.

  • Click More (afm ui more button) > Delete Monitor to delete a monitor.

Additional displayed information includes:

  • The most recent test duration

  • Time elapsed since the monitor started running

  • The average response time for each activity (for example, DNS lookup), separated by day

  • The previous five test execution results, as indicated by PASSED or FAILED (depending on if the endpoints returned expected codes)

  • A table displaying the current test schedules

  • Each endpoint asserted with its HTTP method

Return to the homepage by clicking Back to Monitors.

Tests silently fail when run time exceeds 120 seconds. As a workaround, download the monitor and split the tests across multiple monitors via the BAT CLI. Run and time each test to ensure their running times are under 120 seconds; then, upload the monitors.

Alternatively, to run a monitor for more than 120 seconds, download the monitor and run it from the BAT CLI.

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub