Try WSO2 Cloud for Free
Sign in

All docs This doc
Skip to end of metadata
Go to start of metadata

WSO2 API Cloud supports the following alert types.

Abnormal response time

Reason for triggeringWhen there is a sudden increase in the response time of a specific API resource.
IndicationSlow WSO2 API Cloud runtime, or slow backend.
DescriptionThis alert gets triggered when the response time of a particular API for which this alert type is configured is higher than the configured threshold value. These alerts can be an indication of a slow runtime or backend.

Abnormal backend time

Reason for triggeringIf there is a sudden increase in the backend time corresponding to a particular API resource.
IndicationSlow backend
DescriptionThis alert gets triggered when the backend time corresponding to a particular API for which this alert type is configured is higher than the configured threshold value. These alerts can be an indication of a slow backend.

Abnormal request count

Reason for triggeringIf there is a sudden spike or a drop in the request count within a period of one minute by default for a particular API resource.
IndicationThese alerts can be considered indications of high traffic, suspicious acts or the malfunction of client applications etc.
DescriptionThis alert is triggered when there is a sudden spike in the request count within a period of one minute by default for a specified API of an application for which this alert type is configured. These alerts can be an indication of possible high traffic, suspicious activity etc.

Abnormal resource access

Reason for triggeringIf there is a change in the resource access pattern of a user who uses a particular application.
IndicationThese alerts can be considered as indications of suspicious activities done by one or more users in your application.
Description

A Markov Chain model is built for each application to learn its resource access pattern. For the purpose of learning the resource access patterns, no alerts are sent during the first 500 (default) requests. After learning the normal pattern of a specific application, WSO2 Analytics performs a real time check on a transition done by a specific user, and sends an alert if it is identified as an abnormal transition. For a transition to be considered valid, it has to occur within 60 minutes by default, and it should be by the same user.

The above diagram depicts an example where a Markov Chain model is created during the learning curve of the system. Two states are recorded against Application A and the arrows show the directions of the transitions. Each arrow carries a probability value that stands for the probability of a specific transition taking place. Assume that the following two consecutive events are received by the application from user john@abc.com.

  1. DELETE /API1/number/1
  2. DELETE /API1/number/3

The above transition has happened from the DELETE /API1/number/{x} state to itself. According to the Markov chain model learnt by the system, the probability of this transition occurring is very low. Therefore, an alert is sent.

Unseen source IP access

Reason for TriggeringIf there is either a change in the request source IP for a specific API of an application, or if the request if from an IP used before 30 days (default).
IndicationThese alerts can be considered as indications of suspicious activities carried out by a user over an API of an application.
Description

The first 500 requests are used only for learning purposes by default and therefore, no alerts are sent during that time. However, the learning would continue even after the first 500 requests. This means, even if you receive continuous requests from the newly detected IP2 IP, you are alerted only once. 

Tier crossing

Reason for Triggering

This alert is triggered in the following scenarios.

  • If a particular application is throttled for reaching a subscribed tier limit more than the specified number of times during a defined period (10 times within a day by default).
  • If a particular user of an application is throttled for reaching a subscribed tier limit of a specific API more than the specified number of times during a defined period (10 times within a day by default).

IndicationThese alerts indicate that you need to subscribe to a higher tier.

Health availability

These alerts are triggered for the reasons specified in the tables below.

Reason for Triggering

The response time of an API is greater than the upper percentile value specified for the same (which is 95 by default). This should occur continuously for a specified number of times (5 times by default).

IndicationThe response time is too high.
Reason for TriggeringThe request count of an API per minute is less than the lower percentile value specified for the same (which is 5 by default). This should occur 5 times (i.e. 5 minutes) continuously in order to trigger the error.
IndicationThe request count per minute is normal, but the response count per minute is low.
Reason for TriggeringThe response status code is greater than or equal to 500, but less than 600. This should occur continuously for a specified number of times ( 5 by default) in order to trigger an alert.
IndicationA server side error has occurred.

Note

For more information on how API status changes depending on health availability of APIs, see Viewing Availability of APIs.

  • No labels