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 static String	COUNTER_LINE_FORMAT
private String	counterBorderLine
private String	counterHeader
private static org.slf4j.Logger	counterLogger
(package private) static AllowableValue	FIVE_MINUTE_GRANULARITY
private Map<String,ConnectionStatus>	lastConnectionStatus
private Map<String,Long>	lastCounterValues
private Map<String,ProcessorStatus>	lastProcessorStatus
(package private) static AllowableValue	ONE_SECOND_GRANULARITY
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
(package private) static PropertyDescriptor	REPORTING_GRANULARITY
static PropertyDescriptor	SHOW_DELTAS
private long	startTimestamp

Constructor Summary

Constructors

Constructor and Description
ControllerStatusReportingTask()

Method Summary

Modifier and Type	Method and Description
private String	createLine(String valueToUnderscore)
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, long divisor)
private void	printConnectionStatuses(ProcessGroupStatus controllerStatus, boolean showDeltas, long divisor)
private void	printCounters(ProcessGroupStatus controllerStatus, boolean showDeltas, long divisor)
private void	printCounterStatus(ProcessGroupStatus status, StringBuilder builder, boolean showDeltas, long divisor)
private void	printProcessorStatus(ProcessGroupStatus groupStatus, StringBuilder builder, boolean showDeltas, long divisor)
private void	printProcessorStatuses(ProcessGroupStatus controllerStatus, boolean showDeltas, long divisor)
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, getLogger, getName, getNodeTypeProvider, getSchedulingPeriod, init, initialize, setComponentInfo

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.reporting.ReportingTask

isStateful

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

FIVE_MINUTE_GRANULARITY

static final AllowableValue FIVE_MINUTE_GRANULARITY

ONE_SECOND_GRANULARITY

static final AllowableValue ONE_SECOND_GRANULARITY

SHOW_DELTAS

public static final PropertyDescriptor SHOW_DELTAS

REPORTING_GRANULARITY

static final PropertyDescriptor REPORTING_GRANULARITY

processorLogger

private static final org.slf4j.Logger processorLogger

connectionLogger

private static final org.slf4j.Logger connectionLogger

counterLogger

private static final org.slf4j.Logger counterLogger

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

COUNTER_LINE_FORMAT

private static final String COUNTER_LINE_FORMAT

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

counterHeader

private volatile String counterHeader

counterBorderLine

private volatile String counterBorderLine

lastProcessorStatus

private volatile Map<String,ProcessorStatus> lastProcessorStatus

lastConnectionStatus

private volatile Map<String,ConnectionStatus> lastConnectionStatus

lastCounterValues

private volatile Map<String,Long> lastCounterValues

startTimestamp

private final long startTimestamp

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)

createLine

private String createLine(String valueToUnderscore)

onTrigger

public void onTrigger(ReportingContext context)

printProcessorStatuses

private void printProcessorStatuses(ProcessGroupStatus controllerStatus,
                                    boolean showDeltas,
                                    long divisor)

printConnectionStatuses

private void printConnectionStatuses(ProcessGroupStatus controllerStatus,
                                     boolean showDeltas,
                                     long divisor)

printCounters

private void printCounters(ProcessGroupStatus controllerStatus,
                           boolean showDeltas,
                           long divisor)

printCounterStatus

private void printCounterStatus(ProcessGroupStatus status,
                                StringBuilder builder,
                                boolean showDeltas,
                                long divisor)

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,
                                   long divisor)

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,
                                  long divisor)