Introduction
API Management helps organizations publish APIs to external, partner, and internal developers to unlock the potential of their data and services.
Businesses everywhere are looking 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.
Note
Use the OpsRamp Azure public cloud integration to discover and collect metrics against the Azure service.Setup
To set up the OpsRamp Azure integration and discover the Azure service,
go to Azure Integration Discovery Profile and select API Management Service.
Metrics
| OpsRamp Metric | Metric Display Name | Unit | Aggregation Type | Description |
|---|---|---|---|---|
| azure_api_mgnt_total_requests | Total Gateway Requests | Count | Total | Number of gateway requests. |
| azure_successful_requests | Successful Gateway Requests | Count | Total | Number of successful gateway requests. |
| azure_unauthorized_requests | Unauthorized Gateway Requests | Count | Total | Number of unauthorized gateway requests. |
| azure_failed_requests | Failed Gateway Requests | Count | Total | Number of failures in gateway requests. |
| azure_other_requests | Other Gateway Requests | Count | Total | Number of other gateway requests. |
| azure_duration | Overall Duration of Gateway Requests | Milliseconds | Average | Overall duration of gateway requests in milliseconds. |
| azure_capacity | Capacity (Preview) | Percent | Maximum | Utilization metric for the ApiManagement service. |
| azure_api_mgmt_requests | Total Number of Gateway Requests | Count | Total | Total number of gateway requests. |
| azure_api_mgmt_eventhub_total_events | Total EventHub Events | Count | Total | Total number of events sent to EventHub from API Management in a given period. |
| azure_api_mgmt_eventhub_successful_events | Successful Eventhub Events | Count | Total | Total number of successful EventHub events in a given period. |
| azure_api_mgmt_eventhub_total_failed_events | Total Failed Eventhub Events | Count | Total | Total number of failed EventHub events in a given period. |
| azure_api_mgmt_eventhub_rejected_events | Rejected Eventhub Events | Count | Total | Total number of Rejected EventHub (wrong configuration or unauthorized) events in a given period. |
| azure_api_mgmt_eventhub_throttled_events | Throttled Eventhub Events | Count | Total | Total number of Throttled EventHub events in a given period. |
| azure_api_mgmt_eventhub_timedout_events | Timedout Eventhub Events | Count | Total | Total number of timedout EventHub events in a given period. |
| azure_api_mgmt_eventhub_dropped_events | Dropped Eventhub Events | Count | Total | Total number of events skipped because of queue size limit reached in a given period. |
| azure_api_mgmt_eventhub_total_bytes_sent | Size of EventHub Events | Bytes | Total | Total size of EventHub events in bytes in a given period. |
| cloud_instance_state | Status/State | n/a | n/a | Status/State |
Event support
- Supported
- Configurable in OpsRamp Azure Integration Discovery Profile.