ControllerStatusReportingTask 2.0.0

Bundle
org.apache.nifi | nifi-standard-nar
Description
Logs the 5-minute stats that are shown in the NiFi Summary Page for Processors and Connections, as well optionally logging the deltas between the previous iteration and the current iteration. Processors' stats are logged using the org.apache.nifi.controller.ControllerStatusReportingTask.Processors logger, while Connections' stats are logged using the org.apache.nifi.controller.ControllerStatusReportingTask.Connections logger. These can be configured in the NiFi logging configuration to log to different files, if desired.
Tags
log, stats
Input Requirement
Supports Sensitive Dynamic Properties
false
  • Additional Details for ControllerStatusReportingTask 2.0.0

    ControllerStatusReportingTask

    Description:

    Reporting Task that creates a log message for each Processor and each Connection in the flow. For Processors, the following information is included (sorted by descending Processing Timing):

    • Processor Name
    • Processor ID
    • Processor Type
    • Run Status
    • Flow Files In (5 mins)
    • FlowFiles Out (5 mins)
    • Bytes Read from Disk (5 mins)
    • Bytes Written to Disk (5 mins)
    • Number of Tasks Completed (5 mins)
    • Processing Time (5 mins)

    For Connections, the following information is included (sorted by descending size of queued FlowFiles):

    • Connection Name
    • Connection ID
    • Source Component Name
    • Destination Component Name
    • Flow Files In (5 mins)
    • FlowFiles Out (5 mins)
    • FlowFiles Queued

    It may be convenient to redirect the logging output of this ReportingTask to a separate log file than the typical application log. This can be accomplished by modified the logback.xml file in the NiFi conf/ directory such that a logger with the name org.apache.nifi.controller.ControllerStatusReportingTask is configured to write to a separate log.

    Additionally, it may be convenient to disable logging for Processors or for Connections or to split them into separate log files. This can be accomplished by using the loggers named org.apache.nifi.controller.ControllerStatusReportingTask.Processors and org.apache.nifi.controller.ControllerStatusReportingTask.Connections, respectively.

Properties