org.apache.nifi.controller

Class MonitorMemory

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.controller.MonitorMemory

All Implemented Interfaces:

ConfigurableComponent, ReportingTask

@Tags(value={"monitor","memory","heap","jvm","gc","garbage collection","warning"})
@CapabilityDescription(value="Checks the amount of Java Heap available in the JVM for a particular JVM Memory Pool. If the amount of space used exceeds some configurable threshold, will warn (via a log message and System-Level Bulletin) that the memory pool is exceeding this threshold.")
public class MonitorMemory
extends AbstractReportingTask

Reporting task used to monitor usage of memory after Garbage Collection has been performed. Each time this ReportingTask runs, it checks the amount of memory that was used in the configured Memory Pool after the last garbage collection took place. If the amount of memory used exceeds a configurable threshold, a System-Level Bulletin is generated and a message is logged. If the memory usage did not exceed the configured threshold but the previous iteration did, an INFO level message is logged and an associated bulletin published. The following properties are supported:

• Memory Pool - The name of the JVM Memory Pool. The allowed values depend on the JVM and operating system.

  
  The following values are typically supported:

  • PS Old Gen
  • PS Survivor Space
  • PS Eden Space
  • PS Perm Gen
• Usage Threshold - The threshold for memory usage that will cause a notification to occur. The format can either be a percentage (e.g., 80%) or a Data Size (e.g., 1 GB)
• Reporting Interval - How often a notification should occur in the event that the memory usage exceeds the threshold. This differs from the scheduling period such that having a short value for the scheduling period and a long value for the reportingInterval property will result in checking the memory usage often so that notifications happen quickly but prevents notifications from continually being generated. The format of this property is The Period format (e.g., 5 mins).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	MonitorMemory.ThresholdValidator

Field Summary

Fields

Modifier and Type	Field and Description
static Pattern	DATA_SIZE_PATTERN
private List<GarbageCollectorMXBean>	garbageCollectorBeans
private long	lastReportTime
private boolean	lastValueWasExceeded
private static org.slf4j.Logger	logger
static PropertyDescriptor	MEMORY_POOL_PROPERTY
private MemoryPoolMXBean	monitoredBean
static Pattern	PERCENTAGE_PATTERN
static PropertyDescriptor	REPORTING_INTERVAL
private long	reportingIntervalMillis
private long	schedulingPeriodMillis
private String	threshold
static PropertyDescriptor	THRESHOLD_PROPERTY
static Pattern	TIME_PERIOD_PATTERN

Constructor Summary

Constructors

Constructor and Description
MonitorMemory()

Method Summary

Methods

Modifier and Type	Method and Description
private long	calculateThresholdBytes(long maxBytes)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ReportingInitializationContext config)
void	onConfigured(ConfigurationContext config)
void	onTrigger(ReportingContext context)

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

getControllerServiceLookup, getIdentifier, getName, getSchedulingPeriod, 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

MEMORY_POOL_PROPERTY

public static final PropertyDescriptor MEMORY_POOL_PROPERTY

THRESHOLD_PROPERTY

public static final PropertyDescriptor THRESHOLD_PROPERTY

REPORTING_INTERVAL

public static final PropertyDescriptor REPORTING_INTERVAL

PERCENTAGE_PATTERN

public static final Pattern PERCENTAGE_PATTERN

DATA_SIZE_PATTERN

public static final Pattern DATA_SIZE_PATTERN

TIME_PERIOD_PATTERN

public static final Pattern TIME_PERIOD_PATTERN

logger

private static final org.slf4j.Logger logger

monitoredBean

private volatile MemoryPoolMXBean monitoredBean

threshold

private volatile String threshold

lastReportTime

private volatile long lastReportTime

reportingIntervalMillis

private volatile long reportingIntervalMillis

lastValueWasExceeded

private volatile boolean lastValueWasExceeded

garbageCollectorBeans

private final List<GarbageCollectorMXBean> garbageCollectorBeans

schedulingPeriodMillis

private long schedulingPeriodMillis

Constructor Detail

MonitorMemory

public MonitorMemory()

Method Detail

init

protected void init(ReportingInitializationContext config)
             throws InitializationException

Overrides:

init in class AbstractReportingTask

Throws:

InitializationException

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onConfigured

@OnScheduled
public void onConfigured(ConfigurationContext config)
                  throws InitializationException

Throws:

InitializationException

calculateThresholdBytes

private long calculateThresholdBytes(long maxBytes)

onTrigger

public void onTrigger(ReportingContext context)