Events
Mar 17, 11 PM - Mar 21, 11 PM
Join the meetup series to build scalable AI solutions based on real-world use cases with fellow developers and experts.
Register nowThis browser is no longer supported.
Upgrade to Microsoft Edge to take advantage of the latest features, security updates, and technical support.
APPLIES TO: All API Management tiers
Observability is the ability to understand the internal state of a system from the data it produces and the ability to explore that data to answer questions about what happened and why.
Azure API Management helps organizations centralize the management of all APIs. Since it serves as a single point of entry of all API traffic, it's an ideal place to observe the APIs.
Azure API Management allows you to choose to use the managed gateway or self-hosted gateway, either self-deployed or by using an Azure Arc extension.
The following table summarizes all the observability capabilities supported by API Management to operate APIs and what deployment models they support. API publishers and others with permissions to operate or manage the API Management instance can use these capabilities.
Note
For API consumers who use the developer portal, a built-in API report is available. It only provides information about their individual API usage during the preceding 90 days. Currently, the built-in API report isn't available in the developer portal for the v2 service tiers.
Tool | Useful for | Data lag | Retention | Sampling | Data kind | Supported Deployment Model(s) |
---|---|---|---|---|---|---|
API Inspector | Testing and debugging | Instant | Last 100 traces | Turned on per request | Request traces | Managed, Self-hosted, Azure Arc, Workspace |
Built-in Analytics | Reporting and monitoring | Minutes | Lifetime | 100% | Reports and logs | Managed |
Azure Monitor Metrics | Reporting and monitoring | Minutes | 90 days (upgrade to extend) | 100% | Metrics | Managed, Self-hosted2, Azure Arc |
Azure Monitor Logs | Reporting, monitoring, and debugging | Minutes | 31 days/5GB (upgrade to extend) | 100% (adjustable) | Logs | Managed1, Self-hosted3, Azure Arc3 |
Azure Application Insights | Reporting, monitoring, and debugging | Seconds | 90 days/5GB (upgrade to extend) | Custom | Logs, metrics | Managed1, Self-hosted1, Azure Arc1, Workspace1 |
Logging through Azure Event Hubs | Custom scenarios | Seconds | User managed | Custom | Custom | Managed1, Self-hosted1, Azure Arc1 |
OpenTelemetry | Monitoring | Minutes | User managed | 100% | Metrics | Self-hosted2 |
1. Optional, depending on the configuration of feature in Azure API Management
2. Optional, depending on the configuration of the gateway
3. The self-hosted gateway currently doesn't send diagnostic logs to Azure Monitor. However, it's possible to configure and persist logs locally where the self-hosted gateway is deployed. For more information, please see configuring local metrics and logs for self-hosted gateway
Events
Mar 17, 11 PM - Mar 21, 11 PM
Join the meetup series to build scalable AI solutions based on real-world use cases with fellow developers and experts.
Register nowTraining
Module
Observability and Continuous Improvement - Training
Learners will discover the significance of observability in providing real-time insights into system performance and identifying inefficiencies. This module emphasizes the importance of continuous improvement through feedback loops, performance monitoring, and market analysis. Learners will explore strategies for adapting to market trends and fostering a culture of innovation within platform engineering teams.
Certification
Microsoft Certified: Azure Cosmos DB Developer Specialty - Certifications
Write efficient queries, create indexing policies, manage, and provision resources in the SQL API and SDK with Microsoft Azure Cosmos DB.