Enum FDBStoreTimer.Events
- java.lang.Object
-
- java.lang.Enum<FDBStoreTimer.Events>
-
- com.apple.foundationdb.record.provider.foundationdb.FDBStoreTimer.Events
-
- All Implemented Interfaces:
StoreTimer.Event
,Serializable
,Comparable<FDBStoreTimer.Events>
- Enclosing class:
- FDBStoreTimer
public static enum FDBStoreTimer.Events extends Enum<FDBStoreTimer.Events> implements StoreTimer.Event
Ordinary top-level events which surround a single body of code.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description BATCH_GET_READ_VERSION
The amount of time taken to get a read version for batch priority transactions.CHECK_INDEX_UNIQUENESS
The amount of time spent checking an index for duplicate entries to preserve uniqueness.CHECK_VERSION
The amount of time in thecheckVersion
call.COMMIT
The amount of time taken committing transactions successfully.COMMIT_FAILURE
The amount of time taken committing transactions that did not succeed.COMMIT_READ_ONLY
The amount of time taken committing transactions that did not actually have any writes.COMMITS
Total number and duration of commits.COMPUTE_BOUNDARY_KEYS
Deprecated.this is no longer usedDELETE_INDEX_ENTRY
The amount of time spent deleting an entry from a secondary index.DELETE_RECORD
The amount of time taken deleting records.DIRECTORY_READ
The amount of time spent reading an entry from a directory layer.EXTENDED_DIRECTORY_LAYER_CREATE
The amount of time spent adding a new entry to anExtendedDirectoryLayer
.EXTENDED_DIRECTORY_LAYER_READ
The amount of time spent reading an entry from anExtendedDirectoryLayer
.GET_META_DATA_CACHE_ENTRY
The amount of time taken getting cached meta-data from aMetaDataCache
.GET_META_DATA_CACHE_VERSION
The amount of time taken getting the current version from aMetaDataCache
.GET_READ_VERSION
The amount of time taken to get a read version when explicitly called.INJECTED_COMMIT_LATENCY
The amount of time injected into committing transactions.INJECTED_GET_READ_VERSION_LATENCY
The amount of time injected by the client prior to getting a read version.INTERNING_LAYER_CREATE
The amount of time spent adding a new entry to aScopedInterningLayer
.INTERNING_LAYER_READ
The amount of time spent reading an entry from aScopedInterningLayer
.LOAD_BOUNDARY_KEYS
The amount of time spent loading boundary keys.LOAD_META_DATA
The amount of time taken loading meta-data from aFDBMetaDataStore
.LOAD_RECORD
The amount of time taken loading records.LOAD_RECORD_STORE_INDEX_META_DATA
The amount of time taken loading a record store's index meta-data.LOAD_RECORD_STORE_INFO
The amount of time taken loading a record store'sDataStoreInfo
header.LOAD_RECORD_STORE_STATE
The amount of time taken loading a record store'sRecordStoreState
listing store-specific information.LOAD_RECORD_VERSION
Deprecated.this is no longer publishedMUTATE_INDEX_ENTRY
The amount of time spent updating an entry in an atomic mutation index.PERFORM_NO_OP
The amount of time taken performing a no-op.PLAN_QUERY
The amount of time spent planning a query.QUERY_DISTINCT
The amount of time spent inRecordQueryUnorderedDistinctPlan
as part of executing a query.QUERY_FILTER
The amount of time spent inRecordQueryFilterPlan
as part of executing a query.QUERY_INTERSECTION
The amount of time spent inRecordQueryIntersectionPlan
as part of executing a query.QUERY_PK_DISTINCT
The amount of time spent inRecordQueryUnorderedPrimaryKeyDistinctPlan
as part of executing a query.QUERY_TEXT_FILTER
The amount of time spent filtering by text contents inRecordQueryTextIndexPlan
as part of executing a query.QUERY_TYPE_FILTER
The amount of time spent inRecordQueryTypeFilterPlan
as part of executing a query.QUERY_UNION
The amount of time spent inRecordQueryUnionPlan
as part of executing a query.READ_SAMPLE_KEY
The amount of time spent reading a sample key to measure read latency.REBUILD_INDEX
The amount of time spent deleting an entry from a secondary index.RECOUNT_RECORDS
The amount of time spent counting records for the deprecated record count key.REMOVE_FORMER_INDEX
The amount of time spent clearing the space taken by an index that has been removed from the meta-data.SAVE_INDEX_ENTRY
The amount of time spent saving an entry to a secondary index.SAVE_META_DATA
The amount of time taken persisting meta-data to aFDBMetaDataStore
.SAVE_RECORD
The amount of time taken saving records.SCAN_INDEX_KEYS
The amount of time taken scanning the entries of an index.SCAN_RECORDS
The amount of time taken scanning records directly without any index.SCOPED_DIRECTORY_LAYER_CREATE
The amount of time spent adding a new entry to aScopedDirectoryLayer
.SCOPED_DIRECTORY_LAYER_READ
The amount of time spent reading an entry from aScopedDirectoryLayer
.SKIP_INDEX_ENTRY
The amount of time spent maintaining an index when an entry is skipped by theIndexMaintenanceFilter
.SKIP_INDEX_RECORD
The amount of time spent maintaining an index when the entire record is skipped by theIndexMaintenanceFilter
.TIME_WINDOW_LEADERBOARD_GET_DIRECTORY
The amount of time spent inTimeWindowLeaderboardDirectoryOperation
.TIME_WINDOW_LEADERBOARD_GET_SUB_DIRECTORY
The amount of time spent inTimeWindowLeaderboardSubDirectoryOperation
.TIME_WINDOW_LEADERBOARD_SAVE_SUB_DIRECTORY
The amount of time spent inTimeWindowLeaderboardSaveSubDirectory
.TIME_WINDOW_LEADERBOARD_TRIM_SCORES
The amount of time spent inTimeWindowLeaderboardScoreTrim
.TIME_WINDOW_LEADERBOARD_UPDATE_DIRECTORY
The amount of time spent inTimeWindowLeaderboardWindowUpdate
.TIMEOUTS
The total number of timeouts that have happened during asyncToSync and their durations.
-
Field Summary
-
Fields inherited from interface com.apple.foundationdb.record.provider.common.StoreTimer.Event
LOG_KEY_SUFFIX_CACHE
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
logKey()
Get the key of this event for logging.String
title()
Get the title of this event for user displays.static FDBStoreTimer.Events
valueOf(String name)
Returns the enum constant of this type with the specified name.static FDBStoreTimer.Events[]
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 interface com.apple.foundationdb.record.provider.common.StoreTimer.Event
logKeyWithSuffix, name
-
-
-
-
Enum Constant Detail
-
PERFORM_NO_OP
public static final FDBStoreTimer.Events PERFORM_NO_OP
The amount of time taken performing a no-op.
-
GET_READ_VERSION
public static final FDBStoreTimer.Events GET_READ_VERSION
The amount of time taken to get a read version when explicitly called. This metric is recorded only if the transaction is not conducted at batch priority. This includes any injected latency by the client before issuing the request.
-
BATCH_GET_READ_VERSION
public static final FDBStoreTimer.Events BATCH_GET_READ_VERSION
The amount of time taken to get a read version for batch priority transactions. This is a separate metric fromGET_READ_VERSION
(which is recorded on non-batch priority transactions) because the performance of batch priority read reversion requests are is requested to be significantly different than the performance of non-batch priority requests. This is because the read version request is the primary mechanism by which the FoundationDB cluster can introduce back pressure, and the cluster will favor higher priority transactions over lower priority transactions.Like
GET_READ_VERSION
, this includes any latency injected by the client before issuing the request.
-
INJECTED_GET_READ_VERSION_LATENCY
public static final FDBStoreTimer.Events INJECTED_GET_READ_VERSION_LATENCY
The amount of time injected by the client prior to getting a read version.
-
COMMIT
public static final FDBStoreTimer.Events COMMIT
The amount of time taken committing transactions successfully. This includes any injected latency added before issuing the request and any time spent performing pre-commit checks.- See Also:
INJECTED_COMMIT_LATENCY
-
INJECTED_COMMIT_LATENCY
public static final FDBStoreTimer.Events INJECTED_COMMIT_LATENCY
The amount of time injected into committing transactions.
-
COMMIT_READ_ONLY
public static final FDBStoreTimer.Events COMMIT_READ_ONLY
The amount of time taken committing transactions that did not actually have any writes.
-
COMMIT_FAILURE
public static final FDBStoreTimer.Events COMMIT_FAILURE
The amount of time taken committing transactions that did not succeed.
-
SAVE_META_DATA
public static final FDBStoreTimer.Events SAVE_META_DATA
The amount of time taken persisting meta-data to aFDBMetaDataStore
.
-
LOAD_META_DATA
public static final FDBStoreTimer.Events LOAD_META_DATA
The amount of time taken loading meta-data from aFDBMetaDataStore
.
-
LOAD_RECORD_STORE_STATE
public static final FDBStoreTimer.Events LOAD_RECORD_STORE_STATE
The amount of time taken loading a record store'sRecordStoreState
listing store-specific information.
-
LOAD_RECORD_STORE_INFO
public static final FDBStoreTimer.Events LOAD_RECORD_STORE_INFO
The amount of time taken loading a record store'sDataStoreInfo
header.
-
LOAD_RECORD_STORE_INDEX_META_DATA
public static final FDBStoreTimer.Events LOAD_RECORD_STORE_INDEX_META_DATA
The amount of time taken loading a record store's index meta-data.
-
GET_META_DATA_CACHE_VERSION
public static final FDBStoreTimer.Events GET_META_DATA_CACHE_VERSION
The amount of time taken getting the current version from aMetaDataCache
.
-
GET_META_DATA_CACHE_ENTRY
public static final FDBStoreTimer.Events GET_META_DATA_CACHE_ENTRY
The amount of time taken getting cached meta-data from aMetaDataCache
.
-
SAVE_RECORD
public static final FDBStoreTimer.Events SAVE_RECORD
The amount of time taken saving records. This time includes serialization and secondary index maintenance as well as writing to the current transaction for later committing.
-
LOAD_RECORD
public static final FDBStoreTimer.Events LOAD_RECORD
The amount of time taken loading records. This time includes fetching from the database and deserialization.
-
LOAD_RECORD_VERSION
@Deprecated public static final FDBStoreTimer.Events LOAD_RECORD_VERSION
Deprecated.this is no longer publishedThe amount of time taken loading record versions.
-
SCAN_RECORDS
public static final FDBStoreTimer.Events SCAN_RECORDS
The amount of time taken scanning records directly without any index.
-
SCAN_INDEX_KEYS
public static final FDBStoreTimer.Events SCAN_INDEX_KEYS
The amount of time taken scanning the entries of an index. An ordinary index scan from a query will entail both an index entry scan andLOAD_RECORD
for each record pointed to by an index entry.
-
DELETE_RECORD
public static final FDBStoreTimer.Events DELETE_RECORD
The amount of time taken deleting records. This time includes secondary index maintenance as well as writing to the current transaction for later committing.
-
SKIP_INDEX_RECORD
public static final FDBStoreTimer.Events SKIP_INDEX_RECORD
The amount of time spent maintaining an index when the entire record is skipped by theIndexMaintenanceFilter
.
-
SKIP_INDEX_ENTRY
public static final FDBStoreTimer.Events SKIP_INDEX_ENTRY
The amount of time spent maintaining an index when an entry is skipped by theIndexMaintenanceFilter
.
-
SAVE_INDEX_ENTRY
public static final FDBStoreTimer.Events SAVE_INDEX_ENTRY
The amount of time spent saving an entry to a secondary index.
-
DELETE_INDEX_ENTRY
public static final FDBStoreTimer.Events DELETE_INDEX_ENTRY
The amount of time spent deleting an entry from a secondary index.
-
MUTATE_INDEX_ENTRY
public static final FDBStoreTimer.Events MUTATE_INDEX_ENTRY
The amount of time spent updating an entry in an atomic mutation index.
-
REBUILD_INDEX
public static final FDBStoreTimer.Events REBUILD_INDEX
The amount of time spent deleting an entry from a secondary index.
-
REMOVE_FORMER_INDEX
public static final FDBStoreTimer.Events REMOVE_FORMER_INDEX
The amount of time spent clearing the space taken by an index that has been removed from the meta-data.
-
RECOUNT_RECORDS
public static final FDBStoreTimer.Events RECOUNT_RECORDS
The amount of time spent counting records for the deprecated record count key.
-
CHECK_INDEX_UNIQUENESS
public static final FDBStoreTimer.Events CHECK_INDEX_UNIQUENESS
The amount of time spent checking an index for duplicate entries to preserve uniqueness.
-
CHECK_VERSION
public static final FDBStoreTimer.Events CHECK_VERSION
The amount of time in thecheckVersion
call. This may include time to rebuild indexes if the record store is small enough.
-
DIRECTORY_READ
public static final FDBStoreTimer.Events DIRECTORY_READ
The amount of time spent reading an entry from a directory layer.
-
SCOPED_DIRECTORY_LAYER_READ
public static final FDBStoreTimer.Events SCOPED_DIRECTORY_LAYER_READ
The amount of time spent reading an entry from aScopedDirectoryLayer
.
-
SCOPED_DIRECTORY_LAYER_CREATE
public static final FDBStoreTimer.Events SCOPED_DIRECTORY_LAYER_CREATE
The amount of time spent adding a new entry to aScopedDirectoryLayer
.
-
EXTENDED_DIRECTORY_LAYER_READ
public static final FDBStoreTimer.Events EXTENDED_DIRECTORY_LAYER_READ
The amount of time spent reading an entry from anExtendedDirectoryLayer
.
-
EXTENDED_DIRECTORY_LAYER_CREATE
public static final FDBStoreTimer.Events EXTENDED_DIRECTORY_LAYER_CREATE
The amount of time spent adding a new entry to anExtendedDirectoryLayer
.
-
INTERNING_LAYER_READ
public static final FDBStoreTimer.Events INTERNING_LAYER_READ
The amount of time spent reading an entry from aScopedInterningLayer
.
-
INTERNING_LAYER_CREATE
public static final FDBStoreTimer.Events INTERNING_LAYER_CREATE
The amount of time spent adding a new entry to aScopedInterningLayer
.
-
LOAD_BOUNDARY_KEYS
public static final FDBStoreTimer.Events LOAD_BOUNDARY_KEYS
The amount of time spent loading boundary keys.
-
COMPUTE_BOUNDARY_KEYS
@Deprecated public static final FDBStoreTimer.Events COMPUTE_BOUNDARY_KEYS
Deprecated.this is no longer usedThe amount of time spent computing boundary keys.
-
READ_SAMPLE_KEY
public static final FDBStoreTimer.Events READ_SAMPLE_KEY
The amount of time spent reading a sample key to measure read latency.
-
PLAN_QUERY
public static final FDBStoreTimer.Events PLAN_QUERY
The amount of time spent planning a query.
-
QUERY_FILTER
public static final FDBStoreTimer.Events QUERY_FILTER
The amount of time spent inRecordQueryFilterPlan
as part of executing a query.
-
QUERY_TYPE_FILTER
public static final FDBStoreTimer.Events QUERY_TYPE_FILTER
The amount of time spent inRecordQueryTypeFilterPlan
as part of executing a query.
-
QUERY_TEXT_FILTER
public static final FDBStoreTimer.Events QUERY_TEXT_FILTER
The amount of time spent filtering by text contents inRecordQueryTextIndexPlan
as part of executing a query.
-
QUERY_INTERSECTION
public static final FDBStoreTimer.Events QUERY_INTERSECTION
The amount of time spent inRecordQueryIntersectionPlan
as part of executing a query.
-
QUERY_UNION
public static final FDBStoreTimer.Events QUERY_UNION
The amount of time spent inRecordQueryUnionPlan
as part of executing a query.
-
QUERY_DISTINCT
public static final FDBStoreTimer.Events QUERY_DISTINCT
The amount of time spent inRecordQueryUnorderedDistinctPlan
as part of executing a query.
-
QUERY_PK_DISTINCT
public static final FDBStoreTimer.Events QUERY_PK_DISTINCT
The amount of time spent inRecordQueryUnorderedPrimaryKeyDistinctPlan
as part of executing a query.
-
TIME_WINDOW_LEADERBOARD_GET_DIRECTORY
public static final FDBStoreTimer.Events TIME_WINDOW_LEADERBOARD_GET_DIRECTORY
The amount of time spent inTimeWindowLeaderboardDirectoryOperation
.
-
TIME_WINDOW_LEADERBOARD_UPDATE_DIRECTORY
public static final FDBStoreTimer.Events TIME_WINDOW_LEADERBOARD_UPDATE_DIRECTORY
The amount of time spent inTimeWindowLeaderboardWindowUpdate
.
-
TIME_WINDOW_LEADERBOARD_TRIM_SCORES
public static final FDBStoreTimer.Events TIME_WINDOW_LEADERBOARD_TRIM_SCORES
The amount of time spent inTimeWindowLeaderboardScoreTrim
.
-
TIME_WINDOW_LEADERBOARD_GET_SUB_DIRECTORY
public static final FDBStoreTimer.Events TIME_WINDOW_LEADERBOARD_GET_SUB_DIRECTORY
The amount of time spent inTimeWindowLeaderboardSubDirectoryOperation
.
-
TIME_WINDOW_LEADERBOARD_SAVE_SUB_DIRECTORY
public static final FDBStoreTimer.Events TIME_WINDOW_LEADERBOARD_SAVE_SUB_DIRECTORY
The amount of time spent inTimeWindowLeaderboardSaveSubDirectory
.
-
TIMEOUTS
public static final FDBStoreTimer.Events TIMEOUTS
The total number of timeouts that have happened during asyncToSync and their durations.
-
COMMITS
public static final FDBStoreTimer.Events COMMITS
Total number and duration of commits.
-
-
Method Detail
-
values
public static FDBStoreTimer.Events[] 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.Events c : FDBStoreTimer.Events.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.Events 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 nameNullPointerException
- 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 interfaceStoreTimer.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 withKeyValueLogMessage
s 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 interfaceStoreTimer.Event
- Returns:
- the key to use for logging
-
-