Skip to content

Commit 7773ca8

Browse files
authored
Merge pull request #292765 from MicrosoftDocs/main
1/8/2025 AM Publish
2 parents ef95630 + 5704ee1 commit 7773ca8

File tree

63 files changed

+781
-588
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

63 files changed

+781
-588
lines changed

.openpublishing.redirection.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -747,6 +747,21 @@
747747
"redirect_url": "/previous-versions/azure/api-management/self-hosted-gateway-migration-guide",
748748
"redirect_document_id": false
749749
},
750+
{
751+
"source_path_from_root": "/articles/api-management/howto-use-analytics.md",
752+
"redirect_url": "/azure/api-management/monitor-api-management",
753+
"redirect_document_id": true
754+
},
755+
{
756+
"source_path_from_root": "/articles/api-management/visualize-using-managed-grafana-dashboard.md",
757+
"redirect_url": "/azure/api-management/monitor-api-management",
758+
"redirect_document_id": false
759+
},
760+
{
761+
"source_path_from_root": "/articles/api-management/developer-portal-enable-usage-logs.md",
762+
"redirect_url": "/azure/api-management/monitor-api-management",
763+
"redirect_document_id": false
764+
},
750765
{
751766
"source_path_from_root": "/articles/governance/machine-configuration/whats-new/migrating-from-dsc-extension.md ",
752767
"redirect_url": " https://azure.microsoft.com/updates/migrate-from-linux-dsc-extension-to-the-guest-configuration-feature-of-azure-policy-by-may-1-2025/",

articles/api-management/TOC.yml

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -174,14 +174,12 @@
174174
- name: Observability
175175
displayName: monitoring
176176
href: observability.md
177-
- name: Get API analytics
178-
href: howto-use-analytics.md
177+
- name: Monitor API Management
178+
href: monitor-api-management.md
179179
- name: Log events to Azure Event Hubs
180180
href: api-management-howto-log-event-hubs.md
181181
- name: Log requests with Azure Application Insights
182182
href: api-management-howto-app-insights.md
183-
- name: Visualize data using Managed Grafana
184-
href: visualize-using-managed-grafana-dashboard.md
185183
- name: Define APIs
186184
items:
187185
- name: Add and import APIs
@@ -399,8 +397,6 @@
399397
href: api-management-howto-oauth2.md
400398
- name: Integrate Application Insights
401399
href: developer-portal-integrate-application-insights.md
402-
- name: Log developer portal usage
403-
href: developer-portal-enable-usage-logs.md
404400
- name: Integrate Google Tag Manager
405401
href: developer-portal-integrate-google-tag-manager.md
406402
- name: Customize developer portal on WordPress
@@ -468,6 +464,8 @@
468464
href: /cli/azure/apim
469465
- name: Azure PowerShell
470466
href: /powershell/module/az.apimanagement/
467+
- name: Monitoring data reference
468+
href: monitor-api-management-reference.md
471469
- name: REST API
472470
href: /rest/api/apimanagement/
473471
- name: REST API SDKs

articles/api-management/api-management-howto-use-azure-monitor.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.author: danlep
1414

1515
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
1616

17-
With Azure Monitor, you can visualize, query, route, archive, and take actions on the metrics or logs coming from your Azure API Management service.
17+
With Azure Monitor, you can visualize, query, route, archive, and take actions on the metrics or logs coming from your Azure API Management service. For an overview of Azure Monitor for API Management, see [Monitor API Management](monitor-api-management.md).
1818

1919
[!INCLUDE [api-management-workspace-availability](../../includes/api-management-workspace-availability.md)]
2020

@@ -37,7 +37,7 @@ In this tutorial, you learn how to:
3737

3838
## View metrics of your APIs
3939

40-
API Management emits [metrics](/azure/azure-monitor/essentials/data-platform-metrics) every minute, giving you near real-time visibility into the state and health of your APIs. The following are the most frequently used metrics. For a list of all available metrics, see [supported metrics](/azure/azure-monitor/reference/supported-metrics/microsoft-apimanagement-service-metrics).
40+
API Management emits [metrics](/azure/azure-monitor/essentials/data-platform-metrics) every minute, giving you near real-time visibility into the state and health of your APIs. The following are the most frequently used metrics. For a list of all available metrics, see [Metrics](monitor-api-management-reference.md#metrics).
4141

4242
* **Capacity** - helps you make decisions about upgrading/downgrading your API Management services. The metric is emitted per minute and reflects the estimated gateway capacity at the time of reporting. The metric ranges from 0-100 calculated based on gateway resources such as CPU and memory utilization and other factors.
4343

articles/api-management/developer-portal-enable-usage-logs.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

articles/api-management/howto-use-analytics.md

Lines changed: 0 additions & 99 deletions
This file was deleted.
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Monitoring data reference for Azure API Management
3+
description: This article contains important reference material you need when you monitor Azure API Management by using Azure Monitor.
4+
ms.date: 01/06/2025
5+
ms.custom: horz-monitor
6+
ms.topic: reference
7+
author: dlepow
8+
ms.author: danlep
9+
ms.service: azure-api-management
10+
---
11+
12+
# API Management monitoring data reference
13+
14+
[!INCLUDE [api-management-availability-all-tiers](../../includes/api-management-availability-all-tiers.md)]
15+
16+
[!INCLUDE [horz-monitor-ref-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-intro.md)]
17+
18+
See [Monitor API Management](monitor-api-management.md) for details on the data you can collect for Azure API Management and how to use it.
19+
20+
[!INCLUDE [horz-monitor-ref-metrics-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-intro.md)]
21+
22+
### Supported metrics for Microsoft.ApiManagement/service
23+
24+
The following table lists the metrics available for the Microsoft.ApiManagement/service resource type.
25+
26+
[!INCLUDE [horz-monitor-ref-metrics-tableheader](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-tableheader.md)]
27+
28+
[!INCLUDE [Microsoft.ApiManagement/service](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/metrics/microsoft-apimanagement-service-metrics-include.md)]
29+
30+
[!INCLUDE [horz-monitor-ref-metrics-dimensions-intro](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions-intro.md)]
31+
32+
[!INCLUDE [horz-monitor-ref-metrics-dimensions](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-metrics-dimensions.md)]
33+
34+
- ApiId
35+
- BackendResponseCode
36+
- BackendResponseCodeCategory
37+
- Destination
38+
- GatewayResponseCode
39+
- GatewayResponseCodeCategory
40+
- Hostname
41+
- LastErrorReason
42+
- Location
43+
- ResourceType
44+
- Source
45+
- State
46+
47+
[!INCLUDE [horz-monitor-ref-resource-logs](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-resource-logs.md)]
48+
49+
### Supported resource logs for Microsoft.ApiManagement/service
50+
51+
[!INCLUDE [Microsoft.ApiManagement/service](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-apimanagement-service-logs-include.md)]
52+
53+
### Supported resource logs for Microsoft.ApiManagement/service/workspaces
54+
55+
[!INCLUDE [Microsoft.ApiManagement/service/workspaces](~/reusable-content/ce-skilling/azure/includes/azure-monitor/reference/logs/microsoft-apimanagement-service-workspaces-logs-include.md)]
56+
57+
[!INCLUDE [horz-monitor-ref-logs-tables](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-logs-tables.md)]
58+
59+
### API Management Microsoft.ApiManagement/service
60+
61+
- [APIMDevPortalAuditDiagnosticLog](/azure/azure-monitor/reference/tables/apimdevportalauditdiagnosticlog#columns)
62+
- [AzureActivity](/azure/azure-monitor/reference/tables/azureactivity#columns)
63+
- [AzureMetrics](/azure/azure-monitor/reference/tables/azuremetrics#columns)
64+
- [AzureDiagnostics](/azure/azure-monitor/reference/tables/azurediagnostics#columns)
65+
- [ApiManagementGatewayLogs](/azure/azure-monitor/reference/tables/apimanagementgatewaylogs#columns)
66+
- [ApiManagementWebSocketConnectionLogs](/azure/azure-monitor/reference/tables/apimanagementwebsocketconnectionlogs#columns)
67+
68+
[!INCLUDE [horz-monitor-ref-activity-log](~/reusable-content/ce-skilling/azure/includes/azure-monitor/horizontals/horz-monitor-ref-activity-log.md)]
69+
70+
- [Microsoft.ApiManagement resource provider operations](/azure/role-based-access-control/resource-provider-operations#microsoftapimanagement)
71+
72+
## Related content
73+
74+
- See [Monitor API Management](monitor-api-management.md) for a description of monitoring Azure API Management.
75+
- See [Monitor Azure resources with Azure Monitor](/azure/azure-monitor/essentials/monitor-azure-resource) for details on monitoring Azure resources.

0 commit comments

Comments
 (0)