API Management helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services.
Businesses everywhere want to extend their operations as a digital platform, creating new channels, finding new customers, and driving deeper engagement with existing ones. API Management provides the core competencies to ensure a successful API program through developer engagement, business insights, analytics, security, and protection.
You can use Azure API Management to take any back end and launch a full-fledged API program based on it. Also, use the Azure public cloud integration to discover and collect metrics against the Azure service.
Setup
To set up the Azure integration and discover the API Management, do the following:
Create an Azure Integration if not available in your installed integrations. For more information on how to install the Azure Integration, refer to Install Azure integration.
Create a discovery profile.
Select
Azure API Managementunder the Filter Criteria on the Edit Discovery Profile page.Save the discovery profile to make it available in the list of Discovery Profiles.
Scan to discover the resources at any time independent of the predefined schedule.
Once the scan is completed, you can view the API Management resources under Infrastructure > Resources > Microsoft Azure category.
Create a template with collector type Azure and applicable for API Management. See Create a Template for more information on how to create a template.
Refer to Assign a Template on how to assign a template to a resource.
Click the Metrics tab to view the monitoring data of Azure API Management.
Event support
OpsRamp supports Azure events for Azure API Management. Configure Azure Events in OpsRamp Azure integration discovery profile. See Process Azure Events for more information on how to configure Azure events.
Supported metrics
| OpsRamp Metric | Azure Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|---|
| azure_apimanagement_service_BackendDuration | BackendDuration | Duration of Backend Requests | MilliSeconds | Average | Duration of Backend Requests in milliseconds |
| azure_apimanagement_service_Capacity | Capacity | Capacity | Percent | Average | Utilization metric for ApiManagement service. Note: For skus other than Premium, 'Max' aggregation will show the value as 0. |
| azure_apimanagement_service_ConnectionAttempts | ConnectionAttempts | WebSocket Connection Attempts | Count | Total | Count of WebSocket connection attempts based on selected source and destination |
| azure_apimanagement_service_CpuPercent_Gateway | CpuPercent_Gateway | CPU Percentage of Gateway | Percent | Average | CPU Percentage of Gateway for SKUv2 services |
| azure_apimanagement_service_Duration | Duration | Overall Duration of Gateway Requests | MilliSeconds | Average | Overall Duration of Gateway Requests in milliseconds |
| azure_apimanagement_service_EventHubDroppedEvents | EventHubDroppedEvents | Dropped EventHub Events | Count | Total | Number of events skipped because of queue size limit reached |
| azure_apimanagement_service_EventHubRejectedEvents | EventHubRejectedEvents | Rejected EventHub Events | Count | Total | Number of rejected EventHub events (wrong configuration or unauthorized) |
| azure_apimanagement_service_EventHubSuccessfulEvents | EventHubSuccessfulEvents | Successful EventHub Events | Count | Total | Number of successful EventHub events |
| azure_apimanagement_service_EventHubThrottledEvents | EventHubThrottledEvents | Throttled EventHub Events | Count | Total | Number of throttled EventHub events |
| azure_apimanagement_service_EventHubTimedoutEvents | EventHubTimedoutEvents | Timed Out EventHub Events | Count | Total | Number of timed out EventHub events |
| azure_apimanagement_service_EventHubTotalBytesSent | EventHubTotalBytesSent | Size of EventHub Events | Bytes | Total | Total size of EventHub events in bytes |
| azure_apimanagement_service_EventHubTotalEvents | EventHubTotalEvents | Total EventHub Events | Count | Total | Number of events sent to EventHub |
| azure_apimanagement_service_EventHubTotalFailedEvents | EventHubTotalFailedEvents | Failed EventHub Events | Count | Total | Number of failed EventHub events |
| azure_apimanagement_service_MemoryPercent_Gateway | MemoryPercent_Gateway | Memory Percentage of Gateway | Percent | Average | Memory Percentage of Gateway for SKUv2 services |
| azure_apimanagement_service_NetworkConnectivity | NetworkConnectivity | Network Connectivity Status of Resources | Count | Total | Network Connectivity status of dependent resource types from API Management service |
| azure_apimanagement_service_Requests | Requests | Requests | Count | Total | Gateway request metrics with multiple dimensions |
| azure_apimanagement_service_WebSocketMessages | WebSocketMessages | WebSocket Messages | Count | Total | Count of WebSocket messages based on selected source and destination |