API Management monitoring data reference
APPLIES TO: All API Management tiers
This article contains all the monitoring reference information for this service.
See Monitor API Management for details on the data you can collect for Azure API Management and how to use it.
Metrics
This section lists all the automatically collected platform metrics for this service. These metrics are also part of the global list of all platform metrics supported in Azure Monitor.
For information on metric retention, see Azure Monitor Metrics overview.
Supported metrics for Microsoft.ApiManagement/service
The following table lists the metrics available for the Microsoft.ApiManagement/service resource type.
- All columns might not be present in every table.
- Some columns might be beyond the viewing area of the page. Select Expand table to view all available columns.
Table headings
- Category - The metrics group or classification.
- Metric - The metric display name as it appears in the Azure portal.
- Name in REST API - The metric name as referred to in the REST API.
- Unit - Unit of measure.
- Aggregation - The default aggregation type. Valid values: Average (Avg), Minimum (Min), Maximum (Max), Total (Sum), Count.
- Dimensions - Dimensions available for the metric.
- Time Grains - Intervals at which the metric is sampled. For example,
PT1Mindicates that the metric is sampled every minute,PT30Mevery 30 minutes,PT1Hevery hour, and so on. - DS Export- Whether the metric is exportable to Azure Monitor Logs via diagnostic settings. For information on exporting metrics, see Create diagnostic settings in Azure Monitor.
| Category | Metric | Name in REST API | Unit | Aggregation | Dimensions | Time Grains | DS Export |
|---|---|---|---|---|---|---|---|
| Gateway Requests | Duration of Backend Requests Duration of Backend Requests in milliseconds |
BackendDuration |
MilliSeconds | Average, Maximum, Minimum | Location, Hostname, ApiId |
PT1M | Yes |
| Capacity | Capacity Utilization metric for ApiManagement service. Note: For skus other than Premium, 'Max' aggregation will show the value as 0. |
Capacity |
Percent | Average, Maximum | Location |
PT1M | Yes |
| Gateway WebSocket | WebSocket Connection Attempts (Preview) Count of WebSocket connection attempts based on selected source and destination |
ConnectionAttempts |
Count | Total (Sum), Average | Location, Source, Destination, State |
PT1M | Yes |
| Capacity | CPU Percentage of Gateway CPU Percentage of Gateway for SKUv2 services |
CpuPercent_Gateway |
Percent | Average, Maximum | <none> | PT1M | Yes |
| Gateway Requests | Overall Duration of Gateway Requests Overall Duration of Gateway Requests in milliseconds |
Duration |
MilliSeconds | Average, Maximum, Minimum | Location, Hostname, ApiId |
PT1M | Yes |
| EventHub Events | Dropped EventHub Events Number of events skipped because of queue size limit reached |
EventHubDroppedEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Rejected EventHub Events Number of rejected EventHub events (wrong configuration or unauthorized) |
EventHubRejectedEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Successful EventHub Events Number of successful EventHub events |
EventHubSuccessfulEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Throttled EventHub Events Number of throttled EventHub events |
EventHubThrottledEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Timed Out EventHub Events Number of timed out EventHub events |
EventHubTimedoutEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Size of EventHub Events Total size of EventHub events in bytes |
EventHubTotalBytesSent |
Bytes | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Total EventHub Events Number of events sent to EventHub |
EventHubTotalEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| EventHub Events | Failed EventHub Events Number of failed EventHub events |
EventHubTotalFailedEvents |
Count | Total (Sum) | Location |
PT1M | Yes |
| Gateway Requests | Failed Gateway Requests (Deprecated) Number of failures in gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead |
FailedRequests |
Count | Total (Sum) | Location, Hostname |
PT1M | Yes |
| Capacity | Memory Percentage of Gateway Memory Percentage of Gateway for SKUv2 services |
MemoryPercent_Gateway |
Percent | Average, Maximum | <none> | PT1M | Yes |
| Network Status | Network Connectivity Status of Resources (Preview) Network Connectivity status of dependent resource types from API Management service |
NetworkConnectivity |
Count | Total (Sum), Average | Location, ResourceType |
PT1M | Yes |
| Gateway Requests | Other Gateway Requests (Deprecated) Number of other gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead |
OtherRequests |
Count | Total (Sum) | Location, Hostname |
PT1M | Yes |
| Gateway Requests | Requests Gateway request metrics with multiple dimensions |
Requests |
Count | Total (Sum), Maximum, Minimum | Location, Hostname, LastErrorReason, BackendResponseCode, GatewayResponseCode, BackendResponseCodeCategory, GatewayResponseCodeCategory, ApiId |
PT1M | Yes |
| Gateway Requests | Successful Gateway Requests (Deprecated) Number of successful gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead |
SuccessfulRequests |
Count | Total (Sum) | Location, Hostname |
PT1M | Yes |
| Gateway Requests | Total Gateway Requests (Deprecated) Number of gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead |
TotalRequests |
Count | Total (Sum) | Location, Hostname |
PT1M | Yes |
| Gateway Requests | Unauthorized Gateway Requests (Deprecated) Number of unauthorized gateway requests - Use multi-dimension request metric with GatewayResponseCodeCategory dimension instead |
UnauthorizedRequests |
Count | Total (Sum) | Location, Hostname |
PT1M | Yes |
| Gateway WebSocket | WebSocket Messages (Preview) Count of WebSocket messages based on selected source and destination |
WebSocketMessages |
Count | Total (Sum), Average | Location, Source, Destination |
PT1M | Yes |
Metric dimensions
For information about what metric dimensions are, see Multi-dimensional metrics.
This service has the following dimensions associated with its metrics.
- ApiId
- BackendResponseCode
- BackendResponseCodeCategory
- Destination
- GatewayResponseCode
- GatewayResponseCodeCategory
- Hostname
- LastErrorReason
- Location
- ResourceType
- Source
- State
Resource logs
This section lists the types of resource logs you can collect for this service. The section pulls from the list of all resource logs category types supported in Azure Monitor.
Supported resource logs for Microsoft.ApiManagement/service
| Category | Category display name | Log table | Supports basic log plan | Supports ingestion-time transformation | Example queries | Costs to export |
|---|---|---|---|---|---|---|
DeveloperPortalAuditLogs |
Logs related to Developer Portal usage | APIMDevPortalAuditDiagnosticLog Diagnostic Logs for API Management Developer Portal API. |
Yes | No | Yes | |
GatewayLlmLogs |
Logs related to generative AI gateway | No | No | Yes | ||
GatewayLogs |
Logs related to ApiManagement Gateway | ApiManagementGatewayLogs Azure ApiManagement gateway logs. |
Yes | Yes | Queries | No |
WebSocketConnectionLogs |
Logs related to Websocket Connections | ApiManagementWebSocketConnectionLogs Websocket connection logs provides logs on websocket connection events for API Management Gateway. Logging starts when the request arrives to API Management Gateway for handshake and till the request gets terminated. Every request log can be uniquely identified with CorrelationId. |
Yes | No | Yes |
Supported resource logs for Microsoft.ApiManagement/service/workspaces
| Category | Category display name | Log table | Supports basic log plan | Supports ingestion-time transformation | Example queries | Costs to export |
|---|---|---|---|---|---|---|
GatewayLogs |
Gateway logs for API Management workspaces | No | No | Yes |
Azure Monitor Logs tables
This section lists the Azure Monitor Logs tables relevant to this service, which are available for query by Log Analytics using Kusto queries. The tables contain resource log data and possibly more depending on what is collected and routed to them.
API Management Microsoft.ApiManagement/service
- APIMDevPortalAuditDiagnosticLog
- AzureActivity
- AzureMetrics
- AzureDiagnostics
- ApiManagementGatewayLogs
- ApiManagementWebSocketConnectionLogs
Activity log
The linked table lists the operations that can be recorded in the activity log for this service. These operations are a subset of all the possible resource provider operations in the activity log.
For more information on the schema of activity log entries, see Activity Log schema.
Related content
- See Monitor API Management for a description of monitoring Azure API Management.
- See Monitor Azure resources with Azure Monitor for details on monitoring Azure resources.