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
In the Developer, Basic, Standard, and Premium tiers, the **Capacity** metric is available for making decisions about scaling or upgrading an API Management instance. Its construction is complex and imposes certain behavior.
53
53
54
-
Total **capacity** is an average of its own values from every [unit](upgrade-and-scale.md) of an API Management instance.
54
+
Available aggregations for this metric are as follows.
55
+
56
+
***Avg** - Average percentage of capacity used across gateway processes in every [unit](upgrade-and-scale.md) of an API Management instance.
57
+
***Max** - Percentage of capacity in gateway process with the greatest consumption.

59
64
60
65
**Capacity** is an indicator of load on an API Management instance. It reflects usage of resources (CPU, memory) and network queue lengths.
@@ -80,23 +85,26 @@ The more complex operations on the requests are, the higher the capacity consump
80
85
81
86
Capacity metrics can also spike intermittently or be greater than zero even if no requests are being processed. It happens because of system- or platform-specific actions and should not be taken into consideration when deciding whether to scale an instance.
82
87
83
-
Although capacity metrics are designed to surface problems with your API Management instance, there are cases when problems won't be reflected in changes in these metrics.
84
-
85
-
Low capacity metrics don't necessarily mean that your API Management instance isn't experiencing any problems.
88
+
Although capacity metrics are designed to surface problems with your API Management instance, there are cases when problems won't be reflected in changes in these metrics. Additionally, low capacity metrics don't necessarily mean that your API Management instance isn't experiencing any problems.
86
89
87
90
88
91
## Use the Azure portal to examine capacity metrics
89
92
93
+
Access metrics in the portal to understand how much capacity is used over time.
94
+
90
95
#### [v2 tiers](#tab/v2-tiers)
91
96
92
97
1. Navigate to your API Management instance in the [Azure portal](https://portal.azure.com/).
93
98
1. In the left menu, under **Monitoring**, select **Metrics**.
94
99
1. Select the **CPU Percentage of Gateway** or **Memory Percentage of Gateway** metric from the available metrics. Choose the default **Avg** aggregation or select the **Max** aggregation to see the peak usage.
95
100
1. Pick a desired timeframe from the top bar of the section.
96
101
102
+
> [!IMPORTANT]
103
+
> Currently, the **Capacity** metric also appears in the portal for instances in v2 tiers. However, it's not supported for use in the v2 tiers and shows a value of 0.
97
104
98
105
> [!NOTE]
99
106
> You can set a [metric alert](api-management-howto-use-azure-monitor.md#set-up-an-alert-rule) to let you know when something unexpected is happening. For example, get notifications when your API Management instance has exceeded its expected peak CPU or Memory usage for more than 20 minutes.
107
+
100
108
101
109
#### [Classic tiers](#tab/classic)
102
110
@@ -112,12 +120,17 @@ Low capacity metrics don't necessarily mean that your API Management instance is
112
120
1. To split the metric by location, from the section at the top, select **Apply splitting** and then select **Location**.
113
121
1. Pick a desired timeframe from the top bar of the section.
114
122
115
-
You can set a [metric alert](api-management-howto-use-azure-monitor.md#set-up-an-alert-rule) to let you know when something unexpected is happening. For example, get notifications when your API Management instance has exceeded its expected peak capacity for more than 20 minutes.
123
+
> [!IMPORTANT]
124
+
> Currently, the **CPU Percentage of Gateway** and **Memory Consumption of Gateway** metrics also appear in the portal for instances in classic tiers. However, they're not supported for use in classic tiers and show a value of 0.
125
+
126
+
116
127
117
128
118
-
> [!TIP]
119
-
> You can use Azure Monitor [autoscaling](api-management-howto-autoscale.md) to automatically add an Azure API Management unit. Scaling operation can take around 30 minutes, so you should plan your rules accordingly.
120
-
> In multi-region deployments, only scaling the master location is allowed.
129
+
130
+
> [!NOTE]
131
+
> * You can set a [metric alert](api-management-howto-use-azure-monitor.md#set-up-an-alert-rule) to let you know when something unexpected is happening. For example, get notifications when your API Management instance has exceeded its expected peak capacity for more than 20 minutes.
132
+
> * You can use Azure Monitor [autoscaling](api-management-howto-autoscale.md) to automatically add an Azure API Management unit. Scaling operation can take around 30 minutes, so you should plan your rules accordingly.
133
+
> * In multi-region deployments, only scaling the primary location is allowed.
0 commit comments