|
| 1 | +--- |
| 2 | +title: Monitor Azure API Management |
| 3 | +description: Learn how to monitor Azure API Management using Azure Monitor, including data collection, analysis, and alerting. |
| 4 | +ms.date: 12/10/2024 |
| 5 | +ms.custom: horz-monitor |
| 6 | +ms.topic: conceptual |
| 7 | +author: dlepow |
| 8 | +ms.author: danlep |
| 9 | +ms.service: azure-api-management |
| 10 | +--- |
| 11 | + |
| 12 | +<!-- |
| 13 | +According to the Content Pattern guidelines, all comments must be removed before publication!!! |
| 14 | +IMPORTANT |
| 15 | +When using this template, first: |
| 16 | +1. Search and replace [TODO-replace-with-service-name] with the official name of your service. |
| 17 | +2. Search and replace [TODO-replace-with-service-filename] with the service name to use in GitHub filenames.--> |
| 18 | + |
| 19 | +<!-- VERSION 4.0 November 2024 |
| 20 | +For background about this template, see https://review.learn.microsoft.com/en-us/help/contribute/contribute-monitoring?branch=main --> |
| 21 | + |
| 22 | +<!-- Add service-specific information after the includes. |
| 23 | +Your service should have the following two articles: |
| 24 | +1. The overview monitoring article (based on this template) |
| 25 | + - Title: "Monitor [TODO-replace-with-service-name]" |
| 26 | + - TOC title: "Monitor [TODO-replace-with-service-name]" |
| 27 | + - Filename: "monitor-[TODO-replace-with-service-filename].md" |
| 28 | +2. A reference article that lists all the metrics and logs for your service (based on the template data-reference-template.md). |
| 29 | + - Title: "[TODO-replace-with-service-name] monitoring data reference" |
| 30 | + - TOC title: "Monitoring data reference" |
| 31 | + - Filename: "monitor-[TODO-replace-with-service-filename]-reference.md". |
| 32 | +--> |
| 33 | + |
| 34 | +# Monitor API Management |
| 35 | + |
| 36 | +[!INCLUDE [azmon-horz-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-intro.md)] |
| 37 | + |
| 38 | +## Collect data with Azure Monitor |
| 39 | + |
| 40 | +This table describes how you can collect data to monitor your service, and what you can do with the data once collected: |
| 41 | + |
| 42 | +|Data to collect|Description|How to collect and route the data|Where to view the data|Supported data| |
| 43 | +|---------|---------|---------|---------|---------| |
| 44 | +|Metric data|Metrics are numerical values that describe an aspect of a system at a particular point in time. Metrics can be aggregated using algorithms, compared to other metrics, and analyzed for trends over time.|- Collected automatically at regular intervals.</br> - You can route some platform metrics to a Log Analytics workspace to query with other data. Check the **DS export** setting for each metric to see if you can use a diagnostic setting to route the metric data.|[Metrics explorer](/azure/azure-monitor/essentials/metrics-getting-started)| [Azure API Management metrics supported by Azure Monitor](/azure/api-management/monitor-api-management-reference#metrics)| |
| 45 | +|Resource log data|Logs are recorded system events with a timestamp. Logs can contain different types of data, and be structured or free-form text. You can route resource log data to Log Analytics workspaces for querying and analysis.|[Create a diagnostic setting](/azure/azure-monitor/essentials/create-diagnostic-settings) to collect and route resource log data.| [Log Analytics](/azure/azure-monitor/learn/quick-create-workspace)|[Azure API Management resource log data supported by Azure Monitor](/azure/api-management/monitor-api-management-reference#resource-logs) | |
| 46 | +|Activity log data|The Azure Monitor activity log provides insight into subscription-level events. The activity log includes information like when a resource is modified or a virtual machine is started.|- Collected automatically.</br> - [Create a diagnostic setting](/azure/azure-monitor/essentials/create-diagnostic-settings) to a Log Analytics workspace at no charge.|[Activity log](/azure/azure-monitor/essentials/activity-log)| | |
| 47 | + |
| 48 | +[!INCLUDE [azmon-horz-supported-data](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-supported-data.md)] |
| 49 | + |
| 50 | +## Built in monitoring for API Management |
| 51 | + |
| 52 | +<!-- Add any monitoring mechanisms build in to your service here. --> |
| 53 | + |
| 54 | +<!--## Use Azure Monitor tools to analyze the data--> |
| 55 | +[!INCLUDE [azmon-horz-tools](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-tools.md)] |
| 56 | + |
| 57 | +<!--## Export Azure Monitor data --> |
| 58 | +[!INCLUDE [azmon-horz-export-data](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-export-data.md)] |
| 59 | + |
| 60 | +<!--## Use Kusto queries to analyze log data --> |
| 61 | +[!INCLUDE [azmon-horz-kusto](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-kusto.md)] |
| 62 | + |
| 63 | +### Recommended Kusto queries for API Management |
| 64 | + |
| 65 | +<!-- Add any recommended Kusto queries here. --> |
| 66 | + |
| 67 | +<!-- Add any links to community resources with sample Kusto queries here. --> |
| 68 | + |
| 69 | +<!-- ## Use Azure Monitor alerts to notify you of issues --> |
| 70 | +[!INCLUDE [azmon-horz-alerts-part-one](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-alerts-part-one.md)] |
| 71 | + |
| 72 | +<!-- Add any recommended alert rules here. --> |
| 73 | +### Recommended Azure Monitor alert rules for API Management |
| 74 | + |
| 75 | +The following table lists common and recommended alert rules for API Management. |
| 76 | + |
| 77 | +| Alert type | Condition | Examples | |
| 78 | +|:---|:---|:---| |
| 79 | +| Metric | | | |
| 80 | +| Log search | | | |
| 81 | +| Activity Log | | | |
| 82 | +| Service Health | | | |
| 83 | +| Resource Health | | | |
| 84 | + |
| 85 | +[!INCLUDE [azmon-horz-alerts-part-two](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-alerts-part-two.md)] |
| 86 | + |
| 87 | +<!-- ## Get personalized recommendations using Azure Advisor --> |
| 88 | +[!INCLUDE [azmon-horz-advisor](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/azmon-horz-advisor.md)] |
| 89 | + |
| 90 | +## Related content |
| 91 | + |
| 92 | +- [API Management monitoring data reference](monitor-api-management-reference.md) |
| 93 | +- [Monitoring Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) |
0 commit comments