DebugFlow Processor
描述
DebugFlow 处理器通过允许各种响应来帮助测试和调试 FlowFile 框架。
标签
属性
| 名称 | 默认值 | 可选值 | 描述 |
|---|---|---|---|
| FlowFile Success Iterations | 1 | 要转发到成功关系的FlowFile数。 | |
| FlowFile Failure Iterations | 0 | 转发到故障关系的FlowFile数。 | |
| FlowFile Rollback Iterations | 0 | 要回滚的FlowFile数量（无惩罚）。 | |
| FlowFile Rollback Yield Iterations | 0 | 要回滚和让出的FlowFile数。 | |
| FlowFile Rollback Penalty Iterations | 0 | 要回滚并受到惩罚的 FlowFile 数量。 | |
| FlowFile Exception Iterations | 0 | 要抛出异常的FlowFile数。 | |
| FlowFile Exception Class | java.lang.RuntimeException | 要抛出的异常类（必须扩展 java.lang.RuntimeException）。 | |
| No FlowFile Skip Iterations | 1 | 如果没有 FlowFile，则跳过 onTrigger 的次数。 | |
| No FlowFile Exception Iterations | 0 | 无FlowFile时抛出NPE异常的次数。 | |
| No FlowFile Yield Iterations | 0 | 如果没有 FlowFile，则屈服的次数。 | |
| No FlowFile Exception Class | java.lang.RuntimeException | 如果没有 FlowFile，则抛出异常类（必须扩展 java.lang.RuntimeException）。 | |
| Write Iterations | 0 | 写入FlowFile的次数 | |
| Content Size | 1 KB | 每次写入FlowFile时要写入的字节数 | |
| @OnScheduled Pause Time | 0 sec | 在@OnScheduled方法中指定处理器应该休眠多长时间，这样可以强制处理器需要很长时间才能启动 | |
| Fail When @OnScheduled Called | false |
| 指定当调用@OnScheduled注释的方法时，处理器是否应该抛出异常 |
| @OnUnscheduled Pause Time | 0 sec | 在@OnUnscheduled方法中指定处理器应该休眠多长时间，这样当用户点击停止时处理器可以被强制花很长时间来响应 | |
| Fail When @OnUnscheduled Called | false |
| 指定当调用@OnUnscheduled注释的方法时处理器是否应该抛出异常 |
| @OnStopped Pause Time | 0 sec | @OnStopped方法中指定处理器应该休眠多长时间，这样可以强制处理器需要很长时间才能关闭 支持表达式语言：是（仅使用环境/系统变量求值） | |
| Fail When @OnStopped Called | false |
| 指定当调用 @OnStopped 注释的方法时，处理器是否应该抛出异常 |
| OnTrigger Pause Time | 0 sec | 指定处理器应在 onTrigger() 方法中休眠多长时间，以便可以强制处理器花费很长时间来执行其任务 | |
| CustomValidate Pause Time | 0 sec | 指定处理器应在 customValidate() 方法中休眠多长时间 | |
| Ignore Interrupts When Paused | false |
| 如果处理器的线程正在休眠（由于上述某个 "暂停时间" 属性），并且线程被中断，此属性指示处理器是应忽略中断并继续休眠，还是允许自身被中断。 |
| Generate State Entries | 0 | 如果设置为正整数，处理器将确保每次触发时存在恰好这么多状态条目，并使用随机数据更新它们的值。这对于测试组件状态限制非常有用。设置为 0 可禁用状态生成。 | |
| State Scope | LOCAL |
| 存储组件状态条目时使用的范围 |
关系 (Relationships)
| 名称 | 描述 | 自动终止 |
|---|---|---|
failure | 处理失败的FlowFile。 | 否 |
success | FlowFiles 处理成功。 | 否 |
状态管理
| 作用域 | 描述 |
|---|---|
| LOCAL、CLUSTER | 当'生成状态条目'设置为正整数时，处理器将生成相应数量的具有随机值的状态条目。这对于测试组件状态存储和显示限制很有用。状态条目使用类似 'debug_state_key_00000' 的键存储，值随机生成。 |
受限 (Restricted)
该组件不受限。
详细说明
DebugFlow
被触发时，此 Processor 会循环遍历对应的响应列表。只要 Processor 处于运行状态，每次遍历响应列表都会 按配置的次数产生响应。
由 FlowFile 触发时，该 Processor 可以产生以下响应：
- 将 FlowFile 转移到 success Relationship。
- 将 FlowFile 转移到 failure Relationship。
- 回滚（rollback）FlowFile，不施加惩罚（penalty）。
- 回滚 FlowFile 并让出（yield）上下文。
- 回滚 FlowFile 并施加惩罚。
- 抛出异常。
在没有 FlowFile 的情况下被触发时，该 Processor 可以产生以下响应：
- 不做任何处理直接返回。
- 抛出异常。
- 让出（yield）上下文。