Azure API Management Monitoring | Cloudmon

Azure API Management

Microsoft Azure

Azure API Management

Discover the API Management services in your connected Azure account, see each one with its SKU, scale units, and gateway URL, and track the health and performance measures Azure Monitor provides.

Overview

Azure API Management is a service for publishing, securing, and monitoring APIs through a managed gateway.

Cloudmon automatically discovers the API Management services in your connected Azure account. Navigate to Cloud → Azure → [Select Account] → Azure API Management to view the list.

To connect an Azure account, see How to Set Up Azure Monitoring.

Turning On Monitoring for Azure API Management

The Services tab of the Azure account shows a card for each Azure service. Select All to see every supported service. A service that is not yet monitored for the account shows an Enable button instead of a resource count.

To choose the services discovered for an account, edit the account and select them under Services to be Discovered, as described in Actions in Azure Monitoring.

Azure API Management List

The list displays all discovered API Management services with the following details:

ColumnDescription
NameThe name of the resource as configured in Azure.
Resource GroupThe resource group the resource belongs to.
LocationThe Azure region where the resource is deployed.
SKUThe service tier, such as Developer, Basic, Standard, or Premium.
UnitsThe number of scale units allocated to the service.
Gateway URLThe URL of the API gateway that clients call.
StatusThe current status of the resource.
ActionsOptions for managing monitoring of the resource.

Metrics

Azure Monitor provides the following metrics for API Management services:

MetricDescription
RequestsGateway requests, which can be split by response code category, such as successful, client error, and server error.
Overall Duration of Gateway RequestsHow long gateway requests take end to end, in milliseconds.
Duration of Backend RequestsHow long the backend APIs take to respond, in milliseconds.
CapacityHow busy the service is, as a percentage. A high value means the service is near its limit.
CPU Percentage of Gateway, Memory Percentage of GatewayGateway CPU and memory use, for the v2 service tiers.

Use Cases

  • Compare Overall Duration of Gateway Requests with Duration of Backend Requests to tell whether slowness comes from the gateway or from the backend API.
  • Watch the share of failed Requests to catch errors after a release.
  • Use Capacity to decide when to add scale units.

Troubleshooting

IssueWhat to check
The list shows "There are no Azure API Management Available"The account has no VPN gateways, or discovery has not run since they were created. Navigate to Cloud → Azure → [Account], open the menu (☰), and click Rediscover.
The service card shows EnableThe service is not monitored for this account. Edit the account and select Azure API Management under Services to be Discovered.
Resources are missing after discoveryConfirm that the application registered for Cloudmon has the Reader role on the subscriptions that contain the resources. See How to Set Up Azure Monitoring.