org.apache.nifi.reporting.sql

Class QueryNiFiReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

org.apache.nifi.reporting.sql.QueryNiFiReportingTask

All Implemented Interfaces:

ConfigurableComponent, ReportingTask, QueryTimeAware

@Tags(value={"status","connection","processor","jvm","metrics","history","bulletin","prediction","process","group","provenance","record","sql"})
 @CapabilityDescription(value="Publishes NiFi status information based on the results of a user-specified SQL query. The query may make use of the CONNECTION_STATUS, PROCESSOR_STATUS, BULLETINS, PROCESS_GROUP_STATUS, JVM_METRICS, CONNECTION_STATUS_PREDICTIONS, or PROVENANCE tables, and can use any functions or capabilities provided by Apache Calcite. Note that the CONNECTION_STATUS_PREDICTIONS table is not available for querying if analytics are not enabled (see the nifi.analytics.predict.enabled property in nifi.properties). Attempting a query on the table when the capability is disabled will cause an error.")
 @Stateful(scopes=LOCAL,
          description="Stores the Reporting Task\'s last execution time so that on restart the task knows where it left off.")
public class QueryNiFiReportingTask
extends AbstractReportingTask
implements QueryTimeAware

Field Summary

Fields

Modifier and Type	Field and Description
private MetricsQueryService	metricsQueryService
private List<PropertyDescriptor>	properties
private RecordSinkService	recordSinkService

Constructor Summary

Constructors

Constructor and Description
QueryNiFiReportingTask()

Method Summary

Modifier and Type	Method and Description
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ReportingInitializationContext config)
void	onTrigger(ReportingContext context)
void	setup(ConfigurationContext context)

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

getControllerServiceLookup, getIdentifier, getLogger, getName, getNodeTypeProvider, getSchedulingPeriod, 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.sql.QueryTimeAware

getCurrentTime, processStartAndEndTimes

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

properties

private List<PropertyDescriptor> properties

recordSinkService

private volatile RecordSinkService recordSinkService

metricsQueryService

private MetricsQueryService metricsQueryService

Constructor Detail

QueryNiFiReportingTask

public QueryNiFiReportingTask()

Method Detail

init

protected void init(ReportingInitializationContext config)

Overrides:

init in class AbstractReportingTask

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

setup

@OnScheduled
public void setup(ConfigurationContext context)

onTrigger

public void onTrigger(ReportingContext context)

Specified by:

onTrigger in interface ReportingTask