com.apple.foundationdb.record.provider.foundationdb

Enum FDBStoreTimer.DetailEvents

java.lang.Object

java.lang.Enum<FDBStoreTimer.DetailEvents>

com.apple.foundationdb.record.provider.foundationdb.FDBStoreTimer.DetailEvents

All Implemented Interfaces:

StoreTimer.DetailEvent, StoreTimer.Event, Serializable, Comparable<FDBStoreTimer.DetailEvents>

Enclosing class:

FDBStoreTimer

public static enum FDBStoreTimer.DetailEvents
extends Enum<FDBStoreTimer.DetailEvents>
implements StoreTimer.DetailEvent

Standard StoreTimer.DetailEvents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GET_RECORD_RANGE_RAW_FIRST_CHUNK The amount of time spent until the first part of a split record is available.
GET_RECORD_RAW_VALUE The amount of time spent loading the raw bytes of a record.
GET_SCAN_RANGE_RAW_FIRST_CHUNK The amount of time spent until the first part of a range scan (such as an index) is available.
RANKED_SET_CONTAINS The amount of time spent checking for a key in a RankedSet skip list.
RANKED_SET_INIT The amount of time spent initializing a RankedSet skip list.
RANKED_SET_NEXT_LOOKUP The amount of time spent looking up the next level of a RankedSet skip list.
RANKED_SET_NEXT_LOOKUP_KEY The amount of time spent looking up the next entry of a RankedSet skip list.
RD_CACHE_DIRECTORY_SCAN The amount of time spent scanning the directory subspace after a hard miss in FDBReverseDirectoryCache.
RESOLVER_STATE_READ The amount of time spent reading the lock state of a LocatableResolver.

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.DetailEvents	valueOf(String name) Returns the enum constant of this type with the specified name.
static FDBStoreTimer.DetailEvents[]	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

GET_RECORD_RAW_VALUE

public static final FDBStoreTimer.DetailEvents GET_RECORD_RAW_VALUE

The amount of time spent loading the raw bytes of a record.

GET_RECORD_RANGE_RAW_FIRST_CHUNK

public static final FDBStoreTimer.DetailEvents GET_RECORD_RANGE_RAW_FIRST_CHUNK

The amount of time spent until the first part of a split record is available.

GET_SCAN_RANGE_RAW_FIRST_CHUNK

public static final FDBStoreTimer.DetailEvents GET_SCAN_RANGE_RAW_FIRST_CHUNK

The amount of time spent until the first part of a range scan (such as an index) is available.

RANKED_SET_INIT

public static final FDBStoreTimer.DetailEvents RANKED_SET_INIT

The amount of time spent initializing a RankedSet skip list.

RANKED_SET_NEXT_LOOKUP

public static final FDBStoreTimer.DetailEvents RANKED_SET_NEXT_LOOKUP

The amount of time spent looking up the next level of a RankedSet skip list.

RANKED_SET_NEXT_LOOKUP_KEY

public static final FDBStoreTimer.DetailEvents RANKED_SET_NEXT_LOOKUP_KEY

The amount of time spent looking up the next entry of a RankedSet skip list.

RANKED_SET_CONTAINS

public static final FDBStoreTimer.DetailEvents RANKED_SET_CONTAINS

The amount of time spent checking for a key in a RankedSet skip list.

RESOLVER_STATE_READ

public static final FDBStoreTimer.DetailEvents RESOLVER_STATE_READ

The amount of time spent reading the lock state of a LocatableResolver.

RD_CACHE_DIRECTORY_SCAN

public static final FDBStoreTimer.DetailEvents RD_CACHE_DIRECTORY_SCAN

The amount of time spent scanning the directory subspace after a hard miss in FDBReverseDirectoryCache.

Method Detail

values

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