ControlRate 2.0.0

Bundle
org.apache.nifi | nifi-standard-nar
Description
Controls the rate at which data is transferred to follow-on processors. If you configure a very small Time Duration, then the accuracy of the throttle gets worse. You can improve this accuracy by decreasing the Yield Duration, at the expense of more Tasks given to the processor.
Tags
rate, rate control, throttle, throughput
Input Requirement
REQUIRED
Supports Sensitive Dynamic Properties
false
Properties
Relationships
Name Description
failure FlowFiles will be routed to this relationship if they are missing a necessary Rate Controlled Attribute or the attribute is not in the expected format
success FlowFiles are transferred to this relationship under normal conditions
Use Cases
  • Limit the rate at which data is sent to a downstream system with little to no bursts
    Description
    Limit the rate at which data is sent to a downstream system with little to no bursts
    Keywords
    throttle, limit, slow down, data rate
    Configuration
    Set the "Rate Control Criteria" to `data rate`.
Set the "Time Duration" property to `1 sec`.
Configure the "Maximum Rate" property to specify how much data should be allowed through each second.

For example, to allow through 8 MB per second, set "Maximum Rate" to `8 MB`.
  • Limit the rate at which FlowFiles are sent to a downstream system with little to no bursts
    Description
    Limit the rate at which FlowFiles are sent to a downstream system with little to no bursts
    Keywords
    throttle, limit, slow down, flowfile rate
    Configuration
    Set the "Rate Control Criteria" to `flowfile count`.
Set the "Time Duration" property to `1 sec`.
Configure the "Maximum Rate" property to specify how many FlowFiles should be allowed through each second.

For example, to allow through 100 FlowFiles per second, set "Maximum Rate" to `100`.
  • Reject requests that exceed a specific rate with little to no bursts
    Description
    Reject requests that exceed a specific rate with little to no bursts
    Keywords
    throttle, limit, slow down, request rate
    Configuration
    Set the "Rate Control Criteria" to `flowfile count`.
Set the "Time Duration" property to `1 sec`.
Set the "Rate Exceeded Strategy" property to `Route to 'rate exceeded'`.
Configure the "Maximum Rate" property to specify how many requests should be allowed through each second.

For example, to allow through 100 requests per second, set "Maximum Rate" to `100`.
If more than 100 requests come in during any one second, the additional requests will be routed to `rate exceeded` instead of `success`.
  • Reject requests that exceed a specific rate, allowing for bursts
    Description
    Reject requests that exceed a specific rate, allowing for bursts
    Keywords
    throttle, limit, slow down, request rate
    Configuration
    Set the "Rate Control Criteria" to `flowfile count`.
Set the "Time Duration" property to `1 min`.
Set the "Rate Exceeded Strategy" property to `Route to 'rate exceeded'`.
Configure the "Maximum Rate" property to specify how many requests should be allowed through each minute.

For example, to allow through 100 requests per second, set "Maximum Rate" to `6000`.
This will allow through 6,000 FlowFiles per minute, which averages to 100 FlowFiles per second. However, those 6,000 FlowFiles may come all within the first couple of
seconds, or they may come in over a period of 60 seconds. As a result, this gives us an average rate of 100 FlowFiles per second but allows for bursts of data.
If more than 6,000 requests come in during any one minute, the additional requests will be routed to `rate exceeded` instead of `success`.