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
API Management provides [Azure Monitor metrics](api-management-howto-use-azure-monitor.md#view-metrics-of-your-apis) to detect use of system capacity, helping you make informed decisions whether to [scale or upgrade](upgrade-and-scale.md) an API Management instance to accommodate more load.
18
+
API Management provides [Azure Monitor metrics](api-management-howto-use-azure-monitor.md#view-metrics-of-your-apis) to detect use of system capacity, helping you troubleshoot gateway problems and make informed decisions whether to [scale or upgrade](upgrade-and-scale.md) an API Management instance to accommodate more load.
19
19
20
20
This article explains the capacity metrics and how they behave, shows how to access capacity metrics in the Azure portal, and suggests when to consider scaling or upgrading your API Management instance.
21
21
@@ -40,8 +40,12 @@ In the v2 tiers, the following metrics are available:
40
40
41
41
***Memory Percentage of Gateway** - The percentage of memory used by the gateway units.
Total **capacity** is an average of its own values from every [unit](upgrade-and-scale.md) of an API Management instance.
61
-
62
-
Although the **capacity metric** is designed to surface problems with your API Management instance, there are cases when problems won't be reflected in changes in the **capacity metric**.
63
-
64
64
---
65
65
66
66
## Capacity metric behavior
@@ -71,7 +71,7 @@ In real life capacity metrics can be impacted by many variables, for example:
71
71
+ size of a request and response
72
72
+ policies configured on each API or number of clients sending requests.
73
73
74
-
The more complex operations on the requests are, the higher the capacity consumption will be. For example, complex transformation policies consume much more CPU than a simple request forwarding. Slow backend service responses will increase it, too.
74
+
The more complex operations on the requests are, the higher the capacity consumption is. For example, complex transformation policies consume much more CPU than a simple request forwarding. Slow backend service responses increase it, too.
75
75
76
76
> [!IMPORTANT]
77
77
> Capacity metrics are not direct measures of the number of requests being processed.
@@ -80,6 +80,8 @@ The more complex operations on the requests are, the higher the capacity consump
80
80
81
81
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
82
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
+
83
85
Low capacity metrics don't necessarily mean that your API Management instance isn't experiencing any problems.
84
86
85
87
@@ -125,8 +127,8 @@ Use capacity metrics for making decisions whether to scale an API Management ins
125
127
126
128
+ Look at a long-term trend and average.
127
129
+ Ignore sudden spikes that are most likely not related to an increase in load (see [Capacity metric behavior](#capacity-metric-behavior) section for explanation).
128
-
+ As a general rule, upgrade or scale your instance when the **capacity** value exceeds **60% - 70%** for a long period of time (for example, 30 minutes). Different values may work better for your service or scenario.
129
-
+ If your instance is configured with only 1 unit, upgrade or scale your instance when the **capacity** value exceeds **40%** for a long period. This recommendation is based on the need to reserve capacity for guest OS updates in the underlying service platform.
130
+
+ As a general rule, upgrade or scale your instance when a capacity metric value exceeds **60% - 70%** for a long period of time (for example, 30 minutes). Different values may work better for your service or scenario.
131
+
+ If your instance is configured with only 1 unit, upgrade or scale your instance when a capacity metric value exceeds **40%** for a long period. This recommendation is based on the need to reserve capacity for guest OS updates in the underlying service platform.
130
132
131
133
>[!TIP]
132
134
> If you are able to estimate your traffic beforehand, test your API Management instance on workloads you expect. You can increase the request load on your tenant gradually and monitor the value of the capacity metric that corresponds to your peak load. Follow the steps from the previous section to use Azure portal to understand how much capacity is used at any given time.
0 commit comments