Skip to content

Commit 95a0745

Browse files
author
Jill Grant
authored
Merge pull request #289680 from dlepow/mon
[APIM] Update monitoring tutorial - UUF
2 parents 0fb0dee + 03415af commit 95a0745

File tree

8 files changed

+17
-18
lines changed

8 files changed

+17
-18
lines changed

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

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: dlepow
77
ms.service: azure-api-management
88
ms.custom: engagement-fy23, devdivchpfy22
99
ms.topic: tutorial
10-
ms.date: 08/26/2024
10+
ms.date: 11/01/2024
1111
ms.author: danlep
1212
---
1313
# Tutorial: Monitor published APIs
@@ -37,24 +37,24 @@ 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/essentials/metrics-supported#microsoftapimanagementservice).
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).
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

4444
> [!TIP]
45-
> In the [v2 service tiers](v2-service-tiers-overview.md), API Management replaced the capacity metric with separate CPU and memory utilization metrics. These metrics can also be used for scaling decisions and troubleshooting. [Learn more](api-management-capacity.md)
45+
> In the [v2 service tiers](v2-service-tiers-overview.md), API Management has replaced the capacity metric with separate CPU and memory utilization metrics. These metrics can also be used for scaling decisions and troubleshooting. [Learn more](api-management-capacity.md)
4646
4747
* **Requests** - helps you analyze API traffic going through your API Management services. The metric is emitted per minute and reports the number of gateway requests with dimensions. Filter requests by response codes, location, hostname, and errors.
4848

4949
> [!IMPORTANT]
50-
> The following metrics have been retired: Total Gateway Requests, Successful Gateway Requests, Unauthorized Gateway Requests, Failed Gateway Requests, Other Gateway Requests. Please migrate to the Requests metric which provides equivalent functionality.
50+
> The following metrics have been retired: Total Gateway Requests, Successful Gateway Requests, Unauthorized Gateway Requests, Failed Gateway Requests, Other Gateway Requests. Please migrate to the Requests metric which provides closely similar functionality.
5151
5252
:::image type="content" source="media/api-management-howto-use-azure-monitor/apim-monitor-metrics-1.png" alt-text="Screenshot of Metrics in API Management Overview":::
5353

5454
To access metrics:
5555

5656
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance. On the **Overview** page, on the **Monitor** tab, review key metrics for your APIs.
57-
1. To investigate metrics in detail, select **Metrics** from the left menu.
57+
1. To investigate metrics in detail, select **Monitoring** > **Metrics** from the left menu.
5858

5959
:::image type="content" source="media/api-management-howto-use-azure-monitor/api-management-metrics-blade.png" alt-text="Screenshot of Metrics item in Monitoring menu in the portal.":::
6060

@@ -73,15 +73,14 @@ You can receive [alerts](/azure/azure-monitor/alerts/alerts-metric-overview) bas
7373
To configure an example alert rule based on a request metric:
7474

7575
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
76-
1. Select **Alerts** from the left menu.
76+
1. Select **Monitoring** > **Alerts** from the left menu.
7777

7878
:::image type="content" source="media/api-management-howto-use-azure-monitor/alert-menu-item.png" alt-text="Screenshot of Alerts option in Monitoring menu in the portal.":::
7979

8080
1. Select **+ Create** > **Alert rule**.
81-
1. In the **Select a signal** window on the **Condition** tab:
82-
1. In **Signal type**, select **Metrics**.
81+
1. On the **Condition** tab:
8382
1. In **Signal name**, select **Requests**.
84-
1. In **Alert logic**, specify a **Threshold value**, which is the number of occurrences after which the alert should be triggered.
83+
1. In **Alert logic**, review or modify the default values for the alert. For example, update the static **Threshold**, which is the number of occurrences after which the alert should be triggered.
8584
1. In **Split by dimensions**, in **Dimension name**, select **Gateway Response Code Category**.
8685
1. In **Dimension values**, select **4xx**, for client errors such as unauthorized or invalid requests. If the dimension value doesn't appear, select **Add custom value** and enter **4xx**.
8786
1. In **When to evaluate**, accept the default settings, or select other settings to configure how often the rule runs. Select **Next**.
@@ -94,13 +93,13 @@ To configure an example alert rule based on a request metric:
9493

9594
1. On the **Details** tab of **Create an alert rule**, enter a name and description of the alert rule and select the severity level.
9695
1. Optionally configure the remaining settings. Then, on the **Review + create** tab, select **Create**.
97-
1. Now, test the alert rule by calling the Conference API without an API key. For example:
96+
1. Optionally test the alert rule by using an HTTP client to simulate a request that triggers the alert. For example, run the following command in a terminal, substituting the API Management hostname with the hostname of your API Management instance:
9897

9998
```bash
100-
curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1
99+
curl GET https://contoso.azure-api.net/non-existent-endpoint HTTP/1.1
101100
```
102101

103-
An alert triggers based on the evaluation period, and it will send email to [email protected].
102+
An alert triggers based on the evaluation period, and it will send email to [email protected].
104103

105104
Alerts also appear on the **Alerts** page for the API Management instance.
106105

@@ -111,7 +110,7 @@ To configure an example alert rule based on a request metric:
111110
Activity logs provide insight into the operations on your API Management services. Using activity logs, you can determine the "what, who, and when" for any write operations (PUT, POST, DELETE) taken on your API Management services.
112111

113112
> [!NOTE]
114-
> Activity logs do not include read (GET) operations or operations performed in the Azure portal or using the original Management APIs.
113+
> Activity logs do not include read (GET) operations or operations performed in the Azure portal.
115114

116115
You can access activity logs in your API Management service, or access logs of all your Azure resources in Azure Monitor.
117116

@@ -136,7 +135,7 @@ Resource logs (Azure Monitor logs) provide rich information about API Management
136135
To configure resource logs:
137136
138137
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
139-
2. Select **Diagnostic settings**.
138+
2. Select **Monitoring** > **Diagnostic settings**.
140139
141140
:::image type="content" source="media/api-management-howto-use-azure-monitor/api-management-diagnostic-logs-blade.png" alt-text="Screenshot of Diagnostic settings item in Monitoring menu in the portal.":::
142141
@@ -155,7 +154,7 @@ To configure resource logs:
155154
156155
For more information, see [Create diagnostic settings to send platform logs and metrics to different destinations](/azure/azure-monitor/essentials/diagnostic-settings).
157156
158-
## View diagnostic data in Azure Monitor
157+
## View logs and metrics in Azure Monitor
159158
160159
If you enable collection of logs or metrics in a Log Analytics workspace, it can take a few minutes for data to appear in Azure Monitor.
161160
@@ -177,7 +176,7 @@ To view the data:
177176
178177
For more information about using resource logs for API Management, see:
179178
180-
* [Log Analytics tutorial](/azure/azure-monitor/logs/log-analytics-tutorial), or try the [Log Analytics demo environment](https://ms.portal.azure.com/#view/Microsoft_OperationsManagementSuite_Workspace/LogsDemo.ReactView).
179+
* [Log Analytics tutorial](/azure/azure-monitor/logs/log-analytics-tutorial).
181180
182181
* [Overview of log queries in Azure Monitor](/azure/azure-monitor/logs/log-query-overview).
183182
@@ -191,14 +190,14 @@ For details about the logging settings, see [Diagnostic logging settings referen
191190
192191
To configure logging settings for all APIs:
193192
194-
1. In the left menu of your API Management instance, select **APIs** > **All APIs**.
193+
1. In the left menu of your API Management instance, select **APIs** > **APIs** > **All APIs**.
195194
1. Select the **Settings** tab from the top bar.
196195
1. Scroll down to the **Diagnostic Logs** section, and select the **Azure Monitor** tab.
197196
1. Review the settings and make changes if needed. Select **Save**.
198197
199198
To configure logging settings for a specific API:
200199
201-
1. In the left menu of your API Management instance, select **APIs** and then the name of the API.
200+
1. In the left menu of your API Management instance, select **APIs** > **APIs** and then the name of the API.
202201
1. Select the **Settings** tab from the top bar.
203202
1. Scroll down to the **Diagnostic Logs** section, and select the **Azure Monitor** tab.
204203
1. Review the settings and make changes if needed. Select **Save**.
1012 Bytes
Loading
-629 Bytes
Loading
1.2 KB
Loading
1.12 KB
Loading
-17.7 KB
Loading
1.31 KB
Loading
-9.56 KB
Loading

0 commit comments

Comments
 (0)