org.apache.nifi.reporting.ganglia

Class StandardGangliaReporter

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.reporting.ganglia.StandardGangliaReporter

All Implemented Interfaces:

ConfigurableComponent, ReportingTask

@Tags(value={"ganglia","stats"})
 @CapabilityDescription(value="Reports metrics to Ganglia so that Ganglia can be used for external monitoring of the application. Metrics reported include JVM Metrics (optional); the following 5-minute NiFi statistics: FlowFiles Received, Bytes Received, FlowFiles Sent, Bytes Sent, Bytes Read, Bytes Written, Total Task Duration; and the current values for FlowFiles Queued, Bytes Queued, and number of Active Threads.")
public class StandardGangliaReporter
extends AbstractReportingTask

Configuration of this reporting task requires a "host" property that points to the Ganglia server and optionally allows a "port" property (default otherwise is 8649)

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	HOSTNAME
static java.lang.String	METRICS_GROUP
static PropertyDescriptor	PORT
static PropertyDescriptor	SEND_JVM_METRICS

Constructor Summary

Constructors

Constructor and Description
StandardGangliaReporter()

Method Summary

Modifier and Type	Method and Description
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
void	onConfigure(ConfigurationContext config)
void	onTrigger(ReportingContext context) This method is called on a scheduled interval to allow the Reporting Task to perform its tasks.

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

getControllerServiceLookup, getIdentifier, getLogger, 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

HOSTNAME

public static final PropertyDescriptor HOSTNAME

PORT

public static final PropertyDescriptor PORT

SEND_JVM_METRICS

public static final PropertyDescriptor SEND_JVM_METRICS

METRICS_GROUP

public static final java.lang.String METRICS_GROUP

See Also:

Constant Field Values

Constructor Detail

StandardGangliaReporter

public StandardGangliaReporter()

Method Detail

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

onConfigure

@OnScheduled
public void onConfigure(ConfigurationContext config)
                              throws InitializationException

Throws:

InitializationException

onTrigger

public void onTrigger(ReportingContext context)

Description copied from interface: ReportingTask

This method is called on a scheduled interval to allow the Reporting Task to perform its tasks.

Parameters:

context - reporting context