StoreTimer.Event (fdb-record-layer-core-pb3 2.10.164.0 API)

All Known Subinterfaces:

StoreTimer.Aggregate, StoreTimer.Count, StoreTimer.DetailEvent, StoreTimer.Wait

All Known Implementing Classes:

FDBStoreTimer.CountAggregates, FDBStoreTimer.Counts, FDBStoreTimer.DetailEvents, FDBStoreTimer.Events, FDBStoreTimer.Waits, RankedSetIndexHelper.Events, RecordSerializer.Counts, RecordSerializer.Events

Enclosing class:

StoreTimer
```
public static interface StoreTimer.Event
```
An identifier for occurrences that need to be timed.

Field Summary

Fields
Modifier and Type Field Description

static Map<String,Map<StoreTimer.Event,String>> LOG_KEY_SUFFIX_CACHE

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default String`	`logKey()`	Get the key of this event for logging.
`default String`	`logKeyWithSuffix(String suffix)`	Return the log key with a specified suffix appended.
`String`	`name()`	Get the name of this event for machine processing.
`String`	`title()`	Get the title of this event for user displays.

- Field Detail
  - LOG_KEY_SUFFIX_CACHE
```
static final Map<String,Map<StoreTimer.Event,String>> LOG_KEY_SUFFIX_CACHE
```
- Method Detail
  - name
```
String name()
```
    Get the name of this event for machine processing.
    
    Returns:
    
    the name
  - title
```
String title()
```
    Get the title of this event for user displays.
    
    Returns:
    
    the user-visible title
  - logKey
```
default String logKey()
```
    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.
    
    Returns:
    
    the key to use for logging
  - logKeyWithSuffix
```
default String logKeyWithSuffix(@Nonnull
                                String suffix)
```
    Return the log key with a specified suffix appended.
    
    Parameters:
    
    suffix - the suffix to append to the log key
    
    Returns:
    
    the log key with suffix appended