Parameter | Value | ||||||||||||||||||||||||||||||||||||||||
Action Configuration. Specifies the type of action to be configured. | |||||||||||||||||||||||||||||||||||||||||
Name | Specifies the name of the metric to be monitored. You can select one of the available metrics: ![]() For example, if you set Availability as less than 90, then whenever the availability of the native API falls below 90%, in the specified time interval, API Gateway generates an alert. Suppose, the alert interval is set as 1 minute (60 seconds) and if there are 7 API invocations at various times in that 1 minute with a combination of up and down as shown in the table, the availability is calculated as follows:
As the availability of the native API calculated is 66.67% and falls below 90%, API Gateway generates an alert. The API is considered to be down for the ongoing request when API Gateway receives a connection related error from the native API in the outbound call. If the API does not respond with an HTTP response, then it is considered as down. ![]() For example, if you set an alert for Average response time greater than 30 ms with an interval of 1 minute then on API activation, the monitoring interval starts and the average of the response time of all runtime invocations for this API in 1 minute is calculated. If this is greater than 30 ms, then a monitor event is generated. If this is configured under Monitor service performance, then all the runtime invokes are taken into account. ![]() ![]() ![]() ![]() ![]() | ||||||||||||||||||||||||||||||||||||||||
Operator | Specifies the operator applicable to the metric selected. Select one of the available operator: Greater Than, Less Than, Equals To. | ||||||||||||||||||||||||||||||||||||||||
Value | Specifies the alert value for which the monitoring is applied. | ||||||||||||||||||||||||||||||||||||||||
Destination | Specifies the destination where the alert is to be logged. Select the required options: ![]() ![]() ![]() Note: This option is applicable only for the APIs published from CentraSite to API Gateway. ![]() ![]() ![]() ![]() Note: If an email alias is available, you can type the email alias in the Email Address field with the following syntax, ${emailaliasname}. For example, if test is the email alias, then type ${test}. ![]() ![]() Note: ![]() ![]() ![]() | ||||||||||||||||||||||||||||||||||||||||
Alert Interval | Specifies the time period in which to monitor performance before sending an alert if a condition is violated. The timer starts once the API is activated and resets after the configured time interval. If and API is deactivated the interval gets reset and on API activation its starts afresh. | ||||||||||||||||||||||||||||||||||||||||
Unit | Specifies the unit for the time interval in minutes, hours, days, or weeks for the alert interval. | ||||||||||||||||||||||||||||||||||||||||
Alert Frequency | Specifies how frequently to issue alerts for the counter-based metrics (Total Request Count, Success Count, Fault Count). Select one of the options: ![]() ![]() | ||||||||||||||||||||||||||||||||||||||||
Alert Message | Specifies the text to be included in the alert. |