[NIFI-8596] Output readable and configurable reports for 'flowStatus'

• Type: Improvement
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Affects Version/s: 0.1.0
• Component/s: MiNiFi
• Assignee: Unassigned
• Reporter: Andrew Grande
• Created: 27/Oct/16 21:34
• Updated: 13/May/21 15:51

Description

Consider the following command and its output:

./minifi.sh flowStatus processor:all:health
minifi.sh: JAVA_HOME not set; results may vary

Java home:
MiNiFi home: /home/minifi/minifi

Bootstrap Config File: /home/minifi/minifi/conf/bootstrap.conf

FlowStatusReport{controllerServiceStatusList=null, processorStatusList=[{name='Delete internal attributes', processorHealth={runStatus='Running', hasBulletins=false, validationErrorList=[]}, processorStats=null, bulletinList=null}, {name='Tag suspicious entries', processorHealth={runStatus='Running', hasBulletins=false, validationErrorList=[]}, processorStats=null, bulletinList=null}, {name='Normalize Date', processorHealth={runStatus='Running', hasBulletins=false, validationErrorList=[]}, processorStats=null, bulletinList=null}, {name='Tag the origin datacenter', processorHealth={runStatus='Running', hasBulletins=false, validationErrorList=[]}, processorStats=null, bulletinList=null}, {name='ListenSyslog', processorHealth={runStatus='Running', hasBulletins=false, validationErrorList=[]}, processorStats=null, bulletinList=null}], connectionStatusList=null, remoteProcessGroupStatusList=null, instanceStatus=null, systemDiagnosticsStatus=null, reportingTaskStatusList=null, errorsGeneratingReport=[]}

This is merely a result of a FlowStatusReport.toString(). Here's what we'd like to see improved:

1. Configurable format (JSON or YAML). I personally would love a clean JSON output, as then it's easy to query with JQ processor on command line, for example.
2. Clean output parseable by tools. I.e. don't print bootstrap output or provide a way to redirect a stream or save to a file. Again, mostly for CLI automation
3. Update related status reporters to incorporate above changes (shell command handler and PeriodicStatusReporters)