Microsoft Azure API Management Service Monitoring
Microsoft Azure API Management Service - An Overview
Azure API Management Service is a fully managed platform that enables organizations to publish, secure, transform, and monitor APIs across environments. It provides a centralized gateway for internal and external APIs, offering features such as access control, rate limiting, analytics, and developer portal support.
Applications Manager's Azure API Management Service monitoring provides real-time visibility into the health and performance of your API gateway. Track request throughput, gateway latency, capacity usage, EventHub event publishing, WebSocket connections, and network connectivity to ensure your APIs are performing reliably.
Creating a new Azure API Management Service Monitor
To learn how to create a new Azure API Management Service monitor, click here.
Monitored Parameters
Navigate to the Category View by clicking the Monitors tab. Hover over Child Monitors under Microsoft Azure in the Cloud Apps table, and then select the API Management Services monitor from the displayed tooltip. This action displays the bulk configuration view for Azure API Management Service in three tabs:
- Availability tab gives the availability history for the past 24 hours or 30 days.
- Performance tab gives the health status and events for the past 24 hours or 30 days.
- List view enables you to perform bulk admin configurations.
The Microsoft Azure monitor provides a brief detail of the Azure API Management Service under the given subscription. The following metrics are monitored in the corresponding tabs:
Performance Overview
| Parameter | Description |
|---|
| REQUEST METRICS |
| Request Rate | The total gateway requests per minute between the poll intervals. (in requests/min) |
| Requests | The total number of gateway requests with multiple dimensions between the poll intervals. |
| REQUEST DURATION |
| Duration | The average overall duration of processing gateway requests between the poll intervals. (in ms) |
| Backend Duration | The average duration of backend requests between the poll intervals. (in ms) |
| CAPACITY |
| Capacity | The average utilization percentage of the API Management Service at the time of polling. (in %) |
| GATEWAY UTILIZATION |
| Gateway CPU Utilization | The average gateway CPU utilization at the time of polling. (in %) |
| Gateway Memory Utilization | The average gateway memory utilization at the time of polling. (in %) |
| EVENTHUB EVENTS |
| Total EventHub Events | The total number of events sent to EventHub between the poll intervals. |
| Successful EventHub Events | The total number of successful EventHub events between the poll intervals. |
| Total Failed EventHub Events | The total number of failed EventHub events between the poll intervals. |
| Rejected EventHub Events | The total number of rejected EventHub events between the poll intervals. |
| Throttled EventHub Events | The total number of throttled EventHub events between the poll intervals. |
| Timed Out EventHub Events | The total number of timed out EventHub events between the poll intervals. |
| Dropped EventHub Events | The total number of dropped EventHub events between the poll intervals. |
| TOTAL EVENTHUB DATA SENT |
| EventHub Data Sent Rate | The total data sent per minute to EventHub between the poll intervals. (in MB/min) |
| Total EventHub Data Sent | The total volume of EventHub events sent between the poll intervals. (in MB) |
| NETWORK CONNECTIVITY |
| Network Connectivity | The average network connectivity status of dependent resources between the poll intervals. |
| WEBSOCKET MESSAGES |
| WebSocket Messages | The total number of WebSocket messages between the poll intervals. |
| CONNECTION ATTEMPTS |
| Connection Attempts | The total number of connection attempts between the poll intervals. |
Configuration
| Parameter | Description |
|---|
| CONFIGURATION |
| Resource Group Name | The resource group that contains the Azure API Management Service. |
| Location | The Azure region where the Azure API Management Service is deployed. |
| Provisioning State | The current provisioning state of the Azure API Management Service. |
| Target Provisioning State | The target provisioning state of the Azure API Management Service. |
| SKU | The pricing tier of the Azure API Management Service. |
| SKU Capacity | The number of deployed units of the Azure API Management Service SKU. |
| Public Network Access | Specifies whether public network access is Enabled or Disabled for the Azure API Management Service. |
| Virtual Network Type | The type of virtual network connectivity configured for the Azure API Management Service. |
| Creation Time | The date and time when the Azure API Management Service was created. |
| Publisher Name | The name of the publisher associated with the Azure API Management Service. |
| Platform Version | The version of the compute platform running the Azure API Management Service. |
