DebugFlow

Description:

The DebugFlow processor aids testing and debugging the FlowFile framework by allowing various responses to be explicitly triggered in response to the receipt of a FlowFile or a timer event without a FlowFile if using timer or cron based scheduling. It can force responses needed to exercise or test various failure modes that can occur when a processor runs.

Additional Details...

Tags:

test, debug, processor, utility, flow, FlowFile

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, and whether a property supports the NiFi Expression Language.

Display NameAPI NameDefault ValueAllowable ValuesDescription
FlowFile Success IterationsFlowFile Success Iterations1Number of FlowFiles to forward to success relationship.
FlowFile Failure IterationsFlowFile Failure Iterations0Number of FlowFiles to forward to failure relationship.
FlowFile Rollback IterationsFlowFile Rollback Iterations0Number of FlowFiles to roll back (without penalty).
FlowFile Rollback Yield IterationsFlowFile Rollback Yield Iterations0Number of FlowFiles to roll back and yield.
FlowFile Rollback Penalty IterationsFlowFile Rollback Penalty Iterations0Number of FlowFiles to roll back with penalty.
FlowFile Exception IterationsFlowFile Exception Iterations0Number of FlowFiles to throw exception.
FlowFile Exception ClassFlowFile Exception Classjava.lang.RuntimeExceptionException class to be thrown (must extend java.lang.RuntimeException).
No FlowFile Skip IterationsNo FlowFile Skip Iterations1Number of times to skip onTrigger if no FlowFile.
No FlowFile Exception IterationsNo FlowFile Exception Iterations0Number of times to throw NPE exception if no FlowFile.
No FlowFile Yield IterationsNo FlowFile Yield Iterations0Number of times to yield if no FlowFile.
No FlowFile Exception ClassNo FlowFile Exception Classjava.lang.RuntimeExceptionException class to be thrown if no FlowFile (must extend java.lang.RuntimeException).
Write IterationsWrite Iterations0Number of times to write to the FlowFile
Content SizeContent Size1 KBThe number of bytes to write each time that the FlowFile is written to
@OnScheduled Pause Time@OnScheduled Pause Time0 secSpecifies how long the processor should sleep in the @OnScheduled method, so that the processor can be forced to take a long time to start up
Fail When @OnScheduled calledFail When @OnScheduled calledfalse
  • true
  • false
Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnScheduled are called
@OnUnscheduled Pause Time@OnUnscheduled Pause Time0 secSpecifies how long the processor should sleep in the @OnUnscheduled method, so that the processor can be forced to take a long time to respond when user clicks stop
Fail When @OnUnscheduled calledFail When @OnUnscheduled calledfalse
  • true
  • false
Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnUnscheduled are called
@OnStopped Pause Time@OnStopped Pause Time0 secSpecifies how long the processor should sleep in the @OnStopped method, so that the processor can be forced to take a long time to shutdown
Supports Expression Language: true (will be evaluated using variable registry only)
Fail When @OnStopped calledFail When @OnStopped calledfalse
  • true
  • false
Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnStopped are called
OnTrigger Pause TimeOnTrigger Pause Time0 secSpecifies how long the processor should sleep in the onTrigger() method, so that the processor can be forced to take a long time to perform its task
CustomValidate Pause TimeCustomValidate Pause Time0 secSpecifies how long the processor should sleep in the customValidate() method
Ignore Interrupts When PausedIgnore Interrupts When Pausedfalse
  • true
  • false
If the Processor's thread(s) are sleeping (due to one of the "Pause Time" properties above), and the thread is interrupted, this indicates whether the Processor should ignore the interrupt and continue sleeping or if it should allow itself to be interrupted.

Relationships:

NameDescription
successFlowFiles processed successfully.
failureFlowFiles that failed to process.

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

System Resource Considerations:

None specified.