You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/breaking-changes/analytics-dashboard-retirement-march-2027.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
2
title: Azure API Management - Analytics dashboard retirement (March 2027)
3
-
description: Azure API Management is replacing the built-in API analytics dashboard as of March 2027. An equivalent dashboard is available based on an Azure Monitor Workbook.
3
+
description: Azure API Management is replacing the built-in API analytics dashboard as of March 2027. A similar Azure Monitor-based dashboard is available.
4
4
services: api-management
5
5
author: dlepow
6
6
ms.service: azure-api-management
7
7
ms.topic: reference
8
-
ms.date: 05/16/2024
8
+
ms.date: 08/05/2024
9
9
ms.author: danlep
10
10
---
11
11
@@ -17,14 +17,14 @@ Effective 15 March 2027, the dashboard and reports associated with API Managemen
17
17
18
18
## Is my service affected by this?
19
19
20
-
The Premium, Standard, Basic, and Developer tiers of API Management provide a [built-in analytics dashboard](../howto-use-analytics.md#legacy-built-in-analytics) and reports ("legacy built-in analytics") for each API Management instance. As of early 2024, API Management also provides identical API analytics using an [Azure Monitor-based dashboard](../howto-use-analytics.md#azure-monitor-based-dashboard) that aggregates data in an Azure Log Analytics workspace. The Azure Monitor-based dashboard is now the recommended solution for viewing API Management analytics data in the portal.
20
+
The Premium, Standard, Basic, and Developer tiers of API Management provide a [built-in analytics dashboard](../howto-use-analytics.md#legacy-built-in-analytics) and reports ("legacy built-in analytics" or "classic built-in analytics") for each API Management instance. As of early 2024, API Management also provides closely similar API analytics using an [Azure Monitor-based dashboard](../howto-use-analytics.md#azure-monitor-based-dashboard) that aggregates data in an Azure Log Analytics workspace. The Azure Monitor-based dashboard is now the recommended solution for viewing API Management analytics data in the portal.
21
21
22
22
## What is the deadline for the change?
23
23
After 15 March 2027, the legacy built-in analytics will not be supported. Both the legacy built-in analytics and Azure Monitor-based analytics will be available in parallel for a period of time to allow for a smooth transition to the Azure Monitor-based implementation.
24
24
25
25
## What do I need to do?
26
26
27
-
From now through 15 March 2027, you will have access to both implementations in the Azure portal, featuring identical dashboards and reports. We recommend that you start using the Azure Monitor-based dashboard to view your API Management analytics data. To use the Azure Monitor-based dashboard, configure a Log Analytics workspace as a data source for API Management gateway logs. For more information, see [Tutorial: Monitor published APIs](../api-management-howto-use-azure-monitor.md).
27
+
From now through 15 March 2027, you will have access to both implementations in the Azure portal, featuring closely similar dashboards and reports. We recommend that you start using the Azure Monitor-based dashboard to view your API Management analytics data. To use the Azure Monitor-based dashboard, configure a Log Analytics workspace as a data source for API Management gateway logs. For more information, see [Tutorial: Monitor published APIs](../api-management-howto-use-azure-monitor.md).
28
28
29
29
When an option to do so becomes available, we recommend disabling the legacy analytics dashboard to improve the capacity performance of your API Management instance. We recommend pursuing this change proactively before the retirement date.
Copy file name to clipboardExpand all lines: articles/api-management/howto-use-analytics.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
1
---
2
2
title: Use API analytics in Azure API Management | Microsoft Docs
3
-
description: Use analytics in Azure API Management to understand and categorize the usage of your APIs and API performance. Analytics is provided using an Azure workbook.
3
+
description: Use analytics in Azure API Management to understand and categorize the usage of APIs and API performance. Analytics uses an Azure Monitor-based dashboard.
4
4
author: dlepow
5
5
6
6
ms.service: azure-api-management
7
7
ms.topic: article
8
-
ms.date: 08/01/2024
8
+
ms.date: 08/05/2024
9
9
ms.author: danlep
10
10
---
11
11
@@ -22,7 +22,7 @@ Azure API Management provides analytics for your APIs so that you can analyze th
22
22
23
23
* API Management provides analytics using an [Azure Monitor-based dashboard](../azure-monitor/visualize/workbooks-overview.md). The dashboard aggregates data in an Azure Log Analytics workspace.
24
24
25
-
* In the classic API Management service tiers, your API Management instance also includes *built-in (classic) analytics* in the Azure portal, and analytics data can be accessed using the API Management REST API. Similar data is shown in the Azure Monitor-based dashboard and built-in analytics.
25
+
* In the classic API Management service tiers, your API Management instance also includes *legacy built-in analytics* in the Azure portal, and analytics data can be accessed using the API Management REST API. Closely similar data is shown in the Azure Monitor-based dashboard and built-in analytics.
26
26
27
27
> [!IMPORTANT]
28
28
> * The Azure Monitor-based dashboard is the recommended way to access analytics data.
@@ -66,9 +66,9 @@ After a Log Analytics workspace is configured, access the Azure Monitor-based da
66
66
1. Select a time range for data.
67
67
1. Select a report category for analytics data, such as **Timeline**, **Geography**, and so on.
68
68
69
-
## Built-in (classic) analytics
69
+
## Legacy built-in analytics
70
70
71
-
In certain API Management service tiers, built-in (classic) analytics (also called *legacy analytics*) is also available in the Azure portal, and analytics data can be accessed using the API Management REST API.
71
+
In certain API Management service tiers, built-in analytics (also called *legacy analytics* or *classic analytics*) is also available in the Azure portal, and analytics data can be accessed using the API Management REST API.
72
72
73
73
### Built-in analytics - portal
74
74
@@ -78,7 +78,7 @@ To access the built-in (classic) analytics in the Azure portal:
78
78
1. In the left-hand menu, under **Monitoring**, select **Analytics (classic)**.
79
79
1. Select a time range for data, or enter a custom time range.
80
80
1. Select a report category for analytics data, such as **Timeline**, **Geography**, and so on.
81
-
1. Optionally, filter the report by one or more additional categories.
81
+
1. Optionally, filter the report by one or more other categories.
82
82
83
83
### Analytics - REST API
84
84
@@ -90,4 +90,5 @@ Available operations return report records by API, geography, API operations, pr
90
90
91
91
* For an introduction to Azure Monitor features in API Management, see [Tutorial: Monitor published APIs](api-management-howto-use-azure-monitor.md)
92
92
* For detailed HTTP logging and monitoring, see [Monitor your APIs with Azure API Management, Event Hubs, and Moesif](api-management-log-to-eventhub-sample.md).
93
-
* Learn about integrating [Azure API Management with Azure Application Insights](api-management-howto-app-insights.md).
93
+
* Learn about integrating [Azure API Management with Azure Application Insights](api-management-howto-app-insights.md).
94
+
* Learn about [Built-in API analytics dashboard retirement (March 2027)](breaking-changes/analytics-dashboard-retirement-march-2027.md)
0 commit comments