com.apple.foundationdb.record.provider.foundationdb

Enum FDBStoreTimer.Waits

java.lang.Object

java.lang.Enum<FDBStoreTimer.Waits>

com.apple.foundationdb.record.provider.foundationdb.FDBStoreTimer.Waits

All Implemented Interfaces:

StoreTimer.Event, StoreTimer.Wait, Serializable, Comparable<FDBStoreTimer.Waits>

Enclosing class:

FDBStoreTimer

public static enum FDBStoreTimer.Waits
extends Enum<FDBStoreTimer.Waits>
implements StoreTimer.Wait

Standard Wait events. In a number of cases, a WAIT_XXX Wait corresponds to an XXX Event. The event measures the time of the operation itself, whereas the wait measures only the time actually waiting for it to complete. Note that not all of these are waited for anywhere in the Record Layer codebase. They are included so that users of the library can make use of them in their own monitoring.

Enum Constant Summary

Enum Constants

Enum Constant and Description
WAIT_ADD_INDEX Wait for adding an index.
WAIT_ADVANCE_CURSOR Wait for a synchronous RecordCursor.next().
WAIT_BUILD_ENDPOINTS Wait for OnlineIndexer to build endpoints.
WAIT_CHECK_SYNC_SESSION Wait for checking a synchronized session.
WAIT_CHECK_VERSION Wait for check version on a record store.
WAIT_COLLECT_STATISTICS Wait for statistics to be collected.
WAIT_COMMIT Wait for a transaction to commit.
WAIT_DELETE_RECORD Wait for deleting a record.
WAIT_DIRECTORY_RESOLVE Wait for resolving directory layer entries.
WAIT_DROP_INDEX Wait for dropping an index.
WAIT_EDIT_HEADER_USER_FIELD Wait for editing a header user field.
WAIT_ENABLE_SPLIT_LONG_RECORDS Wait for enabling splitting long records.
WAIT_END_SYNC_SESSION Wait for ending a synchronized session.
WAIT_ERROR_CHECK A fake wait for a future already known to be completed.
WAIT_EXECUTE_QUERY Wait for query execution to complete.
WAIT_GET_BOUNDARY Wait for getting boundaries.
WAIT_GET_READ_VERSION Wait for explicit call to FDBDatabase.getReadVersion(com.apple.foundationdb.record.provider.foundationdb.FDBRecordContext).
WAIT_INDEX_OPERATION Wait for an IndexOperation to complete.
WAIT_INIT_SYNC_SESSION Wait for initializing a synchronized session.
WAIT_KEYSPACE_CLEAR Wait for clearing a KeySpace.
WAIT_KEYSPACE_LIST Wait for listing a KeySpace.
WAIT_KEYSPACE_PATH_RESOLVE Wait for resolving the path for a KeySpace.
WAIT_KEYSPACE_SCAN Wait for scanning a KeySpace to see whether it has data.
WAIT_LOAD_META_DATA Wait for loading meta-data from a FDBMetaDataStore.
WAIT_LOAD_RECORD Wait for loading a record.
WAIT_LOAD_RECORD_STORE_STATE Wait for loading RecordStoreState.
WAIT_LOAD_RECORD_VERSION Wait for loading a record's version.
WAIT_LOCATABLE_RESOLVER_COMPUTE_DIGEST Wait for a ResolverMappingDigest to be computed.
WAIT_LOCATABLE_RESOLVER_MAPPING_COPY Wait for ResolverMappingReplicator to copy a directory layer.
WAIT_META_DATA_VERSION_STAMP Wait to load the the cluster's meta-data version stamp.
WAIT_MUTATE_METADATA Wait for meta-data mutation.
WAIT_ONLINE_BUILD_INDEX Wait for OnlineIndexer to complete building an index.
WAIT_PERFORM_NO_OP Wait for performing a no-op operation.
WAIT_RECORD_EXISTS Wait to check if a record exists.
WAIT_RETRY_DELAY Wait for a backoff delay on retryable error in FDBDatabase.run(java.util.function.Function<? super com.apple.foundationdb.record.provider.foundationdb.FDBRecordContext, ? extends T>).
WAIT_REVERSE_DIRECTORY_LOCATE Wait for finding reverse directory location.
WAIT_REVERSE_DIRECTORY_LOOKUP Wait for a reverse directory lookup.
WAIT_REVERSE_DIRECTORY_SCAN Wait for a reverse directory scan.
WAIT_SAVE_META_DATA Wait for saving meta-data to a FDBMetaDataStore.
WAIT_SAVE_RECORD Wait for saving a record.
WAIT_SCAN_INDEX_RECORDS Wait for a indexed record scan.
WAIT_SCAN_RECORDS Wait for a record scan without an index.
WAIT_SET_STATE_CACHEABILITY Wait for setting the store state cacheability.
WAIT_STOP_ONLINE_INDEX_BUILD Wait for OnlineIndexer to stop ongoing online index builds.
WAIT_UPDATE_RECORDS_DESCRIPTOR Wait for updating records descriptor.
WAIT_UPDATE_STORE_RECORD_VERSIONS Wait for updating if record versions should be stored.
WAIT_VERSION_STAMP Wait for the updated version stamp from a committed transaction.

Method Summary

Modifier and Type	Method and Description
String	logKey() Get the key of this event for logging.
String	title() Get the title of this event for user displays.
static FDBStoreTimer.Waits	valueOf(String name) Returns the enum constant of this type with the specified name.
static FDBStoreTimer.Waits[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.apple.foundationdb.record.provider.common.StoreTimer.Event

name

Enum Constant Detail

WAIT_ERROR_CHECK

public static final FDBStoreTimer.Waits WAIT_ERROR_CHECK

A fake wait for a future already known to be completed. The purpose of passing this is to get standard error handling for futures that have completed exceptionally.

WAIT_PERFORM_NO_OP

public static final FDBStoreTimer.Waits WAIT_PERFORM_NO_OP

Wait for performing a no-op operation.

WAIT_GET_READ_VERSION

public static final FDBStoreTimer.Waits WAIT_GET_READ_VERSION

Wait for explicit call to FDBDatabase.getReadVersion(com.apple.foundationdb.record.provider.foundationdb.FDBRecordContext).

WAIT_COMMIT

public static final FDBStoreTimer.Waits WAIT_COMMIT

Wait for a transaction to commit.

WAIT_SAVE_META_DATA

public static final FDBStoreTimer.Waits WAIT_SAVE_META_DATA

Wait for saving meta-data to a FDBMetaDataStore.

WAIT_LOAD_META_DATA

public static final FDBStoreTimer.Waits WAIT_LOAD_META_DATA

Wait for loading meta-data from a FDBMetaDataStore.

WAIT_LOAD_RECORD_STORE_STATE

public static final FDBStoreTimer.Waits WAIT_LOAD_RECORD_STORE_STATE

Wait for loading RecordStoreState.

WAIT_LOAD_RECORD

public static final FDBStoreTimer.Waits WAIT_LOAD_RECORD

Wait for loading a record.

WAIT_LOAD_RECORD_VERSION

public static final FDBStoreTimer.Waits WAIT_LOAD_RECORD_VERSION

Wait for loading a record's version.

WAIT_SAVE_RECORD

public static final FDBStoreTimer.Waits WAIT_SAVE_RECORD

Wait for saving a record.

WAIT_RECORD_EXISTS

public static final FDBStoreTimer.Waits WAIT_RECORD_EXISTS

Wait to check if a record exists.

WAIT_DELETE_RECORD

public static final FDBStoreTimer.Waits WAIT_DELETE_RECORD

Wait for deleting a record.

WAIT_DIRECTORY_RESOLVE

public static final FDBStoreTimer.Waits WAIT_DIRECTORY_RESOLVE

Wait for resolving directory layer entries.

WAIT_CHECK_VERSION

public static final FDBStoreTimer.Waits WAIT_CHECK_VERSION

Wait for check version on a record store.

WAIT_ONLINE_BUILD_INDEX

public static final FDBStoreTimer.Waits WAIT_ONLINE_BUILD_INDEX

Wait for OnlineIndexer to complete building an index.

WAIT_STOP_ONLINE_INDEX_BUILD

public static final FDBStoreTimer.Waits WAIT_STOP_ONLINE_INDEX_BUILD

Wait for OnlineIndexer to stop ongoing online index builds.

WAIT_BUILD_ENDPOINTS

public static final FDBStoreTimer.Waits WAIT_BUILD_ENDPOINTS

Wait for OnlineIndexer to build endpoints.

WAIT_SCAN_RECORDS

public static final FDBStoreTimer.Waits WAIT_SCAN_RECORDS

Wait for a record scan without an index.

WAIT_SCAN_INDEX_RECORDS

public static final FDBStoreTimer.Waits WAIT_SCAN_INDEX_RECORDS

Wait for a indexed record scan.

WAIT_EXECUTE_QUERY

public static final FDBStoreTimer.Waits WAIT_EXECUTE_QUERY

Wait for query execution to complete.

WAIT_REVERSE_DIRECTORY_SCAN

public static final FDBStoreTimer.Waits WAIT_REVERSE_DIRECTORY_SCAN

Wait for a reverse directory scan.

WAIT_REVERSE_DIRECTORY_LOOKUP

public static final FDBStoreTimer.Waits WAIT_REVERSE_DIRECTORY_LOOKUP

Wait for a reverse directory lookup.

WAIT_REVERSE_DIRECTORY_LOCATE

public static final FDBStoreTimer.Waits WAIT_REVERSE_DIRECTORY_LOCATE

Wait for finding reverse directory location.

WAIT_INDEX_OPERATION

public static final FDBStoreTimer.Waits WAIT_INDEX_OPERATION

Wait for an IndexOperation to complete.

WAIT_ADD_INDEX

public static final FDBStoreTimer.Waits WAIT_ADD_INDEX

Wait for adding an index.

WAIT_DROP_INDEX

public static final FDBStoreTimer.Waits WAIT_DROP_INDEX

Wait for dropping an index.

WAIT_UPDATE_RECORDS_DESCRIPTOR

public static final FDBStoreTimer.Waits WAIT_UPDATE_RECORDS_DESCRIPTOR

Wait for updating records descriptor.

WAIT_MUTATE_METADATA

public static final FDBStoreTimer.Waits WAIT_MUTATE_METADATA

Wait for meta-data mutation.

WAIT_UPDATE_STORE_RECORD_VERSIONS

public static final FDBStoreTimer.Waits WAIT_UPDATE_STORE_RECORD_VERSIONS

Wait for updating if record versions should be stored.

WAIT_ENABLE_SPLIT_LONG_RECORDS

public static final FDBStoreTimer.Waits WAIT_ENABLE_SPLIT_LONG_RECORDS

Wait for enabling splitting long records.

WAIT_VERSION_STAMP

public static final FDBStoreTimer.Waits WAIT_VERSION_STAMP

Wait for the updated version stamp from a committed transaction. This future should normally be completed already, so this is mainly for error checking.

WAIT_META_DATA_VERSION_STAMP

public static final FDBStoreTimer.Waits WAIT_META_DATA_VERSION_STAMP

Wait to load the the cluster's meta-data version stamp.

WAIT_ADVANCE_CURSOR

public static final FDBStoreTimer.Waits WAIT_ADVANCE_CURSOR

Wait for a synchronous RecordCursor.next().

WAIT_KEYSPACE_SCAN

public static final FDBStoreTimer.Waits WAIT_KEYSPACE_SCAN

Wait for scanning a KeySpace to see whether it has data.

WAIT_KEYSPACE_LIST

public static final FDBStoreTimer.Waits WAIT_KEYSPACE_LIST

Wait for listing a KeySpace.

WAIT_KEYSPACE_CLEAR

public static final FDBStoreTimer.Waits WAIT_KEYSPACE_CLEAR

Wait for clearing a KeySpace.

WAIT_KEYSPACE_PATH_RESOLVE

public static final FDBStoreTimer.Waits WAIT_KEYSPACE_PATH_RESOLVE

Wait for resolving the path for a KeySpace.

WAIT_LOCATABLE_RESOLVER_COMPUTE_DIGEST

public static final FDBStoreTimer.Waits WAIT_LOCATABLE_RESOLVER_COMPUTE_DIGEST

Wait for a ResolverMappingDigest to be computed.

WAIT_LOCATABLE_RESOLVER_MAPPING_COPY

public static final FDBStoreTimer.Waits WAIT_LOCATABLE_RESOLVER_MAPPING_COPY

Wait for ResolverMappingReplicator to copy a directory layer.

WAIT_RETRY_DELAY

public static final FDBStoreTimer.Waits WAIT_RETRY_DELAY

Wait for a backoff delay on retryable error in FDBDatabase.run(java.util.function.Function<? super com.apple.foundationdb.record.provider.foundationdb.FDBRecordContext, ? extends T>).

WAIT_COLLECT_STATISTICS

public static final FDBStoreTimer.Waits WAIT_COLLECT_STATISTICS

Wait for statistics to be collected.

WAIT_GET_BOUNDARY

public static final FDBStoreTimer.Waits WAIT_GET_BOUNDARY

Wait for getting boundaries.

WAIT_SET_STATE_CACHEABILITY

public static final FDBStoreTimer.Waits WAIT_SET_STATE_CACHEABILITY

Wait for setting the store state cacheability.

WAIT_INIT_SYNC_SESSION

public static final FDBStoreTimer.Waits WAIT_INIT_SYNC_SESSION

Wait for initializing a synchronized session.

WAIT_CHECK_SYNC_SESSION

public static final FDBStoreTimer.Waits WAIT_CHECK_SYNC_SESSION

Wait for checking a synchronized session.

WAIT_END_SYNC_SESSION

public static final FDBStoreTimer.Waits WAIT_END_SYNC_SESSION

Wait for ending a synchronized session.

WAIT_EDIT_HEADER_USER_FIELD

public static final FDBStoreTimer.Waits WAIT_EDIT_HEADER_USER_FIELD

Wait for editing a header user field.

Method Detail

values

public static FDBStoreTimer.Waits[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FDBStoreTimer.Waits c : FDBStoreTimer.Waits.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FDBStoreTimer.Waits valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

title

public String title()

Description copied from interface: StoreTimer.Event

Get the title of this event for user displays.

Specified by:

title in interface StoreTimer.Event

Returns:

the user-visible title

logKey

@Nonnull
public String logKey()

Description copied from interface: StoreTimer.Event

Get the key of this event for logging. This should be used with KeyValueLogMessages and other key-value based logging systems to log the values from instrumented events. These keys are not expected to change frequently. They may, however, change outside of any minor version change. Their values, therefore, should not be relied upon, other than for the logging purposes.

Specified by:

logKey in interface StoreTimer.Event

Returns:

the key to use for logging