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.

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.

NameDefault ValueAllowable ValuesDescription
Rate 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
Indicates the criteria that is used to control the throughput rate. Changing this value resets the rate counters.
Maximum 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'.
Rate 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.
Time Duration1 minThe amount of time to which the Maximum Rate pertains. Changing this value resets the rate counters.
Grouping 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
successFlowFiles are transferred to this relationship under normal conditions
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

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.