com.apple.foundationdb.record.provider.foundationdb

Enum FDBStoreTimer.Counts

java.lang.Object

java.lang.Enum<FDBStoreTimer.Counts>

com.apple.foundationdb.record.provider.foundationdb.FDBStoreTimer.Counts

All Implemented Interfaces:

StoreTimer.Count, StoreTimer.Event, Serializable, Comparable<FDBStoreTimer.Counts>

Enclosing class:

FDBStoreTimer

public static enum FDBStoreTimer.Counts
extends Enum<FDBStoreTimer.Counts>
implements StoreTimer.Count

Standard Count events.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BAD_INDEX_ENTRY The number of times that an index entry does not point to a valid record.
CLOSE_CONTEXT The number of times a record context is closed.
CREATE_RECORD_STORE The number of times a record store is created in the database.
DELETE_INDEX_KEY The number of index key-value pairs deleted.
DELETE_INDEX_KEY_BYTES The size of keys for index key-value pairs deleted.
DELETE_INDEX_VALUE_BYTES The size of values for index key-value pairs deleted.
DELETE_RECORD_KEY The number of record key-value pairs deleted.
DELETE_RECORD_KEY_BYTES The size of keys for record key-value pairs deleted.
DELETE_RECORD_VALUE_BYTES The size of values for record key-value pairs deleted.
INDEXES_NEED_REBUILDING The number of indexes that need to be rebuilt in the record store.
INVALID_KEY_LENGTH The number of record keys with an incorrect length found by FDBRecordStore.repairRecordKeys(byte[], com.apple.foundationdb.record.ScanProperties).
INVALID_SPLIT_SUFFIX The number of record keys with an invalid split suffix found by FDBRecordStore.repairRecordKeys(byte[], com.apple.foundationdb.record.ScanProperties).
LOAD_INDEX_KEY The number of index key-value pairs loaded.
LOAD_INDEX_KEY_BYTES The size of keys for index key-value pairs loaded.
LOAD_INDEX_VALUE_BYTES The size of values for index key-value pairs loaded.
LOAD_KEY_VALUE The number of key-value pairs loaded by a range scan.
LOAD_RECORD_KEY The number of record key-value pairs loaded.
LOAD_RECORD_KEY_BYTES The size of keys for record key-value pairs loaded.
LOAD_RECORD_VALUE_BYTES The size of values for record key-value pairs loaded.
LOAD_SCAN_ENTRY The number of entries (e.g., key-value pairs or text index entries) loaded by a scan.
LOAD_STORE_STATE_KEY The number of index state key-value pairs loaded.
LOAD_STORE_STATE_KEY_BYTES The size of keys for index state key-value pairs loaded.
LOAD_STORE_STATE_VALUE_BYTES The size of values for index state key-value pairs loaded.
LOAD_TEXT_ENTRY The number of entries loaded when scanning a text index.
ONLINE_INDEX_BUILDER_RECORDS_INDEXED The number of records indexed by OnlineIndexer.
ONLINE_INDEX_BUILDER_RECORDS_SCANNED The number of records scanned by OnlineIndexer.
OPEN_CONTEXT The number of times a record context is opened.
PLAN_COVERING_INDEX The number of query plans that use a covering index.
PLAN_DISTINCT The number of query plans that include a RecordQueryUnorderedDistinctPlan.
PLAN_FILTER The number of query plans that include a RecordQueryFilterPlan.
PLAN_IN_PARAMETER The number of query plans that include an IN with parameters.
PLAN_IN_VALUES The number of query plans that include an IN with literal values.
PLAN_INDEX The number of query plans that include an index.
PLAN_INTERSECTION The number of query plans that include an RecordQueryIntersectionPlan.
PLAN_LOAD_BY_KEYS The number of query plans that include a loading records directly by their primary keys.
PLAN_PK_DISTINCT The number of query plans that include a RecordQueryUnorderedPrimaryKeyDistinctPlan.
PLAN_SCAN The number of query plans that include a record scan without an index.
PLAN_SCORE_FOR_RANK The number of query plans that include translating a rank range into a score range.
PLAN_TYPE_FILTER The number of query plans that include a RecordQueryTypeFilterPlan.
PLAN_UNION The number of query plans that include a RecordQueryUnionPlan.
PLAN_UNORDERED_UNION The number of query plans that include a RecordQueryUnorderedUnionPlan.
QUERY_DISCARDED The number of records filtered out as not matching or duplicate.
QUERY_DISTINCT_PLAN_DUPLICATES The number of duplicate records found by RecordQueryUnorderedDistinctPlan.
QUERY_DISTINCT_PLAN_UNIQUES The number of unique records found by RecordQueryUnorderedDistinctPlan.
QUERY_FILTER_GIVEN The number of records given given to any filter within any plan.
QUERY_FILTER_PASSED The number of records passed by any filter within any plan.
QUERY_FILTER_PLAN_GIVEN The number of records given to RecordQueryFilterPlan.
QUERY_FILTER_PLAN_PASSED The number of records passed by RecordQueryFilterPlan.
QUERY_INTERSECTION_PLAN_MATCHES The number of matching records found by RecordQueryIntersectionPlan.
QUERY_INTERSECTION_PLAN_NONMATCHES The number of non-matching records found by RecordQueryIntersectionPlan.
QUERY_PK_DISTINCT_PLAN_DUPLICATES The number of duplicate records found by RecordQueryUnorderedPrimaryKeyDistinctPlan.
QUERY_PK_DISTINCT_PLAN_UNIQUES The number of unique records found by RecordQueryUnorderedPrimaryKeyDistinctPlan.
QUERY_TEXT_FILTER_PLAN_GIVEN The number of records given to a filter within a RecordQueryTextIndexPlan
QUERY_TEXT_FILTER_PLAN_PASSED The number of records passed by a filter within a RecordQueryTextIndexPlan
QUERY_TYPE_FILTER_PLAN_GIVEN The number of records given to RecordQueryTypeFilterPlan.
QUERY_TYPE_FILTER_PLAN_PASSED The number of records passed by RecordQueryTypeFilterPlan.
QUERY_UNION_PLAN_DUPLICATES The number of duplicate records found by RecordQueryUnorderedDistinctPlan.
QUERY_UNION_PLAN_UNIQUES The number of unique records found by RecordQueryUnorderedDistinctPlan.
REPAIR_RECORD_KEY The number of record keys repaired by FDBRecordStore.repairRecordKeys(byte[], com.apple.foundationdb.record.ScanProperties).
REPLACE_RECORD_VALUE_BYTES The previous size of values for record key-value pairs that are updated.
REVERSE_DIR_PERSISTENT_CACHE_HIT_COUNT The number of reverse directory cache hits.
REVERSE_DIR_PERSISTENT_CACHE_MISS_COUNT The number of reverse directory cache misses.
SAVE_INDEX_KEY The number of index key-value pairs saved.
SAVE_INDEX_KEY_BYTES The size of keys for index key-value pairs saved.
SAVE_INDEX_VALUE_BYTES The size of values for index key-value pairs saved.
SAVE_RECORD_KEY The number of record key-value pairs saved.
SAVE_RECORD_KEY_BYTES The size of keys for record key-value pairs saved.
SAVE_RECORD_VALUE_BYTES The size of values for record key-value pairs saved.
SET_READ_VERSION_TO_LAST_SEEN The number of times the read version was taken from the cache of the last seen version.
STORE_STATE_CACHE_HIT The number of times the store state cache returned a cached result.
STORE_STATE_CACHE_MISS The number of times the store state cache was unable to return a cached result.
TIME_WINDOW_LEADERBOARD_ADD_WINDOW The number of times that a leaderboard update adds a time window.
TIME_WINDOW_LEADERBOARD_DELETE_WINDOW The number of times that a leaderboard update deleted a time window.
TIME_WINDOW_LEADERBOARD_OVERLAPPING_CHANGED The number of times that a leaderboard needs to be rebuilt because a window was added after a score it should contain.

Method Summary

Modifier and Type	Method and Description
boolean	isSize() Get whether the count value is actually a size in bytes.
String	logKey() Get the key of this event for logging.
String	title() Get the title of this event for user displays.
static FDBStoreTimer.Counts	valueOf(String name) Returns the enum constant of this type with the specified name.
static FDBStoreTimer.Counts[]	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

OPEN_CONTEXT

public static final FDBStoreTimer.Counts OPEN_CONTEXT

The number of times a record context is opened.

CLOSE_CONTEXT

public static final FDBStoreTimer.Counts CLOSE_CONTEXT

The number of times a record context is closed.

CREATE_RECORD_STORE

public static final FDBStoreTimer.Counts CREATE_RECORD_STORE

The number of times a record store is created in the database.

STORE_STATE_CACHE_HIT

public static final FDBStoreTimer.Counts STORE_STATE_CACHE_HIT

The number of times the store state cache returned a cached result.

STORE_STATE_CACHE_MISS

public static final FDBStoreTimer.Counts STORE_STATE_CACHE_MISS

The number of times the store state cache was unable to return a cached result.

SAVE_RECORD_KEY

public static final FDBStoreTimer.Counts SAVE_RECORD_KEY

The number of record key-value pairs saved.

SAVE_RECORD_KEY_BYTES

public static final FDBStoreTimer.Counts SAVE_RECORD_KEY_BYTES

The size of keys for record key-value pairs saved.

SAVE_RECORD_VALUE_BYTES

public static final FDBStoreTimer.Counts SAVE_RECORD_VALUE_BYTES

The size of values for record key-value pairs saved.

LOAD_SCAN_ENTRY

public static final FDBStoreTimer.Counts LOAD_SCAN_ENTRY

The number of entries (e.g., key-value pairs or text index entries) loaded by a scan.

LOAD_KEY_VALUE

public static final FDBStoreTimer.Counts LOAD_KEY_VALUE

The number of key-value pairs loaded by a range scan.

LOAD_TEXT_ENTRY

public static final FDBStoreTimer.Counts LOAD_TEXT_ENTRY

The number of entries loaded when scanning a text index.

LOAD_RECORD_KEY

public static final FDBStoreTimer.Counts LOAD_RECORD_KEY

The number of record key-value pairs loaded.

LOAD_RECORD_KEY_BYTES

public static final FDBStoreTimer.Counts LOAD_RECORD_KEY_BYTES

The size of keys for record key-value pairs loaded.

LOAD_RECORD_VALUE_BYTES

public static final FDBStoreTimer.Counts LOAD_RECORD_VALUE_BYTES

The size of values for record key-value pairs loaded.

SAVE_INDEX_KEY

public static final FDBStoreTimer.Counts SAVE_INDEX_KEY

The number of index key-value pairs saved.

SAVE_INDEX_KEY_BYTES

public static final FDBStoreTimer.Counts SAVE_INDEX_KEY_BYTES

The size of keys for index key-value pairs saved.

SAVE_INDEX_VALUE_BYTES

public static final FDBStoreTimer.Counts SAVE_INDEX_VALUE_BYTES

The size of values for index key-value pairs saved.

LOAD_INDEX_KEY

public static final FDBStoreTimer.Counts LOAD_INDEX_KEY

The number of index key-value pairs loaded.

LOAD_INDEX_KEY_BYTES

public static final FDBStoreTimer.Counts LOAD_INDEX_KEY_BYTES

The size of keys for index key-value pairs loaded.

LOAD_INDEX_VALUE_BYTES

public static final FDBStoreTimer.Counts LOAD_INDEX_VALUE_BYTES

The size of values for index key-value pairs loaded.

LOAD_STORE_STATE_KEY

public static final FDBStoreTimer.Counts LOAD_STORE_STATE_KEY

The number of index state key-value pairs loaded.

LOAD_STORE_STATE_KEY_BYTES

public static final FDBStoreTimer.Counts LOAD_STORE_STATE_KEY_BYTES

The size of keys for index state key-value pairs loaded.

LOAD_STORE_STATE_VALUE_BYTES

public static final FDBStoreTimer.Counts LOAD_STORE_STATE_VALUE_BYTES

The size of values for index state key-value pairs loaded.

DELETE_RECORD_KEY

public static final FDBStoreTimer.Counts DELETE_RECORD_KEY

The number of record key-value pairs deleted.

DELETE_RECORD_KEY_BYTES

public static final FDBStoreTimer.Counts DELETE_RECORD_KEY_BYTES

The size of keys for record key-value pairs deleted.

DELETE_RECORD_VALUE_BYTES

public static final FDBStoreTimer.Counts DELETE_RECORD_VALUE_BYTES

The size of values for record key-value pairs deleted.

DELETE_INDEX_KEY

public static final FDBStoreTimer.Counts DELETE_INDEX_KEY

The number of index key-value pairs deleted.

DELETE_INDEX_KEY_BYTES

public static final FDBStoreTimer.Counts DELETE_INDEX_KEY_BYTES

The size of keys for index key-value pairs deleted.

DELETE_INDEX_VALUE_BYTES

public static final FDBStoreTimer.Counts DELETE_INDEX_VALUE_BYTES

The size of values for index key-value pairs deleted.

REPLACE_RECORD_VALUE_BYTES

public static final FDBStoreTimer.Counts REPLACE_RECORD_VALUE_BYTES

The previous size of values for record key-value pairs that are updated.

REVERSE_DIR_PERSISTENT_CACHE_MISS_COUNT

public static final FDBStoreTimer.Counts REVERSE_DIR_PERSISTENT_CACHE_MISS_COUNT

The number of reverse directory cache misses.

REVERSE_DIR_PERSISTENT_CACHE_HIT_COUNT

public static final FDBStoreTimer.Counts REVERSE_DIR_PERSISTENT_CACHE_HIT_COUNT

The number of reverse directory cache hits.

PLAN_COVERING_INDEX

public static final FDBStoreTimer.Counts PLAN_COVERING_INDEX

The number of query plans that use a covering index.

PLAN_FILTER

public static final FDBStoreTimer.Counts PLAN_FILTER

The number of query plans that include a RecordQueryFilterPlan.

PLAN_INDEX

public static final FDBStoreTimer.Counts PLAN_INDEX

The number of query plans that include an index.

PLAN_IN_PARAMETER

public static final FDBStoreTimer.Counts PLAN_IN_PARAMETER

The number of query plans that include an IN with parameters.

PLAN_IN_VALUES

public static final FDBStoreTimer.Counts PLAN_IN_VALUES

The number of query plans that include an IN with literal values.

PLAN_INTERSECTION

public static final FDBStoreTimer.Counts PLAN_INTERSECTION

The number of query plans that include an RecordQueryIntersectionPlan.

PLAN_LOAD_BY_KEYS

public static final FDBStoreTimer.Counts PLAN_LOAD_BY_KEYS

The number of query plans that include a loading records directly by their primary keys.

PLAN_SCAN

public static final FDBStoreTimer.Counts PLAN_SCAN

The number of query plans that include a record scan without an index.

PLAN_SCORE_FOR_RANK

public static final FDBStoreTimer.Counts PLAN_SCORE_FOR_RANK

The number of query plans that include translating a rank range into a score range.

PLAN_TYPE_FILTER

public static final FDBStoreTimer.Counts PLAN_TYPE_FILTER

The number of query plans that include a RecordQueryTypeFilterPlan.

PLAN_UNION

public static final FDBStoreTimer.Counts PLAN_UNION

The number of query plans that include a RecordQueryUnionPlan.

PLAN_UNORDERED_UNION

public static final FDBStoreTimer.Counts PLAN_UNORDERED_UNION

The number of query plans that include a RecordQueryUnorderedUnionPlan.

PLAN_DISTINCT

public static final FDBStoreTimer.Counts PLAN_DISTINCT

The number of query plans that include a RecordQueryUnorderedDistinctPlan.

PLAN_PK_DISTINCT

public static final FDBStoreTimer.Counts PLAN_PK_DISTINCT

The number of query plans that include a RecordQueryUnorderedPrimaryKeyDistinctPlan.

QUERY_FILTER_GIVEN

public static final FDBStoreTimer.Counts QUERY_FILTER_GIVEN

The number of records given given to any filter within any plan.

QUERY_FILTER_PASSED

public static final FDBStoreTimer.Counts QUERY_FILTER_PASSED

The number of records passed by any filter within any plan.

QUERY_FILTER_PLAN_GIVEN

public static final FDBStoreTimer.Counts QUERY_FILTER_PLAN_GIVEN

The number of records given to RecordQueryFilterPlan.

QUERY_FILTER_PLAN_PASSED

public static final FDBStoreTimer.Counts QUERY_FILTER_PLAN_PASSED

The number of records passed by RecordQueryFilterPlan.

QUERY_TYPE_FILTER_PLAN_GIVEN

public static final FDBStoreTimer.Counts QUERY_TYPE_FILTER_PLAN_GIVEN

The number of records given to RecordQueryTypeFilterPlan.

QUERY_TYPE_FILTER_PLAN_PASSED

public static final FDBStoreTimer.Counts QUERY_TYPE_FILTER_PLAN_PASSED

The number of records passed by RecordQueryTypeFilterPlan.

QUERY_TEXT_FILTER_PLAN_GIVEN

public static final FDBStoreTimer.Counts QUERY_TEXT_FILTER_PLAN_GIVEN

The number of records given to a filter within a RecordQueryTextIndexPlan

QUERY_TEXT_FILTER_PLAN_PASSED

public static final FDBStoreTimer.Counts QUERY_TEXT_FILTER_PLAN_PASSED

The number of records passed by a filter within a RecordQueryTextIndexPlan

QUERY_DISTINCT_PLAN_DUPLICATES

public static final FDBStoreTimer.Counts QUERY_DISTINCT_PLAN_DUPLICATES

The number of duplicate records found by RecordQueryUnorderedDistinctPlan.

QUERY_DISTINCT_PLAN_UNIQUES

public static final FDBStoreTimer.Counts QUERY_DISTINCT_PLAN_UNIQUES

The number of unique records found by RecordQueryUnorderedDistinctPlan.

QUERY_PK_DISTINCT_PLAN_DUPLICATES

public static final FDBStoreTimer.Counts QUERY_PK_DISTINCT_PLAN_DUPLICATES

The number of duplicate records found by RecordQueryUnorderedPrimaryKeyDistinctPlan.

QUERY_PK_DISTINCT_PLAN_UNIQUES

public static final FDBStoreTimer.Counts QUERY_PK_DISTINCT_PLAN_UNIQUES

The number of unique records found by RecordQueryUnorderedPrimaryKeyDistinctPlan.

QUERY_INTERSECTION_PLAN_MATCHES

public static final FDBStoreTimer.Counts QUERY_INTERSECTION_PLAN_MATCHES

The number of matching records found by RecordQueryIntersectionPlan.

QUERY_INTERSECTION_PLAN_NONMATCHES

public static final FDBStoreTimer.Counts QUERY_INTERSECTION_PLAN_NONMATCHES

The number of non-matching records found by RecordQueryIntersectionPlan.

QUERY_UNION_PLAN_DUPLICATES

public static final FDBStoreTimer.Counts QUERY_UNION_PLAN_DUPLICATES

The number of duplicate records found by RecordQueryUnorderedDistinctPlan.

QUERY_UNION_PLAN_UNIQUES

public static final FDBStoreTimer.Counts QUERY_UNION_PLAN_UNIQUES

The number of unique records found by RecordQueryUnorderedDistinctPlan.

QUERY_DISCARDED

public static final FDBStoreTimer.Counts QUERY_DISCARDED

The number of records filtered out as not matching or duplicate.

SET_READ_VERSION_TO_LAST_SEEN

public static final FDBStoreTimer.Counts SET_READ_VERSION_TO_LAST_SEEN

The number of times the read version was taken from the cache of the last seen version.

ONLINE_INDEX_BUILDER_RECORDS_SCANNED

public static final FDBStoreTimer.Counts ONLINE_INDEX_BUILDER_RECORDS_SCANNED

The number of records scanned by OnlineIndexer.

ONLINE_INDEX_BUILDER_RECORDS_INDEXED

public static final FDBStoreTimer.Counts ONLINE_INDEX_BUILDER_RECORDS_INDEXED

The number of records indexed by OnlineIndexer.

TIME_WINDOW_LEADERBOARD_ADD_WINDOW

public static final FDBStoreTimer.Counts TIME_WINDOW_LEADERBOARD_ADD_WINDOW

The number of times that a leaderboard update adds a time window.

TIME_WINDOW_LEADERBOARD_DELETE_WINDOW

public static final FDBStoreTimer.Counts TIME_WINDOW_LEADERBOARD_DELETE_WINDOW

The number of times that a leaderboard update deleted a time window.

TIME_WINDOW_LEADERBOARD_OVERLAPPING_CHANGED

public static final FDBStoreTimer.Counts TIME_WINDOW_LEADERBOARD_OVERLAPPING_CHANGED

The number of times that a leaderboard needs to be rebuilt because a window was added after a score it should contain.

BAD_INDEX_ENTRY

public static final FDBStoreTimer.Counts BAD_INDEX_ENTRY

The number of times that an index entry does not point to a valid record.

REPAIR_RECORD_KEY

public static final FDBStoreTimer.Counts REPAIR_RECORD_KEY

The number of record keys repaired by FDBRecordStore.repairRecordKeys(byte[], com.apple.foundationdb.record.ScanProperties).

INVALID_SPLIT_SUFFIX

public static final FDBStoreTimer.Counts INVALID_SPLIT_SUFFIX

The number of record keys with an invalid split suffix found by FDBRecordStore.repairRecordKeys(byte[], com.apple.foundationdb.record.ScanProperties).

INVALID_KEY_LENGTH

public static final FDBStoreTimer.Counts INVALID_KEY_LENGTH

The number of record keys with an incorrect length found by FDBRecordStore.repairRecordKeys(byte[], com.apple.foundationdb.record.ScanProperties).

INDEXES_NEED_REBUILDING

public static final FDBStoreTimer.Counts INDEXES_NEED_REBUILDING

The number of indexes that need to be rebuilt in the record store.

Method Detail

values

public static FDBStoreTimer.Counts[] 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.Counts c : FDBStoreTimer.Counts.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.Counts 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

isSize

public boolean isSize()

Description copied from interface: StoreTimer.Count

Get whether the count value is actually a size in bytes.

Specified by:

isSize in interface StoreTimer.Count

Returns:

true if the count value is actually a size in bytes