Setting display preferences and thresholds for monitoring federated APIs

Set your preferences by customizing the display settings of the widgets and threshold values for the parameters that control the monitoring capability of the assets.

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.

Federated API management 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.

Federated API management 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.

Federated API management 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 the runtime and backend service to process the request.
Latency
The time taken by the runtime 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 deviations from the set threshold values is displayed on the dashboard. You can also closely monitor the APIs, runtimes, and data planes to make informed business decisions.

Procedure

  1. On the Settings page, click the Display tab to customize the display settings.
    1. Click Edit next to the Row setting (Dashboard) and select the trending count from the Number of top items shown drop-down menu that you want to display in the dashboard widgets.
    2. Click the Edit icon corresponding to the widgets that you want to hide and click the respective toggle button.
  2. On the Settings page, click the Threshold tab to customize the threshold settings.
    1. Click the Edit icon corresponding to the sections to modify the default threshold values.
  3. Click Save to save your preferences to observe any deviations from the set threshold values on the dashboard and monitoring pages.