org.apache.nifi.processors.standard

Class MonitorActivity

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.MonitorActivity

All Implemented Interfaces:

ConfigurableComponent, Processor

@SideEffectFree
 @TriggerSerially
 @TriggerWhenEmpty
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"monitor","flow","active","inactive","activity","detection"})
 @CapabilityDescription(value="Monitors the flow for activity and sends out an indicator when the flow has not had any data for some specified amount of time and again when the flow\'s activity is restored")
 @WritesAttribute(attribute="inactivityStartMillis",description="The time at which Inactivity began, in the form of milliseconds since Epoch") @WritesAttribute(attribute="inactivityDurationMillis",description="The number of milliseconds that the inactivity has spanned")
 @Stateful(scopes=CLUSTER,
          description="MonitorActivity stores the last timestamp at each node as state, so that it can examine activity at cluster wide.If \'Copy Attribute\' is set to true, then flow file attributes are also persisted.")
public class MonitorActivity
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ACTIVITY_RESTORED_MESSAGE
private AtomicBoolean	connectedWhenLastTriggered
static PropertyDescriptor	CONTINUALLY_SEND_MESSAGES
static PropertyDescriptor	COPY_ATTRIBUTES
private AtomicBoolean	inactive
static PropertyDescriptor	INACTIVITY_MESSAGE
private AtomicLong	lastInactiveMessage
private AtomicLong	latestReportedNodeState
private AtomicLong	latestSuccessTransfer
static PropertyDescriptor	MONITORING_SCOPE
private List<PropertyDescriptor>	properties
static Relationship	REL_ACTIVITY_RESTORED
static Relationship	REL_INACTIVE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static AllowableValue	REPORT_NODE_ALL
static AllowableValue	REPORT_NODE_PRIMARY
static PropertyDescriptor	REPORTING_NODE
static AllowableValue	SCOPE_CLUSTER
static AllowableValue	SCOPE_NODE
static String	STATE_KEY_LATEST_SUCCESS_TRANSFER
static PropertyDescriptor	THRESHOLD
static Charset	UTF8

Constructor Summary

Constructors

Constructor and Description
MonitorActivity()

Method Summary

Modifier and Type	Method and Description
protected long	getLatestSuccessTransfer()
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
private boolean	isClusterScope(ProcessContext context, boolean logInvalidConfig)
private boolean	isReconnectedToCluster(boolean isConnectedToCluster) Will return true when the last known state is "not connected" and the current state is "connected".
void	onScheduled(ProcessContext context)
void	onStopped(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	reconcileState(ProcessContext context)
protected void	resetLastSuccessfulTransfer()
protected void	setLastSuccessfulTransfer(long timestamp)
private boolean	shouldReportOnlyOnPrimary(boolean isClusterScope, ProcessContext context)
private boolean	shouldThisNodeReport(boolean isClusterScope, boolean isReportOnlyOnPrimary, ProcessContext context)

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

onTrigger

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

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

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

SCOPE_NODE

public static final AllowableValue SCOPE_NODE

SCOPE_CLUSTER

public static final AllowableValue SCOPE_CLUSTER

REPORT_NODE_ALL

public static final AllowableValue REPORT_NODE_ALL

REPORT_NODE_PRIMARY

public static final AllowableValue REPORT_NODE_PRIMARY

THRESHOLD

public static final PropertyDescriptor THRESHOLD

CONTINUALLY_SEND_MESSAGES

public static final PropertyDescriptor CONTINUALLY_SEND_MESSAGES

ACTIVITY_RESTORED_MESSAGE

public static final PropertyDescriptor ACTIVITY_RESTORED_MESSAGE

INACTIVITY_MESSAGE

public static final PropertyDescriptor INACTIVITY_MESSAGE

COPY_ATTRIBUTES

public static final PropertyDescriptor COPY_ATTRIBUTES

MONITORING_SCOPE

public static final PropertyDescriptor MONITORING_SCOPE

REPORTING_NODE

public static final PropertyDescriptor REPORTING_NODE

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_INACTIVE

public static final Relationship REL_INACTIVE

REL_ACTIVITY_RESTORED

public static final Relationship REL_ACTIVITY_RESTORED

UTF8

public static final Charset UTF8

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

latestSuccessTransfer

private final AtomicLong latestSuccessTransfer

latestReportedNodeState

private final AtomicLong latestReportedNodeState

inactive

private final AtomicBoolean inactive

connectedWhenLastTriggered

private final AtomicBoolean connectedWhenLastTriggered

lastInactiveMessage

private final AtomicLong lastInactiveMessage

STATE_KEY_LATEST_SUCCESS_TRANSFER

public static final String STATE_KEY_LATEST_SUCCESS_TRANSFER

See Also:

Constant Field Values

Constructor Detail

MonitorActivity

public MonitorActivity()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

resetLastSuccessfulTransfer

protected void resetLastSuccessfulTransfer()

setLastSuccessfulTransfer

protected final void setLastSuccessfulTransfer(long timestamp)

getLatestSuccessTransfer

protected final long getLatestSuccessTransfer()

isClusterScope

private boolean isClusterScope(ProcessContext context,
                               boolean logInvalidConfig)

shouldReportOnlyOnPrimary

private boolean shouldReportOnlyOnPrimary(boolean isClusterScope,
                                          ProcessContext context)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

onStopped

@OnStopped
public void onStopped(ProcessContext context)

isReconnectedToCluster

private boolean isReconnectedToCluster(boolean isConnectedToCluster)

Will return true when the last known state is "not connected" and the current state is "connected". This might happen when during last @OnTrigger the node was not connected but currently it is (reconnection); or when the processor is triggered first time (initial connection). This second case is due to safety reasons: it is possible that during the first trigger the node is not connected to the cluster thus the default value of the #connected attribute is false and stays as false until it's proven otherwise.

Parameters:

isConnectedToCluster - Current state of the connection.

Returns:

The node connected between the last trigger and the current one.

reconcileState

private void reconcileState(ProcessContext context)

shouldThisNodeReport

private boolean shouldThisNodeReport(boolean isClusterScope,
                                     boolean isReportOnlyOnPrimary,
                                     ProcessContext context)