Skip to content

Commit 127b1f7

Browse files
authored
Merge pull request #283290 from dlepow/281930
[APIM] Analytics updates
2 parents 082936c + f53baae commit 127b1f7

File tree

3 files changed

+16
-15
lines changed

3 files changed

+16
-15
lines changed

articles/api-management/breaking-changes/analytics-dashboard-retirement-march-2027.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
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.
44
services: api-management
55
author: dlepow
66
ms.service: azure-api-management
77
ms.topic: reference
8-
ms.date: 05/16/2024
8+
ms.date: 08/05/2024
99
ms.author: danlep
1010
---
1111

@@ -17,14 +17,14 @@ Effective 15 March 2027, the dashboard and reports associated with API Managemen
1717

1818
## Is my service affected by this?
1919

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.
2121

2222
## What is the deadline for the change?
2323
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.
2424

2525
## What do I need to do?
2626

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).
2828

2929
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.
3030

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

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
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.
44
author: dlepow
55

66
ms.service: azure-api-management
77
ms.topic: article
8-
ms.date: 03/26/2024
8+
ms.date: 08/05/2024
99
ms.author: danlep
1010
---
1111

@@ -23,11 +23,11 @@ Azure API Management provides analytics for your APIs so that you can analyze th
2323

2424
* 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.
2525

26-
* 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. Equivalent data is shown in the Azure Monitor-based dashboard and built-in analytics.
26+
* 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.
2727

2828
> [!IMPORTANT]
2929
> * The Azure Monitor-based dashboard is the recommended way to access analytics data.
30-
> * Legacy built-in analytics isn't available in the v2 tiers.
30+
> * Built-in (classic) analytics isn't available in the v2 tiers.
3131
3232
With API analytics, analyze the usage and performance of the APIs in your API Management instance across several dimensions, including:
3333

@@ -47,7 +47,7 @@ With API analytics, analyze the usage and performance of the APIs in your API Ma
4747
4848
## Azure Monitor-based dashboard
4949

50-
To use the Azure Monitor-based dashboard, you need to configure a Log Analytics workspace as a data source for API Management gateway logs.
50+
To use the Azure Monitor-based dashboard, you need a Log Analytics workspace as a data source for API Management gateway logs.
5151

5252
If you need to configure one, the following are brief steps to send gateway logs to a Log Analytics workspace. For more information, see [Tutorial: Monitor published APIs](api-management-howto-use-azure-monitor.md#resource-logs). This is a one-time setup.
5353

@@ -63,23 +63,23 @@ If you need to configure one, the following are brief steps to send gateway logs
6363
After a Log Analytics workspace is configured, access the Azure Monitor-based dashboard to analyze the usage and performance of your APIs.
6464

6565
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
66-
1. In the left-hand menu, under **Monitoring**, select **Insights**. The analytics dashboard opens.
66+
1. In the left-hand menu, under **Monitoring**, select **Analytics**. The analytics dashboard opens.
6767
1. Select a time range for data.
6868
1. Select a report category for analytics data, such as **Timeline**, **Geography**, and so on.
6969

7070
## Legacy built-in analytics
7171

72-
In certain API Management service tiers, built-in analytics is also available in the Azure portal, and analytics data can be accessed using the API Management REST API.
72+
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.
7373

7474
### Built-in analytics - portal
7575

76-
To access the built-in analytics in the Azure portal:
76+
To access the built-in (classic) analytics in the Azure portal:
7777

7878
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
79-
1. In the left-hand menu, under **Monitoring**, select **Analytics**.
79+
1. In the left-hand menu, under **Monitoring**, select **Analytics (classic)**.
8080
1. Select a time range for data, or enter a custom time range.
8181
1. Select a report category for analytics data, such as **Timeline**, **Geography**, and so on.
82-
1. Optionally, filter the report by one or more additional categories.
82+
1. Optionally, filter the report by one or more other categories.
8383

8484
### Analytics - REST API
8585

@@ -91,4 +91,5 @@ Available operations return report records by API, geography, API operations, pr
9191

9292
* For an introduction to Azure Monitor features in API Management, see [Tutorial: Monitor published APIs](api-management-howto-use-azure-monitor.md)
9393
* 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).
94-
* Learn about integrating [Azure API Management with Azure Application Insights](api-management-howto-app-insights.md).
94+
* Learn about integrating [Azure API Management with Azure Application Insights](api-management-howto-app-insights.md).
95+
* Learn about [Built-in API analytics dashboard retirement (March 2027)](breaking-changes/analytics-dashboard-retirement-march-2027.md)
-160 KB
Loading

0 commit comments

Comments
 (0)