org.apache.nifi.controller.status.history

Interface ComponentStatusRepository

public interface ComponentStatusRepository

A repository for storing and retrieving components' historical status information

Method Summary

Modifier and Type	Method and Description
void	capture(ProcessGroupStatus rootGroupStatus) Captures the status information provided in the given report
void	capture(ProcessGroupStatus rootGroupStatus, Date timestamp) Captures the status information provided in the given report, providing a timestamp that indicates the time at which the status report was generated.
List<MetricDescriptor<ConnectionStatus>>	getConnectionMetricDescriptors()
StatusHistory	getConnectionStatusHistory(String connectionId, Date start, Date end, int preferredDataPoints)
Date	getLastCaptureDate()
List<MetricDescriptor<ProcessGroupStatus>>	getProcessGroupMetricDescriptors()
StatusHistory	getProcessGroupStatusHistory(String processGroupId, Date start, Date end, int preferredDataPoints)
List<MetricDescriptor<ProcessorStatus>>	getProcessorMetricDescriptors()
StatusHistory	getProcessorStatusHistory(String processorId, Date start, Date end, int preferredDataPoints)
List<MetricDescriptor<RemoteProcessGroupStatus>>	getRemoteProcessGroupMetricDescriptors()
StatusHistory	getRemoteProcessGroupStatusHistory(String remoteGroupId, Date start, Date end, int preferredDataPoints)

Method Detail

capture

void capture(ProcessGroupStatus rootGroupStatus)

Captures the status information provided in the given report

Parameters:

rootGroupStatus - status of root group

capture

void capture(ProcessGroupStatus rootGroupStatus,
             Date timestamp)

Captures the status information provided in the given report, providing a timestamp that indicates the time at which the status report was generated. This can be used to replay historical values.

Parameters:

rootGroupStatus - status

timestamp - timestamp of capture

getLastCaptureDate

Date getLastCaptureDate()

Returns:

the Date at which the latest capture was performed

getConnectionStatusHistory

StatusHistory getConnectionStatusHistory(String connectionId,
                                         Date start,
                                         Date end,
                                         int preferredDataPoints)

Parameters:

connectionId - the ID of the Connection for which the Status is desired

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Connection with the given ID during the given time period

getProcessGroupStatusHistory

StatusHistory getProcessGroupStatusHistory(String processGroupId,
                                           Date start,
                                           Date end,
                                           int preferredDataPoints)

Parameters:

processGroupId - of group to get status of

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Process Group with the given ID during the given time period

getProcessorStatusHistory

StatusHistory getProcessorStatusHistory(String processorId,
                                        Date start,
                                        Date end,
                                        int preferredDataPoints)

Parameters:

processorId - to get status of

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Processor with the given ID during the given time period

getRemoteProcessGroupStatusHistory

StatusHistory getRemoteProcessGroupStatusHistory(String remoteGroupId,
                                                 Date start,
                                                 Date end,
                                                 int preferredDataPoints)

Parameters:

remoteGroupId - to get history of

start - the earliest date for which status information should be returned; if null, the start date should be assumed to be the beginning of time

end - the latest date for which status information should be returned; if null, the end date should be assumed to be the current time

preferredDataPoints - the preferred number of data points to return. If the date range is large, the total number of data points could be far too many to process. Therefore, this parameter allows the requestor to indicate how many samples to return.

Returns:

a StatusHistory that provides the status information about the Remote Process Group with the given ID during the given time period

getProcessGroupMetricDescriptors

List<MetricDescriptor<ProcessGroupStatus>> getProcessGroupMetricDescriptors()

Returns:

a List of all MetricDescriptors that are applicable to Process Groups

getProcessorMetricDescriptors

List<MetricDescriptor<ProcessorStatus>> getProcessorMetricDescriptors()

Returns:

a List of all MetricDescriptors that are applicable to Processors

getRemoteProcessGroupMetricDescriptors

List<MetricDescriptor<RemoteProcessGroupStatus>> getRemoteProcessGroupMetricDescriptors()

Returns:

a List of all MetricDescriptors that are applicable to Remote Process Groups

getConnectionMetricDescriptors

List<MetricDescriptor<ConnectionStatus>> getConnectionMetricDescriptors()

Returns:

a List of all MetricDescriptors that are applicable to Connections