org.apache.nifi.processors.standard

Class ControlRate

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.ControlRate

All Implemented Interfaces:

ConfigurableComponent, Processor

@SideEffectFree
@TriggerSerially
@InputRequirement(value=INPUT_REQUIRED)
@Tags(value={"rate control","throttle","rate","throughput"})
@CapabilityDescription(value="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.")
public class ControlRate
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ControlRate.Throttle
private class	ControlRate.ThrottleFilter

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_RATE
static AllowableValue	ATTRIBUTE_RATE_VALUE
static String	DATA_RATE
static AllowableValue	DATA_RATE_VALUE
private static String	DEFAULT_GROUP_ATTRIBUTE
static String	FLOWFILE_RATE
static AllowableValue	FLOWFILE_RATE_VALUE
static PropertyDescriptor	GROUPING_ATTRIBUTE_NAME
private String	groupingAttributeName
private AtomicLong	lastThrottleClearTime
static int	MAX_FLOW_FILES_PER_BATCH
static PropertyDescriptor	MAX_RATE
private String	maximumRateStr
private static Pattern	POSITIVE_LONG_PATTERN
private List<PropertyDescriptor>	properties
static PropertyDescriptor	RATE_CONTROL_ATTRIBUTE_NAME
static PropertyDescriptor	RATE_CONTROL_CRITERIA
private String	rateControlAttribute
private String	rateControlCriteria
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
private ConcurrentMap<String,ControlRate.Throttle>	throttleMap
static PropertyDescriptor	TIME_PERIOD
private int	timePeriodSeconds

Constructor Summary

Constructors

Constructor and Description
ControlRate()

Method Summary

Methods

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext context)
private long	getFlowFileAccrual(FlowFile flowFile)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onPropertyModified(PropertyDescriptor descriptor, String oldValue, String newValue)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, validate

Field Detail

DATA_RATE

public static final String DATA_RATE

See Also:

Constant Field Values

FLOWFILE_RATE

public static final String FLOWFILE_RATE

See Also:

Constant Field Values

ATTRIBUTE_RATE

public static final String ATTRIBUTE_RATE

See Also:

Constant Field Values

DATA_RATE_VALUE

public static final AllowableValue DATA_RATE_VALUE

FLOWFILE_RATE_VALUE

public static final AllowableValue FLOWFILE_RATE_VALUE

ATTRIBUTE_RATE_VALUE

public static final AllowableValue ATTRIBUTE_RATE_VALUE

MAX_FLOW_FILES_PER_BATCH

public static final int MAX_FLOW_FILES_PER_BATCH

See Also:

Constant Field Values

RATE_CONTROL_CRITERIA

public static final PropertyDescriptor RATE_CONTROL_CRITERIA

MAX_RATE

public static final PropertyDescriptor MAX_RATE

RATE_CONTROL_ATTRIBUTE_NAME

public static final PropertyDescriptor RATE_CONTROL_ATTRIBUTE_NAME

TIME_PERIOD

public static final PropertyDescriptor TIME_PERIOD

GROUPING_ATTRIBUTE_NAME

public static final PropertyDescriptor GROUPING_ATTRIBUTE_NAME

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

POSITIVE_LONG_PATTERN

private static final Pattern POSITIVE_LONG_PATTERN

DEFAULT_GROUP_ATTRIBUTE

private static final String DEFAULT_GROUP_ATTRIBUTE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

throttleMap

private final ConcurrentMap<String,ControlRate.Throttle> throttleMap

lastThrottleClearTime

private final AtomicLong lastThrottleClearTime

rateControlCriteria

private volatile String rateControlCriteria

rateControlAttribute

private volatile String rateControlAttribute

maximumRateStr

private volatile String maximumRateStr

groupingAttributeName

private volatile String groupingAttributeName

timePeriodSeconds

private volatile int timePeriodSeconds

Constructor Detail

ControlRate

public ControlRate()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext context)

Overrides:

customValidate in class AbstractConfigurableComponent

onPropertyModified

public void onPropertyModified(PropertyDescriptor descriptor,
                      String oldValue,
                      String newValue)

Specified by:

onPropertyModified in interface ConfigurableComponent

Overrides:

onPropertyModified in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
             ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

getFlowFileAccrual

private long getFlowFileAccrual(FlowFile flowFile)