Traffic Shaping

Shaping is a new throttle violation policy. TIBCO API Exchange Gateway is capable of shaping the requests traffic after reaching the throttle metric. By default, TIBCO API Exchange Gateway blocks the throttled request and sends an error response.

When the Shaping feature is enabled for a facade operation request and the request violates the rate throttle metric, the transaction is placed in an internal queue and the transaction state is set to held. When the throttle metric has been reset by the Global Throttle Manager, all the held transactions are released up to the limit for the throttle and the Core Engine continues to process these transactions. This means that all throttle chains are reevaluated when the transaction is released.

For the performance reasons, the Core Engine does not remove the transactions from the Shaping queue after the transactions are processed from the queue. The gateway uses a separate timer to compact the queue to truncate the queue. See QueueCompactionInterval.

If the transactions in this queue time out, the Core Engine processes the request with normal error handling.

Note:
  • Shaping is only valid for the rate throttles.
  • The Shaping feature does not support the custom monitors.
  • When the Shaping feature is enabled for a rate throttle and if the rate throttle is applied at the end of a throttle chain, the earlier throttles in the chain are not decremented.