From version 8.1, BizTalk360 has the capability to allow users to monitor Azure Services such as API Apps. In this article, we will take a detailed look at the API Apps section and the different components available in this section. In order to be able to monitor API Apps BizTalk360 needs to be granted permissions to access the Azure subscription. To achieve this, please follow the steps mentioned in this article. Once you have added the Azure subscription details in BizTalk360, you will be able to see the list of Azure API Apps and Logic Apps under your subscription.
Let's take a detailed look at the API Apps section. Follow the steps as shown below to view the list of API Apps under your subscription:
- Log in to BizTalk360
- Click Monitoring on the top of the left navigation menu
- Expand Manage Mapping and select Azure Services
- If there are no Azure subscriptions mapped to your environment, you will see a warning message as "No Azure Subscriptions Found/Enabled". Click "Go to Settings to Add/Enable". Refer this article to know the details of adding a new Azure subscription.
- If there is an active Azure subscription available, you will see the screen as shown below. Select API Apps tab -
- Select Alarm - This is the first step to be performed in BizTalk360 when you are setting up monitoring. Please refer this article to create a new alarm in BizTalk360. You can choose the alarm from the drop down to configure API Apps for monitoring.
Azure Subscription - You can choose the subscription from the drop down. Depending on the chosen subscription, the associated API Apps will be listed in the below grid.
You can add multiple subscriptions for the same environment
- API Apps Details - The grid will display the information about the API Apps under the selected subscription. You can get the details such as the API App name, the expected status, the current status, and whether endpoint monitoring is enabled for the API. The Is API Endpoint Monitoring Enabled? will display the status as No - (0 of 1) by default. Once you have enabled API endpoint monitoring (explained in Step 6), the status will display as Yes - (1 of 1). If there are two endpoints under a single API app, and only one endpoint is configured, you will see the status of the API app as Partial - (1 of 2).
- Expected State - Select the API app that you wish to monitor (by selecting the check box) and select the Expected State drop down. You can monitor an API app against the following states - Enabled, Disabled, Do Not Monitor. Setting the Expected state field will start monitoring the API app and will be compared with the current state of the API app. If the expected state matches the current status, the monitoring status will display as Healthy (Green color) against the API Apps tab.
- Remove Orphaned - This button will be enabled only when an API app that is configured for monitoring within BizTalk360 is removed from the Azure Portal. In this case, you can select the API app and remove the orphaned artifact.
- Configure API App Endpoints - In addition to monitoring the API app, you can also monitor the web endpoints of the API app. You can view the endpoints by clicking the v icon. If the API app has no endpoints, you will not see the expand icon (v) on the grid. Selecting one of the endpoint will activate the Configure API App Endpoints button. You can set up monitoring on the API endpoints based on return code alerts, keyword alerts, and response time alerts. For detailed understanding of the different options available in the Configure API app endpoints section, please refer the documentation.