Skip to content

Commit 0283ff0

Browse files
committed
edits
1 parent ff049ff commit 0283ff0

File tree

1 file changed

+25
-12
lines changed

1 file changed

+25
-12
lines changed

articles/api-management/api-management-capacity.md

Lines changed: 25 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,25 +36,30 @@ Different capacity metrics are available in the [v2 service tiers](v2-service-ti
3636

3737
In the v2 tiers, the following metrics are available:
3838

39-
* **CPU Percentage of Gateway** - The percentage of CPU used by the gateway units.
39+
* **CPU Percentage of Gateway** - The percentage of CPU capacity used by the gateway units.
4040

41-
* **Memory Percentage of Gateway** - The percentage of memory used by the gateway units.
41+
* **Memory Percentage of Gateway** - The percentage of memory capacity used by the gateway units.
4242

4343
Available aggregations for these metrics are as follows.
4444

45-
* **Avg** - Average percentage of gateway capacity consumed across every [unit](upgrade-and-scale.md) of an API Management instance.
46-
* **Max** - Percentage of gateway capacity of the process with the greatest consumption.
45+
* **Avg** - Average percentage of capacity used across gateway processes in every [unit](upgrade-and-scale.md) of an API Management instance.
46+
* **Max** - Percentage of capacity in gateway process with the greatest consumption.
4747

4848
[!INCLUDE [api-management-cpu-memory-capacity](../../includes/api-management-cpu-memory-capacity.md)]
4949

5050
#### [Classic tiers](#tab/classic)
5151

5252
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.
5353

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

5659
[!INCLUDE [availability-capacity.md](../../includes/api-management-availability-capacity.md)]
5760

61+
### What the Capacity metric indicates
62+
5863
![Diagram that explains the Capacity metric.](./media/api-management-capacity/capacity-ingredients.png)
5964

6065
**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
8085

8186
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.
8287

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

8790

8891
## Use the Azure portal to examine capacity metrics
8992

93+
Access metrics in the portal to understand how much capacity is used over time.
94+
9095
#### [v2 tiers](#tab/v2-tiers)
9196

9297
1. Navigate to your API Management instance in the [Azure portal](https://portal.azure.com/).
9398
1. In the left menu, under **Monitoring**, select **Metrics**.
9499
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.
95100
1. Pick a desired timeframe from the top bar of the section.
96101

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.
97104
98105
> [!NOTE]
99106
> 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+
100108

101109
#### [Classic tiers](#tab/classic)
102110

@@ -112,12 +120,17 @@ Low capacity metrics don't necessarily mean that your API Management instance is
112120
1. To split the metric by location, from the section at the top, select **Apply splitting** and then select **Location**.
113121
1. Pick a desired timeframe from the top bar of the section.
114122

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+
116127

117128

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.
121134
122135
---
123136

0 commit comments

Comments
 (0)