API Functional Monitoring (AFM) Release Notes

These release notes cover the following versions of this product:

2.8

March 20, 2024

What’s New

You can now choose Cloudhub 2.0 servers as a deployment target. + For more information, refer to Create a Private Location.

2.7

July 11, 2023

What’s New

The BAT playground is now integrated into the API Functional Monitoring UI. You can select from a menu of example tests in the Functional Monitoring editor when creating a monitor.

See Getting Started Writing Tests.

2.6

February 1, 2023

What’s New

The UI component contrast is now increased for better visibility and accessibility.

2.5

December 15, 2022

What’s New

The Validate SSL Certificate option for safe self-signed certifications is now toggled on by default for each of a monitor’s endpoints. The option is now set for each endpoint rather than for the entire monitor. To allow unsafe self-signed certifications for an endpoint, you must toggle Validate SSL Certificate off for that endpoint.
You can now log in to Anypoint Platform through a connected app using the BAT CLI login command. This provides an alternative way to log in using MFA (multi-factor authentication), so that a second factor is not required. MFA is now required for non-SSO accounts unless they are on your organization’s exemption list.

2.4

November 15, 2022

What’s New

API Functional Monitoring is now integrated with the New Relic Metric API instead of the New Relic plugin for reporting test suite metrics. For more information, see Configure and View Reports.

2.3

October 27, 2022

What’s New

For improved security, to access the BAT playground you are now prompted to log in to your own secure Anypoint Platform account.

2.2

August 2, 2022

What’s New

You can now log in through a proxy through the CLI using the bat command’s new --useProxy option.

Fixed Issues

Issue Resolution	ID
Inside a business group, you can now successfully create a private location if you have the proper permissions at this level.	W-11330456

Issue Resolution

Inside a business group, you can now successfully create a private location if you have the proper permissions at this level.

W-11330456

2.1

April 11, 2022

Fixed Issues

Issue Resolution	ID
Switching between editors no longer infers assertion types incorrectly. A new drop-down was added in the assertions when creating a monitor. You can choose from String, Number, Boolean or Expression types. The drop-down eliminates adding quotes for string values in the form since quotes are now added in the code editor automatically. This enhancement does not impact existing monitors.	W-10647932

Issue Resolution

Switching between editors no longer infers assertion types incorrectly. A new drop-down was added in the assertions when creating a monitor. You can choose from String, Number, Boolean or Expression types. The drop-down eliminates adding quotes for string values in the form since quotes are now added in the code editor automatically. This enhancement does not impact existing monitors.

W-10647932

2.0

August 6, 2021

MuleSoft announces the release of API Functional Monitoring 2.0.

New Features and Enhancements

The following new features and enhancements are introduced in API Functional Monitoring 2.0. You can now:

Create and edit BAT source via the new inline code editor.
Copy tests.
Run tests against endpoints prior to creating a monitor.

Additionally, the Monitor Detail view has been redesigned, consolidating the following information:

Test duration
Daily average response times
A list of recent test executions
The test’s next run
Buttons for executing a test run, viewing monitor history, editing a monitor, downloading a monitor, and deleting a monitor

1.21

May 30, 2020

This release includes these enhancements:

Enhancements to the Slack reporter

The look and feel of notifications are improved.
Each notification now includes the name of the configuration used for the test execution.
The three following options are added to the Slack reporter:

SEND_NOTIFICATION_IF_PASSED

Setting this option to true causes a notification to be sent if a test passes.

AT_HERE_ENABLED

Setting this option to true adds @here to a notification if a test fails.

DISABLED_FOR_CONFIGS

Disables the reporter for one or more configurations. The value is the name of one configuration or multiple names that are separated by commas. Names do not include the .dwl file extension.

Enhancements to the Email reporter

The two following options are added to the Email reporter:

SEND_NOTIFICATION_IF_PASSED: Setting this option to true causes the email to be sent if the tests pass
DISABLED_FOR_CONFIGS: Disables the reporter for one or more configurations. The value is the name of one configuration or multiple names that are separated by commas. Names do not include the .dwl file extension.

Enhancement to the New Relic reporter

The following option are added to the New Relic reporter:

DISABLED_FOR_CONFIGS: Disables the reporter for one or more configurations. The value is the name of one configuration or multiple names that are separated by commas. Names do not include the .dwl file extension.

Enhancement to the Sumo Logic reporter

The following option are added to the Sumo Logic reporter:

DISABLED_FOR_CONFIGS: Disables the reporter for one or more configurations. The value is the name of one configuration or multiple names that are separated by commas. Names do not include the .dwl file extension.

Enhancement to the PagerDuty reporter

The following option are added to the PagerDuty reporter:

DISABLED_FOR_CONFIGS: Disables the reporter for one or more configurations. The value is the name of one configuration or multiple names that are separated by commas. Names do not include the .dwl file extension.

Enhancements to private locations

Updated to use Mule Runtime 4.3.0.
Updated Mule app dependencies.
Fixed an issue that generated infinite bat test executables in Mule-app filesystems.
Added log appenders to enable troubleshooting in CloudHub.

1.20

February 8, 2020

This release introduces one enhancement: If you run a monitor online in Anypoint Platform (instead of through the BAT CLI), and you specify an email address for an email reporter to notify you of failed tests, each emailed report contains a link. The link opens the result of the failed test in the Functional Monitoring section of Anypoint Monitoring.

1.19

December 7, 2019

This release introduces the following two new features:

Integration with Anypoint Secrets Manager

When you write tests manually and run them with the BAT CLI, you can access shared secrets in Anypoint Secrets Manager within those tests, which enables you to securely store sensitive information, such as a password, authentication token, endpoint URL, or webhook URL. You must run the tests from a private location when you use shared secrets.

For more information, see BDD Test-Writing Syntax Reference and Configure Reports of Test Failures.
Support for creating monitors for endpoints that use self-signed certificates

When you create a monitor in the Anypoint Functional Monitoring section of Anypoint Monitoring, you can toggle the SSL Certificate Validation switch to off if the endpoints that your monitor will test use self-signed certificates. If they do use self-signed certificates and you do not toggle this switch off, tests against those endpoints fail.
- If the toggle is on, all endpoints that use SSL certificates must have certificates that are signed by a trusted authority.
- If the toggle is off, all endpoints that use SSL certificates must be self-signed.
  
  To test a combination of endpoints that use trusted SSL certificates and endpoints that use self-signed certificates, create two separate monitors: one for testing the first group of endpoints, the other for testing the second group of endpoints.

1.17

October 5, 2019

This release introduces private locations, which enable you to monitor private (system and process) APIs without allowing IP addresses. Private locations are namespaces in an instance of Anypoint Virtual Private Cloud (VPC) that is configured to allow workers to access your private network. AFM can create workers within that namespace that can run tests against APIs that are accessible only within the network that VPC is configured for. You can create multiple private locations in a single VPC.

For more information, see Monitoring the Endpoints of Private APIs.

1.16

July 27, 2019

This release introduces one new feature in the interface for Anypoint Monitoring: you can now create new tests that are based on existing tests for monitors in Anypoint Monitoring. For details, see Create a New Test from an Existing One.

1.15

June 15, 2019

This release introduces one new feature: you can now get notifications of failed tests through email. Select Email as the reporter in API Functional Monitoring in Anypoint Monitoring, or set up email as a reporter in the BAT CLI.

See Create a Monitor for instructions about using API Functional Monitoring in Anypoint Monitoring, and see To Configure and View Test Reports for details about creating reporters in the BAT CLI.

1.1

July 12, 2018

This release introduces an enhancement and a new feature.

Enhancement

When you create a monitor in the Functional Monitoring section of Anypoint Monitoring, you can now specify more than one endpoint to test and more than one assertion per endpoint.

New Feature

You can write and run BAT tests in IntelliJ IDEA with the support of the DataWeave 2.0 IntelliJ plugin. For details, see Write and Run BAT Tests in IntelliJ IDEA.

1.0

This release introduces a new user interface that is incorporated into Anypoint Monitoring. To access this user interface, select Functional Monitoring after opening Anypoint Monitoring.

For documentation about this new user interface, see API Functional Monitoring in Anypoint Monitoring.

You can still create tests and schedule them using the BDD Test-Writing Language and the Blackbox Automated Testing (BAT) CLI. The documentation for doing that is located at API Functional Monitoring with the Blackbox Automated Testing (BAT) CLI.