Throttle Policy Reset Support for APIM

[Chanuka-ChandraYapa]

Problem

API Manager currently cannot reset the request counters manually after or before the throttle policy limit has been reached within the throttling time window. The throttle policy limit can be reached due to spikes or unintended requests. Hence, API Users should wait until the throttling time period expires to invoke API calls again. In that case, there can be a requirement to allow further usage resuming API consumption for consumers seamlessly.

Solution

The proposed solution involves publishing a separate asynchronous reset event to the current Siddhi stream at the traffic manager. We are planning to use the existing Siddhi event stream process flow with additional changes to support resetting relevant counters. This approach involves changing the current execution plan format and creating a new data publisher to publish the reset event to the Siddhi runtime.

Affected Component

APIM

Version

4.2.0

Implementation

High level design for the proposed solution.

Tasks to be done

Application Level Throttle Policy Reset

• Rest API implementation
• Notify the reset event to eventhub
• Publish the reset event fetched from event hub to Siddhi Stream
• Write Siddhi extensions to handle reset event
• Frontend Implementation
• Unit Testing
• Integration Testing
• Update APIM docs

Related Issues

No response

Suggested Labels

No response

[rmsamitha]

Let's remove the deferred tasks from the issue description