MonitorActivity

MonitorActivity 2.0.0

Bundle: org.apache.nifi | nifi-standard-nar
Description: 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
Tags: active, activity, detection, flow, inactive, monitor
Input Requirement: REQUIRED
Supports Sensitive Dynamic Properties: false

Properties

Activity Restored Message
The message that will be the content of FlowFiles that are sent to 'activity.restored' relationship

Display Name

Activity Restored Message

Description

The message that will be the content of FlowFiles that are sent to 'activity.restored' relationship

API Name

Activity Restored Message

Default Value

Activity restored at time: ${now():format('yyyy/MM/dd HH:mm:ss')} after being inactive for ${inactivityDurationMillis:toNumber():divide(60000)} minutes

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Continually Send Messages
If true, will send inactivity indicator continually every Threshold Duration amount of time until activity is restored; if false, will send an indicator only when the flow first becomes inactive
Display Name

Continually Send Messages

Description

If true, will send inactivity indicator continually every Threshold Duration amount of time until activity is restored; if false, will send an indicator only when the flow first becomes inactive

API Name

Continually Send Messages

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Copy Attributes
If true, will copy all flow file attributes from the flow file that resumed activity to the newly created indicator flow file
Display Name

Copy Attributes

Description

If true, will copy all flow file attributes from the flow file that resumed activity to the newly created indicator flow file

API Name

Copy Attributes

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Inactivity Message
The message that will be the content of FlowFiles that are sent to the 'inactive' relationship

Display Name

Inactivity Message

Description

The message that will be the content of FlowFiles that are sent to the 'inactive' relationship

API Name

Inactivity Message

Default Value

Lacking activity as of time: ${now():format('yyyy/MM/dd HH:mm:ss')}; flow has been inactive for ${inactivityDurationMillis:toNumber():divide(60000)} minutes

Expression Language Scope

Environment variables and FlowFile Attributes

Sensitive

false

Required

true
Monitoring Scope
Specify how to determine activeness of the flow. 'node' means that activeness is examined at individual node separately. It can be useful if DFM expects each node should receive flow files in a distributed manner. With 'cluster', it defines the flow is active while at least one node receives flow files actively. If NiFi is running as standalone mode, this should be set as 'node', if it's 'cluster', NiFi logs a warning message and act as 'node' scope.
Display Name

Monitoring Scope

Description

Specify how to determine activeness of the flow. 'node' means that activeness is examined at individual node separately. It can be useful if DFM expects each node should receive flow files in a distributed manner. With 'cluster', it defines the flow is active while at least one node receives flow files actively. If NiFi is running as standalone mode, this should be set as 'node', if it's 'cluster', NiFi logs a warning message and act as 'node' scope.

API Name

Monitoring Scope

Default Value

node

Allowable Values
- node
- cluster
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Reporting Node
Specify which node should send notification flow-files to inactive and activity.restored relationships. With 'all', every node in this cluster send notification flow-files. 'primary' means flow-files will be sent only from a primary node. If NiFi is running as standalone mode, this should be set as 'all', even if it's 'primary', NiFi act as 'all'.
Display Name

Reporting Node

Description

Specify which node should send notification flow-files to inactive and activity.restored relationships. With 'all', every node in this cluster send notification flow-files. 'primary' means flow-files will be sent only from a primary node. If NiFi is running as standalone mode, this should be set as 'all', even if it's 'primary', NiFi act as 'all'.

API Name

Reporting Node

Default Value

all

Allowable Values
- all
- primary
Expression Language Scope

Not Supported

Sensitive

false

Required

true

Dependencies
- Monitoring Scope is set to any of [cluster]
Reset State on Restart
When the processor gets started or restarted, if set to true, the initial state will always be active. Otherwise, the last reported flow state will be preserved.
Display Name

Reset State on Restart

Description

When the processor gets started or restarted, if set to true, the initial state will always be active. Otherwise, the last reported flow state will be preserved.

API Name

Reset State on Restart

Default Value

true

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true
Threshold Duration
Determines how much time must elapse before considering the flow to be inactive

Display Name

Threshold Duration

Description

Determines how much time must elapse before considering the flow to be inactive

API Name

Threshold Duration

Default Value

5 min

Expression Language Scope

Environment variables defined at JVM level and system properties

Sensitive

false

Required

true
Wait for Activity
When the processor gets started or restarted, if set to true, only send an inactive indicator if there had been activity beforehand. Otherwise send an inactive indicator even if there had not been activity beforehand.
Display Name

Wait for Activity

Description

When the processor gets started or restarted, if set to true, only send an inactive indicator if there had been activity beforehand. Otherwise send an inactive indicator even if there had not been activity beforehand.

API Name

Wait for Activity

Default Value

false

Allowable Values
- true
- false
Expression Language Scope

Not Supported

Sensitive

false

Required

true

State Management

Scopes	Description
LOCAL, CLUSTER	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. In local scope, it stores last known activity timestamp if the flow is inactive.

Relationships

Name	Description
inactive	This relationship is used to transfer an Inactivity indicator when no FlowFiles are routed to 'success' for Threshold Duration amount of time
success	All incoming FlowFiles are routed to success
activity.restored	This relationship is used to transfer an Activity Restored indicator when FlowFiles are routing to 'success' following a period of inactivity

Writes Attributes

Name	Description
inactivityStartMillis	The time at which Inactivity began, in the form of milliseconds since Epoch
inactivityDurationMillis	The number of milliseconds that the inactivity has spanned