ControlRate

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.

Additional Details...

Tags:

rate control, throttle, rate, throughput

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Display NameAPI NameDefault ValueAllowable ValuesDescription
Rate Control CriteriaRate Control Criteriadata rate
  • data rate Rate is controlled by counting bytes transferred per time duration.
  • flowfile count Rate is controlled by counting FlowFiles transferred per time duration
  • attribute value Rate is controlled by accumulating the value of a specified attribute that is transferred per time duration
  • data rate or flowfile count Rate is controlled by counting bytes and FlowFiles transferred per time duration; if either threshold is met, throttling is enforced
Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.
Time DurationTime Duration1 minThe amount of time to which the Maximum Rate pertains. Changing this value resets the rate counters.
Maximum RateMaximum RateThe maximum rate at which data should pass through this processor. The format of this property is expected to be a positive integer, or a Data Size (such as '1 MB') if Rate Control Criteria is set to 'data rate'.

This Property is only considered if the [Rate Control Criteria] Property is set to one of the following values: [data rate], [attribute value], [flowfile count]
Maximum Data RateMaximum Data RateThe maximum rate at which data should pass through this processor. The format of this property is expected to be a Data Size (such as '1 MB') representing bytes per Time Duration.

This Property is only considered if the [Rate Control Criteria] Property has a value of "data rate or flowfile count".
Maximum FlowFile RateMaximum FlowFile RateThe maximum rate at which FlowFiles should pass through this processor. The format of this property is expected to be a positive integer representing FlowFiles count per Time Duration

This Property is only considered if the [Rate Control Criteria] Property has a value of "data rate or flowfile count".
Rate Exceeded StrategyRate Exceeded StrategyHold FlowFile
  • Hold FlowFile The FlowFile will be held in its input queue until the rate of data has fallen below the configured maximum and will then be allowed through.
  • Route to 'rate exceeded' The FlowFile will be routed to the 'rate exceeded' Relationship.
Specifies how to handle an incoming FlowFile when the maximum data rate has been exceeded.
Rate Controlled AttributeRate Controlled AttributeThe name of an attribute whose values build toward the rate limit if Rate Control Criteria is set to 'attribute value'. The value of the attribute referenced by this property must be a positive long, or the FlowFile will be routed to failure. This value is ignored if Rate Control Criteria is not set to 'attribute value'. Changing this value resets the rate counters.

This Property is only considered if the [Rate Control Criteria] Property has a value of "attribute value".
Grouping AttributeGrouping AttributeBy default, a single "throttle" is used for all FlowFiles. If this value is specified, a separate throttle is used for each value specified by the attribute with this name. Changing this value resets the rate counters.

Relationships:

NameDescription
failureFlowFiles will be routed to this relationship if they are missing a necessary Rate Controlled Attribute or the attribute is not in the expected format
successFlowFiles are transferred to this relationship under normal conditions

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

Example Use Cases:

Use Case:

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.



Use Case:

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.



Use Case:

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.



Use Case:

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.



System Resource Considerations:

None specified.