Change Threshold Settings
About this task
Threshold settings refer to the values used to set a specific limit for a particular variable or a system.
These settings are used to specify a variable's acceptable range of values, and if the variable's value comes within that range, a specific action is taken.
API Control Plane has the following major threshold settings:
- Trend threshold settings. Trend threshold settings refer to the values
used to define a particular trend or pattern in a time series data. These settings are used to
identify when the data is deviating from its expected trend or pattern, and trigger a particular
action.
API Control Plane has upward and downward trend threshold settings for APIs and runtimes.
- Performance threshold settings. Performance threshold settings refer to
the values used to measure the performance of a system, or a service. These settings are used to
determine when the performance of the system, or a service is outside of the acceptable range, and
trigger a particular action.
API Control Plane measures the performance threshold settings for data planes and runtimes based on the latency and error rate parameters.
The trend and performance threshold settings depend on the following parameters,
- Number of transactions. The total number of transactions handled by a runtime.
- Error rate. The total number of failed transactions in a runtime.
- Response time. The total time taken to process an incoming API request and send the response to the client. It includes the time that is taken by API Gateway and the backend service to process the request.
- Latency. The time taken by API Gateway to process an API request. It does not include the time that is taken by the backend service to process the request.
By setting the threshold for these parameters, you can monitor APIs and runtimes for an upward or improving trend and a downward or deteriorating trend. You can set a performance threshold for the data planes and runtimes. Any deviaton from the set threshold values is displayed in the dashboard.
You can also closely monitor the APIs, runtimes, and data planes to make informed business decisions.
Procedure
-
Click the
icon and select the Threshold tab.
The Settings > Threshold tab appears. -
Click Edit in any of the following sections to modify the default
threshold values,
- API: Upward trending/improving
- API: Downward trending/deteriorating by
- Runtime: Upward trending/improving
- Runtime: Downward trending/deteriorating by
- Data plane: Performance threshold
- Runtime: Performance threshold
The following table displays the default values for the upward or improving and downward or deteriorating thresholds,
Parameter Default value No of transactions 10% Error rate 10% Response time 10% Latency 10% The following image shows the Edit screen for the API: Upward trending/improving threshold.
The following table displays the default values for the Data plane and Runtime performance thresholds,
Parameter Default value Latency threshold - Acceptable limit: 30 milliseconds
- Warning limit: 70 milliseconds
- Unacceptable limit: 100 milliseconds
Error rate threshold - Acceptable limit: 25%
- Warning limit: 25%
- Unacceptable limit: 100%
Interpreting performance threshold- Acceptable limit. The limit at which the latency or error rate threshold
value is acceptable. For example, when the acceptable limit is set as 30 ms or 25% for runtimes and
data planes, the Performance widget in the Dashboard displays the
icon when the latency or error rate limit is within the acceptable limit. - Warning limit. The limit at which an indication must be shown that the
latency or error rate threshold value is approaching the set warning limit. For example, when you
set the warning limit at 70 ms or 25% and the acceptable limit at 30 ms or 25% for runtimes and data
planes, the Performance widget in the Dashboard displays the
icon if the latency or error rate threshold is between the acceptable and warning
limits. - Unacceptable limit. The maximum threshold limit for latency or error rate
threshold values. Any deviation beyond this limit is unacceptable. For example, when the error limit
is set at 100 ms or 100% for runtimes and data planes, the Performance widget in the Dashboard
displays the
icon when the latency or error rate limit is higher than the set unacceptable limit.
The following image shows the Edit screen for Data plane: Performance threshold.
Click
next to the API: Upward trending/improving or API:
Downward trending/deteriorating by or Runtime: Upward
trending/improving or Runtime: Downward trending/deteriorating by
or Data plane: Performance threshold or Runtime: Performance
threshold sections if you want to restore the settings of the corresponding section to
its default settings.