com.feedzai.commons.sql.abstraction.listeners

Interface MetricsListener

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

NoopMetricsListener

public interface MetricsListener
extends AutoCloseable

Listener interface to report actions for metrics.

Author:

José Fidalgo (jose.fidalgo@feedzai.com)

Implementation Requirements:

The method calls on the listener should not block nor throw any exceptions.

Method Summary

Modifier and Type	Method and Description
default void	close()
void	onEntryAdded() Called when an entry is added to the batch.
void	onFlushFinished(long elapsed, int successfulEntriesCount, int failedEntriesCount) Called when a batch flush is finished.
void	onFlushStarted(long elapsed, int flushEntriesCount) Called when a batch flush is not empty and starts the process to persist entries in the database, eventually after waiting for other flush operations to finish.
void	onFlushTriggered() Called when a batch flush is triggered.

Method Detail

onEntryAdded

void onEntryAdded()

Called when an entry is added to the batch.

onFlushTriggered

void onFlushTriggered()

Called when a batch flush is triggered.

The batch may be empty, in which case it will skip the persistence to database.

onFlushStarted

void onFlushStarted(long elapsed,
                    int flushEntriesCount)

Called when a batch flush is not empty and starts the process to persist entries in the database, eventually after waiting for other flush operations to finish.

Parameters:

elapsed - The time elapsed (in milliseconds) since the batch flush was triggered.

flushEntriesCount - The number of entries to be flushed.

onFlushFinished

void onFlushFinished(long elapsed,
                     int successfulEntriesCount,
                     int failedEntriesCount)

Called when a batch flush is finished.

This should be called for all cases:

• flush finished immediately because it was empty
• flush was rejected due to executor capacity constraints
• flush finished after all entries were sent to the database (either all or some succeeded, or all failed)

Parameters:

elapsed - The time elapsed (in milliseconds) since the batch flush was triggered.

successfulEntriesCount - The number of entries flushed successfully.

failedEntriesCount - The number of entries that failed to be flushed.

close

default void close()
            throws Exception

Specified by:

close in interface AutoCloseable

Throws:

Exception