org.apache.nifi.controller.status.history

Interface StatusHistoryRepository

public interface StatusHistoryRepository

A repository for storing and retrieving node and components' historical status information

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_DETAIL_DESTINATION_NAME
static String	COMPONENT_DETAIL_GROUP_ID
static String	COMPONENT_DETAIL_ID
static String	COMPONENT_DETAIL_NAME
static String	COMPONENT_DETAIL_SOURCE_NAME
static String	COMPONENT_DETAIL_TYPE
static String	COMPONENT_DETAIL_URI

Method Summary

Modifier and Type	Method and Description
void	capture(NodeStatus nodeStatus, ProcessGroupStatus rootGroupStatus, List<GarbageCollectionStatus> garbageCollectionStatus, 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.
StatusHistory	getConnectionStatusHistory(String connectionId, Date start, Date end, int preferredDataPoints)
GarbageCollectionHistory	getGarbageCollectionHistory(Date start, Date end) Returns the status history of the garbage collection.
StatusHistory	getNodeStatusHistory(Date start, Date end) Returns the status history of the actual node.
StatusHistory	getProcessGroupStatusHistory(String processGroupId, Date start, Date end, int preferredDataPoints)
StatusHistory	getProcessorStatusHistory(String processorId, Date start, Date end, int preferredDataPoints, boolean includeCounters)
StatusHistory	getRemoteProcessGroupStatusHistory(String remoteGroupId, Date start, Date end, int preferredDataPoints)
void	shutdown() Stops the resources used by the repository.
void	start() Starts necessary resources needed for the repository.

Field Detail

COMPONENT_DETAIL_ID

static final String COMPONENT_DETAIL_ID

See Also:

Constant Field Values

COMPONENT_DETAIL_GROUP_ID

static final String COMPONENT_DETAIL_GROUP_ID

See Also:

Constant Field Values

COMPONENT_DETAIL_NAME

static final String COMPONENT_DETAIL_NAME

See Also:

Constant Field Values

COMPONENT_DETAIL_TYPE

static final String COMPONENT_DETAIL_TYPE

See Also:

Constant Field Values

COMPONENT_DETAIL_SOURCE_NAME

static final String COMPONENT_DETAIL_SOURCE_NAME

See Also:

Constant Field Values

COMPONENT_DETAIL_DESTINATION_NAME

static final String COMPONENT_DETAIL_DESTINATION_NAME

See Also:

Constant Field Values

COMPONENT_DETAIL_URI

static final String COMPONENT_DETAIL_URI

See Also:

Constant Field Values

Method Detail

capture

void capture(NodeStatus nodeStatus,
             ProcessGroupStatus rootGroupStatus,
             List<GarbageCollectionStatus> garbageCollectionStatus,
             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:

nodeStatus - status of the node

rootGroupStatus - status of the root group and it's content

timestamp - timestamp of capture

garbageCollectionStatus - status of garbage collection

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,
                                        boolean includeCounters)

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.

includeCounters - specifies whether or not metrics from Processor counters should be included in the StatusHistory.

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

getNodeStatusHistory

StatusHistory getNodeStatusHistory(Date start,
                                   Date end)

Returns the status history of the actual node.

Parameters:

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

Returns:

a StatusHistory that provides the status information about the NiFi node within the specified time range.

getGarbageCollectionHistory

GarbageCollectionHistory getGarbageCollectionHistory(Date start,
                                                     Date end)

Returns the status history of the garbage collection.

Parameters:

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

Returns:

a GarbageCollectionHistory that provides the status information about the garbage collection of the given node within the specified time range

start

void start()

Starts necessary resources needed for the repository.

shutdown

void shutdown()

Stops the resources used by the repository.