com.couchbase.transactions.log

Class TransactionCleanupEndRunEvent

java.lang.Object

com.couchbase.client.core.cnc.AbstractEvent

com.couchbase.transactions.log.TransactionEvent

com.couchbase.transactions.log.TransactionCleanupEndRunEvent

All Implemented Interfaces:

com.couchbase.client.core.cnc.Event

@Stability.Volatile
public class TransactionCleanupEndRunEvent
extends TransactionEvent

Emitted periodically with a summary of cleanup data since the last event.

As this exposes implementation details of transactions, all methods are subject to change and marked with @Stability.Volatile.

Nested Class Summary

Nested classes/interfaces inherited from interface com.couchbase.client.core.cnc.Event

com.couchbase.client.core.cnc.Event.Category, com.couchbase.client.core.cnc.Event.Severity

Field Summary

Fields inherited from interface com.couchbase.client.core.cnc.Event

CATEGORY_PREFIX

Constructor Summary

Constructors

Constructor and Description
TransactionCleanupEndRunEvent(TransactionCleanupStartRunEvent start, java.util.Map<java.lang.String,ATRStats> atrStats, java.time.Duration timeOfLastRun)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,ATRStats>	atrStats()
java.lang.String	description()
int	largestNumEntries()
int	numAtrsChecked() How many ATRs were checked by this client on this bucket, over the last run.
long	numAtrsErrored() How many ATRs errored during fetch and processing this client on this bucket, over the last run.
long	numAtrsMissing() How many missing ATRs were found by this client on this bucket, over the last run.
long	numAtrsPresent() How many ATRs were found by this client on this bucket, over the last run.
int	numEntries() How many transaction entries were found by this client on this bucket, over the last run.
int	numEntriesExpired()
java.util.Optional<ATREntry>	oldest()
TransactionCleanupStartRunEvent	start() Returns details of the start of this cleanup run.
boolean	success() Provided so the app check if this event is regarded as a success, and if not, output any logs it has.
java.time.Duration	timeOfLastRun() How long it took to do the last 'run', e.g.

Methods inherited from class com.couchbase.transactions.log.TransactionEvent

logs

Methods inherited from class com.couchbase.client.core.cnc.AbstractEvent

category, context, createdAt, duration, severity, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.couchbase.client.core.cnc.Event

cause

Constructor Detail

TransactionCleanupEndRunEvent

@Stability.Volatile
public TransactionCleanupEndRunEvent(TransactionCleanupStartRunEvent start,
                                                         java.util.Map<java.lang.String,ATRStats> atrStats,
                                                         java.time.Duration timeOfLastRun)

Method Detail

start

@Stability.Volatile
public TransactionCleanupStartRunEvent start()

Returns details of the start of this cleanup run.

timeOfLastRun

@Stability.Volatile
public java.time.Duration timeOfLastRun()

How long it took to do the last 'run', e.g. since the last event. This should be very close to the cleanupWindow - if it significantly differs, it indicates the client is struggling to keep up with the workload.

numAtrsChecked

public int numAtrsChecked()

How many ATRs were checked by this client on this bucket, over the last run.

numEntries

public int numEntries()

How many transaction entries were found by this client on this bucket, over the last run.

numAtrsPresent

public long numAtrsPresent()

How many ATRs were found by this client on this bucket, over the last run.

numAtrsMissing

public long numAtrsMissing()

How many missing ATRs were found by this client on this bucket, over the last run.

numAtrsErrored

public long numAtrsErrored()

How many ATRs errored during fetch and processing this client on this bucket, over the last run. A missing ATR is not counted as an error.

atrStats

public java.util.Map<java.lang.String,ATRStats> atrStats()

oldest

public java.util.Optional<ATREntry> oldest()

numEntriesExpired

public int numEntriesExpired()

largestNumEntries

public int largestNumEntries()

description

public java.lang.String description()

success

public boolean success()

Description copied from class: TransactionEvent

Provided so the app check if this event is regarded as a success, and if not, output any logs it has.

Specified by:

success in class TransactionEvent