Skip to content

Commit 4ab697e

Browse files
authored
Merge pull request #182199 from rachana-satao/RAS-7-12-2021-azure-api-management-1890463-1
Update in Monitor-APIs-US1890463
2 parents 492cf9f + 4ca3e3e commit 4ab697e

File tree

4 files changed

+19
-18
lines changed

4 files changed

+19
-18
lines changed

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

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
---
22
title: Tutorial - Monitor published APIs in Azure API Management | Microsoft Docs
3-
description: Follow the steps of this tutorial to learn how to use metrics, alerts, activity logs, and resource logs to monitor your APIs in Azure API Management.
3+
description: Learn how to use metrics, alerts, activity logs, and resource logs to monitor your APIs in Azure API Management.
44
services: api-management
55
author: dlepow
66

77
ms.service: api-management
8-
ms.custom: mvc
8+
ms.custom: mvc, devdivchpfy22
99
ms.topic: tutorial
10-
ms.date: 10/14/2020
10+
ms.date: 12/09/2021
1111
ms.author: danlep
1212
---
1313
# Tutorial: Monitor published APIs
@@ -17,8 +17,8 @@ With Azure Monitor, you can visualize, query, route, archive, and take actions o
1717
In this tutorial, you learn how to:
1818

1919
> [!div class="checklist"]
20-
> * View metrics of your API
21-
> * Set up an alert rule
20+
> * View metrics of your API
21+
> * Set up an alert rule
2222
> * View activity logs
2323
> * Enable and view resource logs
2424
@@ -37,12 +37,12 @@ You can also use API Management's built-in [analytics](howto-use-analytics.md) t
3737
API Management emits [metrics](../azure-monitor/essentials/data-platform-metrics.md) every minute, giving you near real-time visibility into the state and health of your APIs. The following are the two most frequently used metrics. For a list of all available metrics, see [supported metrics](../azure-monitor/essentials/metrics-supported.md#microsoftapimanagementservice).
3838

3939
* **Capacity** - helps you make decisions about upgrading/downgrading your APIM services. The metric is emitted per minute and reflects the gateway capacity at the time of reporting. The metric ranges from 0-100 calculated based on gateway resources such as CPU and memory utilization.
40-
* **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 including response codes, location, hostname, and errors.
40+
* **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.
4141

4242
> [!IMPORTANT]
4343
> The following metrics have been deprecated as of May 2019 and will be retired in August 2023: 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.
4444
45-
:::image type="content" source="media/api-management-howto-use-azure-monitor/apim-monitor-metrics.png" alt-text="Screenshot of Metrics in API Management Overview":::
45+
:::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":::
4646

4747
To access metrics:
4848

@@ -51,11 +51,11 @@ To access metrics:
5151

5252
:::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":::
5353

54-
1. From the drop-down, select metrics you are interested in. For example, **Requests**.
54+
1. From the drop-down, select metrics you're interested in. For example, **Requests**.
5555
1. The chart shows the total number of API calls.
56-
1. The chart can be filtered using the dimensions of the **Requests** metric. For example, select **Add filter**, select **Backend Response Code Category**, enter 500 as the value. Now the chart shows the number of requests that were failed in the API backend.
56+
1. You can filter the chart using the dimensions of the **Requests** metric. For example, select **Add filter**, select **Backend Response Code Category**, enter 500 as the value. The chart shows the number of requests failed in the API backend.
5757

58-
## Set up an alert rule
58+
## Set up an alert rule
5959

6060
You can receive [alerts](../azure-monitor/alerts/alerts-metric-overview.md) based on metrics and activity logs. Azure Monitor allows you to [configure an alert](../azure-monitor/alerts/alerts-metric.md) to do the following when it triggers:
6161

@@ -77,31 +77,32 @@ To configure an example alert rule based on a request metric:
7777
1. In **Signal name**, select **Requests**.
7878
1. In **Split by dimensions**, in **Dimension name**, select **Gateway Response Code Category**.
7979
1. In **Dimension values**, select **4xx**, for client errors such as unauthorized or invalid requests.
80-
1. In **Alert logic**, specify a threshold after which the alert should be triggered and select **Done**.
80+
1. In **Alert logic**, specify a **Threshold value** after which the alert should be triggered.
81+
1. In **Evaluated based on**, specify **Aggregation granularity** and **Frequency of evaluation**, then select **Done**.
8182

82-
:::image type="content" source="media/api-management-howto-use-azure-monitor/threshold.png" alt-text="Screenshot of Configure Signal Logic windows":::
83+
:::image type="content" source="media/api-management-howto-use-azure-monitor/threshold-1.png" alt-text="Screenshot of Configure Signal Logic windows":::
8384

8485
1. Select an existing action group or create a new one. In the following example, a new action group is created. A notification email will be sent to [email protected].
8586

8687
:::image type="content" source="media/api-management-howto-use-azure-monitor/action-details.png" alt-text="Screenshot of notifications for new action group":::
8788

88-
1. Enter a name and description of the alert rule and select the severity level.
89+
1. Enter a name and description of the alert rule and select the severity level.
8990
1. Select **Create alert rule**.
9091
1. Now, test the alert rule by calling the Conference API without an API key. For example:
9192

9293
```bash
9394
curl GET https://apim-hello-world.azure-api.net/conference/speakers HTTP/1.1
9495
```
9596

96-
An alert will be triggered based on the evaluation period, and email will be sent to [email protected].
97+
An alert triggers based on the evaluation period, and it will send email to [email protected].
9798

9899
Alerts also appear on the **Alerts** page for the API Management instance.
99100

100101
:::image type="content" source="media/api-management-howto-use-azure-monitor/portal-alerts.png" alt-text="Screenshot of alerts in portal":::
101102

102103
## Activity logs
103104

104-
Activity logs provide insight into the operations that were performed 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.
105+
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.
105106

106107
> [!NOTE]
107108
> Activity logs do not include read (GET) operations or operations performed in the Azure portal or using the original Management APIs.
@@ -121,7 +122,7 @@ To view the activity log:
121122

122123
## Resource logs
123124

124-
Resource logs provide rich information about operations and errors that are important for auditing as well as troubleshooting purposes. Resource logs differ from activity logs. The activity log provides insights into the operations that were performed on your Azure resources. Resource logs provide insight into operations that your resource performed.
125+
Resource logs provide rich information about operations and errors that are important for auditing and troubleshooting purposes. Resource logs differ from activity logs. The activity log provides insights into the operations run on your Azure resources. Resource logs provide insight into operations that your resource ran.
125126

126127
To configure resource logs:
127128

@@ -133,7 +134,7 @@ To configure resource logs:
133134
1. Select **+ Add diagnostic setting**.
134135
1. Select the logs or metrics that you want to collect.
135136

136-
You can archive resource logs along with metrics to a storage account, stream them to an Event Hub, or send them to a Log Analytics workspace.
137+
You can archive resource logs along with metrics to a storage account, stream them to an Event Hub, or send them to a Log Analytics workspace.
137138

138139
For more information, see [Create diagnostic settings to send platform logs and metrics to different destinations](../azure-monitor/essentials/diagnostic-settings.md).
139140

@@ -202,7 +203,7 @@ In this tutorial, you learned how to:
202203

203204
> [!div class="checklist"]
204205
> * View metrics of your API
205-
> * Set up an alert rule
206+
> * Set up an alert rule
206207
> * View activity logs
207208
> * Enable and view resource logs
208209

158 KB
Loading
-11.3 KB
Loading
308 KB
Loading

0 commit comments

Comments
 (0)