org.apache.nifi.controller

Class ControllerStatusReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.controller.ControllerStatusReportingTask

All Implemented Interfaces:

ConfigurableComponent, ReportingTask

@Tags(value={"stats","log"})
@CapabilityDescription(value="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.")
public class ControllerStatusReportingTask
extends AbstractReportingTask

Field Summary

Fields

Modifier and Type	Field and Description
private static String	CONNECTION_LINE_FORMAT_NO_DELTA
private static String	CONNECTION_LINE_FORMAT_WITH_DELTA
private String	connectionBorderLine
private String	connectionHeader
private String	connectionLineFormat
private static org.slf4j.Logger	connectionLogger
private Map<String,ConnectionStatus>	lastConnectionStatus
private Map<String,ProcessorStatus>	lastProcessorStatus
private static String	PROCESSOR_LINE_FORMAT_NO_DELTA
private static String	PROCESSOR_LINE_FORMAT_WITH_DELTA
private String	processorBorderLine
private String	processorHeader
private String	processorLineFormat
private static org.slf4j.Logger	processorLogger
static PropertyDescriptor	SHOW_DELTAS

Constructor Summary

Constructors

Constructor and Description
ControllerStatusReportingTask()

Method Summary

Methods

Modifier and Type	Method and Description
List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onConfigured(ConfigurationContext context)
void	onTrigger(ReportingContext context)
private void	populateConnectionStatuses(ProcessGroupStatus groupStatus, List<ConnectionStatus> statuses)
private void	populateProcessorStatuses(ProcessGroupStatus groupStatus, List<ProcessorStatus> statuses)
private void	printConnectionStatus(ProcessGroupStatus groupStatus, StringBuilder builder, boolean showDeltas) Recursively prints the status of all connections in this group.
private void	printProcessorStatus(ProcessGroupStatus groupStatus, StringBuilder builder, boolean showDeltas) Recursively the status of all processors in this group.
private String	toDiff(long oldValue, long newValue)
private String	toDiff(long oldValue, long newValue, boolean formatDataSize, boolean formatTime)
private String	toDiff(long oldCount, long oldBytes, long newCount, long newBytes)

Methods inherited from class org.apache.nifi.reporting.AbstractReportingTask

getControllerServiceLookup, getIdentifier, getName, getSchedulingPeriod, init, initialize

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

SHOW_DELTAS

public static final PropertyDescriptor SHOW_DELTAS

processorLogger

private static final org.slf4j.Logger processorLogger

connectionLogger

private static final org.slf4j.Logger connectionLogger

PROCESSOR_LINE_FORMAT_NO_DELTA

private static final String PROCESSOR_LINE_FORMAT_NO_DELTA

See Also:

Constant Field Values

PROCESSOR_LINE_FORMAT_WITH_DELTA

private static final String PROCESSOR_LINE_FORMAT_WITH_DELTA

See Also:

Constant Field Values

CONNECTION_LINE_FORMAT_NO_DELTA

private static final String CONNECTION_LINE_FORMAT_NO_DELTA

See Also:

Constant Field Values

CONNECTION_LINE_FORMAT_WITH_DELTA

private static final String CONNECTION_LINE_FORMAT_WITH_DELTA

See Also:

Constant Field Values

processorLineFormat

private volatile String processorLineFormat

processorHeader

private volatile String processorHeader

processorBorderLine

private volatile String processorBorderLine

connectionLineFormat

private volatile String connectionLineFormat

connectionHeader

private volatile String connectionHeader

connectionBorderLine

private volatile String connectionBorderLine

lastProcessorStatus

private volatile Map<String,ProcessorStatus> lastProcessorStatus

lastConnectionStatus

private volatile Map<String,ConnectionStatus> lastConnectionStatus

Constructor Detail

ControllerStatusReportingTask

public ControllerStatusReportingTask()

Method Detail

getSupportedPropertyDescriptors

public final List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onConfigured

@OnScheduled
public void onConfigured(ConfigurationContext context)

onTrigger

public void onTrigger(ReportingContext context)

populateConnectionStatuses

private void populateConnectionStatuses(ProcessGroupStatus groupStatus,
                              List<ConnectionStatus> statuses)

populateProcessorStatuses

private void populateProcessorStatuses(ProcessGroupStatus groupStatus,
                             List<ProcessorStatus> statuses)

printConnectionStatus

private void printConnectionStatus(ProcessGroupStatus groupStatus,
                         StringBuilder builder,
                         boolean showDeltas)

Recursively prints the status of all connections in this group.

Parameters:

groupStatus -

group -

builder -

toDiff

private String toDiff(long oldValue,
            long newValue)

toDiff

private String toDiff(long oldValue,
            long newValue,
            boolean formatDataSize,
            boolean formatTime)

toDiff

private String toDiff(long oldCount,
            long oldBytes,
            long newCount,
            long newBytes)

printProcessorStatus

private void printProcessorStatus(ProcessGroupStatus groupStatus,
                        StringBuilder builder,
                        boolean showDeltas)

Recursively the status of all processors in this group.

Parameters:

groupStatus -

group -

builder -