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 | Description | Aggregation Type |
|---|---|---|---|---|---|
| azure_apimanagement_service_TotalRequests | TotalRequests | Total Gateway Requests (Deprecated) | Count | Number of gateway requests. | Total |
| azure_apimanagement_service_SuccessfulRequests | SuccessfulRequests | Successful Gateway Requests (Deprecated) | Count | Number of successful gateway requests. | Total |
| azure_apimanagement_service_UnauthorizedRequests | UnauthorizedRequests | Unauthorized Gateway Requests (Deprecated) | Count | Number of unauthorized gateway requests. | Total |
| azure_apimanagement_service_FailedRequests | FailedRequests | Failed Gateway Requests (Deprecated) | Count | Number of failed gateway requests. | Total |
| azure_apimanagement_service_OtherRequests | OtherRequests | Other Gateway Requests (Deprecated) | Count | Number of other gateway requests. | Total |
| azure_apimanagement_service_Duration | Duration | Overall Duration of Gateway Requests | Milliseconds | Overall duration of gateway requests in milliseconds. | Average |
| azure_apimanagement_service_Capacity | Capacity | Capacity (Preview) | Percent | Utilization metric for the API management service. | Maximum |
| azure_apimanagement_service_Requests | Requests | Total Number of Gateway Requests | Count | Total number of gateway requests. | Total |
| azure_apimanagement_service_EventHubTotalEvents | EventHubTotalEvents | Total EventHub Events | Count | Total number of events sent to EventHub from API Management in a given period. | Total |
| azure_apimanagement_service_EventHubSuccessfulEvents | EventHubSuccessfulEvents | Successful Eventhub Events | Count | Total number of successful EventHub events in a given period. | Total |
| azure_apimanagement_service_EventHubTotalFailedEvents | EventHubTotalFailedEvents | Total Failed Eventhub Events | Count | Total number of failed EventHub events in a given period. | Total |
| azure_apimanagement_service_EventHubRejectedEvents | EventHubRejectedEvents= | Rejected Eventhub Events | Count | Total number of Rejected EventHub (wrong configuration or unauthorized) events in a given period. | Total |
| azure_apimanagement_service_EventHubThrottledEvents | EventHubThrottledEvents | Throttled Eventhub Events | Count | Total number of Throttled EventHub events in a given period. | Total |
| azure_apimanagement_service_EventHubTimedoutEvents | EventHubTimedoutEvents | Timedout Eventhub Events | Count | Total number of timed-out EventHub events in a given period. | Total |
| azure_apimanagement_service_EventHubDroppedEvents | EventHubDroppedEvents | Dropped Eventhub Events | Count | Total number of events skipped because of queue size limit reached in a given period. | Total |
| azure_apimanagement_service_EventHubTotalBytesSent | EventHubTotalBytesSent | Size of EventHub Events | Bytes | Total size of EventHub events in bytes in a given period. | Total |
| azure_apimanagement_service_NetworkConnectivity | NetworkConnectivity | Network Connectivity Status of Resources (Preview) | Count | Network Connectivity status of dependent resource types from API Management service. | Total |
| azure_apimanagement_service_BackendDuration | BackendDuration | Duration of Backend Requests | MilliSeconds | Refers to the duration of backend requests in milliseconds. | Average |
| azure_apimanagement_service_ConnectionAttempts | ConnectionAttempts | WebSocket Connection Attempts (Preview) | Count | Count of Wwbsocket connection attempts based on selected source and destination. | Total |
| azure_apimanagement_service_WebSocketMessages | WebSocketMessages | WebSocket Messages (Preview) | Count | Count of websocket messages based on selected source and destination. | Total |
| cloud_instance_state | n/a | Status/State | n/a | Status/State of the cloud instance. | n/a |