PDF

Azure API Management Sensor

Azure API Management sensor allows you to monitor the performance and behavior of the Azure API Management service. Azure API Management is a reliable, secure, and scalable way to publish, consume and manage APIs running on the Microsoft Azure platform.

This sensor provides information on API Management metrics, such as Requests and Utilization which includes Backend on Getaway Requests Duration [ms], Percentage of Metric Capacity as well as EventHub metrics with visibility of Dropped, Rejected, Throttled, Timed Out Events or Events Size [bytes], among others. Thanks to this sensor you'll be able to have insight into the utilization of APIs and monitor API Management Service ensuring optimal performance.

Options

This sensor requires credentials for Azure subscription (Application (Client) ID, Tenant ID, and Client Secret Value).

Alerts

  • Capacity Utilization > 70%

Performance Metrics

  • Requests and Utilization\Backend Requests Duration [ms] - Average duration of backend requests [ms]
  • Requests and Utilization\% Metric Capacity - Average percentage of metric utilization
  • Requests and Utilization\Gateway Requests Duration [ms] - Getaway requests duration (Miliseconds average)
  • Requests and Utilization\Gateway Requests - Gateway request metrics. Possible dimensions: Location, Hostname, LastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, GatewayResponseCodeCategory
  • Event Hub\Dropped Events - Number of events skipped due to reached queue size limit
  • Event Hub\Rejected Events - Number of rejected EventHub events (wrong configuration or unauthorized)
  • Event Hub\Successful Events - Number of successful EventHub events
  • Event Hub\Throttled Events - Number of throttled EventHub events
  • Event Hub\Timed Out Events - Number of timed out EventHub events
  • Event Hub\Events Size [bytes] - Total size of EventHub events [bytes]
  • Event Hub\Events Sent - Number of events sent to EventHub
  • Event Hub\Total Failed Events - Number of failed EventHub events
  • Network\Network Connectivity - Average count of Network Connectivity statuses of dependent resource types from API Management service

Reports (Data Collectors)

By default, the sensor adds a report containing Requests and Utilization\% Metric Capacity, Requests and Utilization\Gateway Requests Duration [ms], and Requests and Utilization\Gateway Requests charts. These metrics will be collected and available as a report or through Performance Trend Viewer.

apiazurecloudevent hub