com.neeve.aep
Interface IAepEngineStats

All Superinterfaces:

IStats

public interface IAepEngineStats
extends IStats

Defines the AEP engine's statistics interface.

Nested Class Summary

static interface

IAepEngineStats.IMessageTypeStats Exports message type specific statistics

Nested classes/interfaces inherited from interface com.neeve.stats.IStats

IStats.Counter, IStats.Gauge, IStats.Latencies, IStats.Series

Method Summary

void	clearNumCommitsOutstandingAlertThreshold() Clear the outstanding transaction commit alert threshold.
int	getBackupOutboundLogQueueSize() Get the backup outbound log queue size
int	getBackupOutboundQueueSize() Get the backup outbound queue size
List<IAepBusManagerStats>	getBusManagerStats() Get the bus manager stats.
void	getBusManagerStats(List<IAepBusManagerStats> busManagerStats) Allows collection of IAepBusManagerStats without producing garbage.
IStats.Latencies	getCommitEpilogueLatencies() Get the commit epilogue latencies (aka 'cepilo').
IStats.Latencies	getCommitFullLatencies() Get the commit full latencies (aka 'cfull').
IStats.Latencies	getCommitPrologueLatencies() Get the commit prologue latencies (aka 'cprolo').
IStats.Latencies	getCommitSendLatencies() Get the commit send latencies (aka 'csend').
IStats.Latencies	getCommitStartLatencies() Get the commit start latencies (aka 'cstart').
IStats.Latencies	getCommitStoreLatencies() Get the store commit latencies (aka 'cstore').
IStats.Latencies	getCommitTransactionLatencies() Deprecated. use getCommitTransitionLatencies()
IStats.Latencies	getCommitTransitionLatencies() Get the time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').
IEventMultiplexerStats	getEventMultiplexerStats() Get the event multiplexer stats.
IStats.Latencies	getInAckLatencies() Get the in-ack latencies (aka 'inack').
IStorePersisterStats	getInboundMessageLoggerStats() Get the inbound message logger stats.
IStats.Latencies	getInOutLatencies() Get the in-out latencies (aka 'inout').
cern.colt.map.OpenIntObjectHashMap	getMessageTypeStatsTable() Get the message type specific stats table Note: The table needs to be locked when traversing or looking up entries.
IStats.Latencies	getMsgFilteringLatencies() Get the message filtering latencies (aka 'mfilt').
IStats.Latencies	getMsgPreProcessingLatencies() Get the message pre-processing latencies (aka 'mpproc').
IStats.Latencies	getMsgProcessingLatencies() Get the message processing latencies (aka 'mproc').
IStats.Latencies	getMsgSendCoreLatencies() Get the message send core latencies (aka 'msendc').
IStats.Latencies	getMsgSendLatencies() Get the message send latencies (aka 'msend').
long	getNumCommitsCompleted() Get the number of application transaction commits completed
long	getNumCommitsStarted() Get the number of application transaction commits started
long	getNumDupMsgsRcvd() Get the number of duplicate messages received.
long	getNumEventsProcessed() Gets the number of events that have been processed.
long	getNumEventsRcvd() Get the total number of events (messages + others) received.
long	getNumFlowEventsProcComplete() Get the number of flow events (events tagged to a flow) whose processing has completed (acked)
long	getNumFlowEventsProcFail() Get the number of flow events (events tagged to a flow) failed processing
long	getNumFlowEventsProcSuccess() Get the number of flow events (events tagged to a flow) successfully processed
long	getNumFlowEventsRcvd() Get the number of flow events (events tagged to a flow) received.
int	getNumFlows() Get the number of flows being processed.
long	getNumMsgsFiltered() Gets he number of message filtered by a message filter.
long	getNumMsgsRcvdBestEffort() Get the number of best-effort messages received.
long	getNumMsgsRcvdGuaranteed() Get the number of guaranteed messages received.
long	getNumMsgsResent() Get the number of messages resent.
long	getNumMsgsSentBestEffort() Get the number of best-effort messages sent.
long	getNumMsgsSentGuaranteed() Get the number of guaranteed messages sent.
long	getNumMsgsSourced() Get the number of messages sourced.
long	getNumPartialRollbacks() Get the number of partial transaction rollbacks.
long	getNumRollbacks() Get the number of transaction rollbacks.
long	getNumSendCommitsCompleted() Get the number of application send commits completed
long	getNumSendCommitsStarted() Get the number of application send commits started
long	getNumStoreCommitsCompleted() Get the number of application store commits completed
long	getNumStoreCommitsStarted() Get the number of application store commits started
long	getNumTransactions() Get the number of application transactions
IStorePersisterStats	getOutboundMessageLoggerStats() Get the outbound message logger stats.
long	getOutboundSequenceNumber() Get the current outbound sequence number
long	getOutboundStableSequenceNumber() Get the current outbound stable sequence number
int	getSendCommitCompletionQueueSize() Get the current send commit completion quue size
IStats.Latencies	getSendCommitLatencies() Deprecated.
IStoreBindingStats	getStoreBindingStats() Get the engine store binding stats.
int	getStoreCommitCompletionQueueSize() Get the current store commit completion quue size
IStats.Latencies	getStoreCommitLatencies() Deprecated.
IStoreBindingStats	getStoreStats() Deprecated.
IStats.Latencies	getTransactionLeg1ProcessingTimes() Get the processing times of the first leg of transaction execution (aka 'tleg1').
IStats.Latencies	getTransactionLeg2ProcessingTimes() Get the processing times of the second leg of transaction execution (aka 'tleg2').
IStats.Latencies	getTransactionLeg3ProcessingTimes() Get the processing times of the third leg of transaction execution (aka 'tleg3').
List<? extends IStats.Counter>	getUserCounterStats() Gets user registered IStats.Counter stats.
List<? extends IStats.Gauge>	getUserGaugeStats() Gets user registered IStats.Gauge stats.
List<IStats.Series>	getUserSeriesStats() Gets user registered series stats.
void	setNumCommitsOutstandingAlertThreshold(long threshold) Set the outstanding transaction commit alert threshold.

Methods inherited from interface com.neeve.stats.IStats

close, get, getLogger, getName, getType, startPeriodicOutput, stopPeriodicOutput

Method Detail

getNumFlows

int getNumFlows()

Get the number of flows being processed.

getNumMsgsRcvdBestEffort

long getNumMsgsRcvdBestEffort()

Get the number of best-effort messages received.

getNumMsgsRcvdGuaranteed

long getNumMsgsRcvdGuaranteed()

Get the number of guaranteed messages received.

getNumMsgsSourced

long getNumMsgsSourced()

Get the number of messages sourced.

Sourced messages apply only to messages not received directly from a message bus. They include:

• messages replicated to the backup
• initialized from the event log at the primary
• initialized from the primary at the backup.
• messages injected by the application.

The total number of messages received by the engine can be computed by adding getNumMsgsRcvdBestEffort() + getNumMsgsRcvdGuaranteed() + getNumMsgsSourced().

Returns:

The number of messages not received 'live' from a message bus.

getNumMsgsFiltered

long getNumMsgsFiltered()

Gets he number of message filtered by a message filter.

At present this stat only applies to live messages as recovered messages should never be filtered.

Returns:

The number of message filtered by a message filter

getNumDupMsgsRcvd

long getNumDupMsgsRcvd()

Get the number of duplicate messages received.

getNumMsgsSentBestEffort

long getNumMsgsSentBestEffort()

Get the number of best-effort messages sent.

getNumMsgsSentGuaranteed

long getNumMsgsSentGuaranteed()

Get the number of guaranteed messages sent.

getNumMsgsResent

long getNumMsgsResent()

Get the number of messages resent.

getNumEventsRcvd

long getNumEventsRcvd()

Get the total number of events (messages + others) received.

getNumEventsProcessed

long getNumEventsProcessed()

Gets the number of events that have been processed.

getNumFlowEventsRcvd

long getNumFlowEventsRcvd()

Get the number of flow events (events tagged to a flow) received.

getNumFlowEventsProcSuccess

long getNumFlowEventsProcSuccess()

Get the number of flow events (events tagged to a flow) successfully processed

getNumFlowEventsProcFail

long getNumFlowEventsProcFail()

Get the number of flow events (events tagged to a flow) failed processing

getNumFlowEventsProcComplete

long getNumFlowEventsProcComplete()

Get the number of flow events (events tagged to a flow) whose processing has completed (acked)

getNumTransactions

long getNumTransactions()

Get the number of application transactions

getNumCommitsStarted

long getNumCommitsStarted()

Get the number of application transaction commits started

getNumCommitsCompleted

long getNumCommitsCompleted()

Get the number of application transaction commits completed

setNumCommitsOutstandingAlertThreshold

void setNumCommitsOutstandingAlertThreshold(long threshold)

Set the outstanding transaction commit alert threshold.

This method sets an alert on the number of outstanding transaction commits. The application will receive an AepStatsAlertEvent with an alert type of AboveThreshold when the number of outstanding transaction commits exceeds the set threshold and periodically thereafter as long as the number of outstanding transaction commits remains above the threshold. The alerts will terminate with an alert type Abated and resume subsequently once the number of outstanding commits crosses the threshold again.

Alert events for this metric are received with a metric name of "numCommitsOutstanding"

clearNumCommitsOutstandingAlertThreshold

void clearNumCommitsOutstandingAlertThreshold()

Clear the outstanding transaction commit alert threshold.

This method clears the application transaction commit alert threshold. No alerts related to the number of outstanding transaction commits are dispatched subsequent to this call.

getNumSendCommitsStarted

long getNumSendCommitsStarted()

Get the number of application send commits started

getNumSendCommitsCompleted

long getNumSendCommitsCompleted()

Get the number of application send commits completed

getSendCommitCompletionQueueSize

int getSendCommitCompletionQueueSize()

Get the current send commit completion quue size

getNumStoreCommitsStarted

long getNumStoreCommitsStarted()

Get the number of application store commits started

getStoreCommitCompletionQueueSize

int getStoreCommitCompletionQueueSize()

Get the current store commit completion quue size

getNumStoreCommitsCompleted

long getNumStoreCommitsCompleted()

Get the number of application store commits completed

getNumRollbacks

long getNumRollbacks()

Get the number of transaction rollbacks.

getNumPartialRollbacks

long getNumPartialRollbacks()

Get the number of partial transaction rollbacks.

This statistic indicates the number of times that transactions were rolled back to a given savepoint.

getBackupOutboundQueueSize

int getBackupOutboundQueueSize()

Get the backup outbound queue size

getBackupOutboundLogQueueSize

int getBackupOutboundLogQueueSize()

Get the backup outbound log queue size

getOutboundSequenceNumber

long getOutboundSequenceNumber()

Get the current outbound sequence number

getOutboundStableSequenceNumber

long getOutboundStableSequenceNumber()

Get the current outbound stable sequence number

getMessageTypeStatsTable

cern.colt.map.OpenIntObjectHashMap getMessageTypeStatsTable()

Get the message type specific stats table Note: The table needs to be locked when traversing or looking up entries.

getMsgPreProcessingLatencies

IStats.Latencies getMsgPreProcessingLatencies()

Get the message pre-processing latencies (aka 'mpproc').

getMsgProcessingLatencies

IStats.Latencies getMsgProcessingLatencies()

Get the message processing latencies (aka 'mproc').

getMsgFilteringLatencies

IStats.Latencies getMsgFilteringLatencies()

Get the message filtering latencies (aka 'mfilt').

getMsgSendLatencies

IStats.Latencies getMsgSendLatencies()

Get the message send latencies (aka 'msend').

getMsgSendCoreLatencies

IStats.Latencies getMsgSendCoreLatencies()

Get the message send core latencies (aka 'msendc').

getCommitStartLatencies

IStats.Latencies getCommitStartLatencies()

Get the commit start latencies (aka 'cstart').

getCommitPrologueLatencies

IStats.Latencies getCommitPrologueLatencies()

Get the commit prologue latencies (aka 'cprolo').

getCommitSendLatencies

IStats.Latencies getCommitSendLatencies()

Get the commit send latencies (aka 'csend').

getSendCommitLatencies

@Deprecated
IStats.Latencies getSendCommitLatencies()

Deprecated.

Same as getCommitSendLatencies()

getCommitStoreLatencies

IStats.Latencies getCommitStoreLatencies()

Get the store commit latencies (aka 'cstore').

getStoreCommitLatencies

@Deprecated
IStats.Latencies getStoreCommitLatencies()

Deprecated.

Same as getCommitStoreLatencies()

getCommitEpilogueLatencies

IStats.Latencies getCommitEpilogueLatencies()

Get the commit epilogue latencies (aka 'cepilo').

getCommitFullLatencies

IStats.Latencies getCommitFullLatencies()

Get the commit full latencies (aka 'cfull').

getInOutLatencies

IStats.Latencies getInOutLatencies()

Get the in-out latencies (aka 'inout').

getInAckLatencies

IStats.Latencies getInAckLatencies()

Get the in-ack latencies (aka 'inack').

getCommitTransitionLatencies

IStats.Latencies getCommitTransitionLatencies()

Get the time spent from the point the store or send commit completes, whichever is first to the start of next stage - send or commit (aka 'ctrans').

getCommitTransactionLatencies

@Deprecated
IStats.Latencies getCommitTransactionLatencies()

Deprecated. use getCommitTransitionLatencies()

This method should have been named getCommitTransitionLatencies.

getTransactionLeg1ProcessingTimes

IStats.Latencies getTransactionLeg1ProcessingTimes()

Get the processing times of the first leg of transaction execution (aka 'tleg1').

getTransactionLeg2ProcessingTimes

IStats.Latencies getTransactionLeg2ProcessingTimes()

Get the processing times of the second leg of transaction execution (aka 'tleg2').

getTransactionLeg3ProcessingTimes

IStats.Latencies getTransactionLeg3ProcessingTimes()

Get the processing times of the third leg of transaction execution (aka 'tleg3').

getBusManagerStats

List<IAepBusManagerStats> getBusManagerStats()

Get the bus manager stats.

This method returns a list of bus manager statistics objects, one for each bus binding managed by the engine.

getBusManagerStats

void getBusManagerStats(List<IAepBusManagerStats> busManagerStats)

Allows collection of IAepBusManagerStats without producing garbage.

Parameters:

busManagerStats - The target list into which bus manager stats are added.

getUserSeriesStats

List<IStats.Series> getUserSeriesStats()

Gets user registered series stats. The user stats are registered by the engine prior to engine start.

This method returns a list of user registered series stats. The returned list may not be modified by the caller, and is safe for access by multiple threads.

getUserCounterStats

List<? extends IStats.Counter> getUserCounterStats()

Gets user registered IStats.Counter stats. The user stats are registered by the engine prior to engine start.d

This method returns a list of user registered IStats.Counter stats. The returned list may not be modified by the caller, and is safe for access by multiple threads.

getUserGaugeStats

List<? extends IStats.Gauge> getUserGaugeStats()

Gets user registered IStats.Gauge stats. The user stats are registered by the engine prior to engine start.

This method returns a list of user registered IStats.Gauge stats. The returned list may not be modified by the caller, and is safe for access by multiple threads.

getStoreStats

@Deprecated
IStoreBindingStats getStoreStats()

Deprecated.

Get the engine store stats.

d THIS METHOD HAS BEEN DEPRECATED. PLEASE USE getStoreBindingStats()

Returns:

Returns the store stats. A value of null if returned for engines without a store.

getStoreBindingStats

IStoreBindingStats getStoreBindingStats()

Get the engine store binding stats.

Returns:

Returns the store stats. A value of null if returned for engines without a store.

getInboundMessageLoggerStats

IStorePersisterStats getInboundMessageLoggerStats()

Get the inbound message logger stats.

Returns:

The inbound message logger stats (or null if not configured or supported).

getOutboundMessageLoggerStats

IStorePersisterStats getOutboundMessageLoggerStats()

Get the outbound message logger stats.

Returns:

The outbound message logger stats (or null if not configured or supported).

getEventMultiplexerStats

IEventMultiplexerStats getEventMultiplexerStats()

Get the event multiplexer stats.