PerIndexStats (Hazelcast Root 3.12-BETA-1 API)

All Known Implementing Classes:

GlobalPerIndexStats, PartitionPerIndexStats
```
public interface PerIndexStats
```
Provides internal per-index statistics for Index.

Field Summary

Fields
Modifier and Type Field and Description

static PerIndexStats EMPTY
Empty no-op internal index stats instance.

Fields
Modifier and Type	Field and Description
`static PerIndexStats`	`EMPTY` Empty no-op internal index stats instance.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`IndexOperationStats`	`createOperationStats()` Creates a new per-operation stats instance.
`long`	`getCreationTime()` Returns the creation time of the index.
`long`	`getHitCount()` Returns the total number of hits into the index.
`long`	`getInsertCount()` Returns the number of insert operations performed on the index.
`long`	`getMemoryCost()` Returns the memory cost of the index in bytes.
`long`	`getQueryCount()` Returns the total number of queries served by the index.
`long`	`getRemoveCount()` Returns the number of remove operations performed on the index.
`long`	`getTotalHitLatency()` Returns the total hit latency for the index.
`long`	`getTotalInsertLatency()` Returns the total latency (in nanoseconds) of insert operations performed on the index.
`double`	`getTotalNormalizedHitCardinality()` Returns the total normalized cardinality of the hits served by the index.
`long`	`getTotalRemoveLatency()` Returns the total latency (in nanoseconds) of remove operations performed on the index.
`long`	`getTotalUpdateLatency()` Returns the total latency (in nanoseconds) of update operations performed on the index.
`long`	`getUpdateCount()` Returns the number of update operations performed on the index.
`void`	`incrementQueryCount()` Increments the query count for the index.
`long`	`makeTimestamp()` Returns a new timestamp.
`void`	`onClear()` Invoked by the associated index after the index was cleared.
`void`	`onIndexHit(long timestamp, long hitCardinality)` Invoked by the associated index after every index hit.
`void`	`onInsert(long timestamp, IndexOperationStats operationStats, Index.OperationSource operationSource)` Invoked by the associated index after every insert operation.
`void`	`onRemove(long timestamp, IndexOperationStats operationStats, Index.OperationSource operationSource)` Invoked by the associated index after every remove operation.
`void`	`onUpdate(long timestamp, IndexOperationStats operationStats, Index.OperationSource operationSource)` Invoked by the associated index after every update operation.
`void`	`resetPerQueryStats()` Resets the per-query stats, if any, currently tracked by this internal index stats instance.
`MemoryAllocator`	`wrapMemoryAllocator(MemoryAllocator memoryAllocator)` Wraps the given memory allocator.

- Field Detail
  - EMPTY
```
static final PerIndexStats EMPTY
```
    Empty no-op internal index stats instance.
- Method Detail
  - makeTimestamp
```
long makeTimestamp()
```
    Returns a new timestamp.
    Used for latency measurement, expressed in nanoseconds.
  - getCreationTime
```
long getCreationTime()
```
    Returns the creation time of the index.
    The value is relative to midnight, January 1, 1970 UTC and expressed in milliseconds.
  - getQueryCount
```
long getQueryCount()
```
    Returns the total number of queries served by the index.
    The returned value may be less than the one returned by getHitCount() since a single query may hit the same index more than once.
  - incrementQueryCount
```
void incrementQueryCount()
```
    Increments the query count for the index.
  - getHitCount
```
long getHitCount()
```
    Returns the total number of hits into the index.
    The returned value may be greater than the one returned by getQueryCount() since a single query may hit the same index more than once.
  - getTotalHitLatency
```
long getTotalHitLatency()
```
    Returns the total hit latency for the index.
  - getTotalNormalizedHitCardinality
```
double getTotalNormalizedHitCardinality()
```
    Returns the total normalized cardinality of the hits served by the index.
    Normalized hit cardinality is calculated as hit_cardinality / entry_count at the time of the hit. The returned value is a sum of all individual normalized hit cardinalities.
  - getInsertCount
```
long getInsertCount()
```
    Returns the number of insert operations performed on the index.
  - getTotalInsertLatency
```
long getTotalInsertLatency()
```
    Returns the total latency (in nanoseconds) of insert operations performed on the index.
    To compute the average latency divide the returned value by insert operation count.
  - getUpdateCount
```
long getUpdateCount()
```
    Returns the number of update operations performed on the index.
  - getTotalUpdateLatency
```
long getTotalUpdateLatency()
```
    Returns the total latency (in nanoseconds) of update operations performed on the index.
    To compute the average latency divide the returned value by update operation count.
  - getRemoveCount
```
long getRemoveCount()
```
    Returns the number of remove operations performed on the index.
  - getTotalRemoveLatency
```
long getTotalRemoveLatency()
```
    Returns the total latency (in nanoseconds) of remove operations performed on the index.
    To compute the average latency divide the returned value by remove operation count.
  - getMemoryCost
```
long getMemoryCost()
```
    Returns the memory cost of the index in bytes.
    Currently, for on-heap indexes (OBJECT and BINARY storages), the returned value is just a best-effort approximation and doesn't indicate a precise on-heap memory usage of the index.
  - onInsert
```
void onInsert(long timestamp,
              IndexOperationStats operationStats,
              Index.OperationSource operationSource)
```
    Invoked by the associated index after every insert operation.
    
    Parameters:
    
    timestamp - the time at which the insert operation was started.
    
    operationStats - the operation stats to track the stats.
    
    operationSource - the operation source.
    
    See Also:
    
    makeTimestamp(), Index.putEntry(com.hazelcast.query.impl.QueryableEntry, java.lang.Object, com.hazelcast.query.impl.Index.OperationSource)
  - onUpdate
```
void onUpdate(long timestamp,
              IndexOperationStats operationStats,
              Index.OperationSource operationSource)
```
    Invoked by the associated index after every update operation.
    
    Parameters:
    
    timestamp - the time at which the update operation was started.
    
    operationStats - the operation stats to track the stats.
    
    operationSource - the operation source.
    
    See Also:
    
    makeTimestamp(), Index.putEntry(com.hazelcast.query.impl.QueryableEntry, java.lang.Object, com.hazelcast.query.impl.Index.OperationSource)
  - onRemove
```
void onRemove(long timestamp,
              IndexOperationStats operationStats,
              Index.OperationSource operationSource)
```
    Invoked by the associated index after every remove operation.
    
    Parameters:
    
    timestamp - the time at which the remove operation was started.
    
    operationStats - the operation stats to track the stats.
    
    operationSource - the operation source.
    
    See Also:
    
    makeTimestamp(), Index.removeEntry(com.hazelcast.nio.serialization.Data, java.lang.Object, com.hazelcast.query.impl.Index.OperationSource)
  - onClear
```
void onClear()
```
    Invoked by the associated index after the index was cleared.
    
    See Also:
    
    Index.clear()
  - onIndexHit
```
void onIndexHit(long timestamp,
                long hitCardinality)
```
    Invoked by the associated index after every index hit.
    Following operations generate a hit:
    Parameters:
    
    timestamp - the time at which the hit-producing operation was started.
    
    hitCardinality - the cardinality of the hit.
    
    See Also:
    
    makeTimestamp()
  - resetPerQueryStats
```
void resetPerQueryStats()
```
    Resets the per-query stats, if any, currently tracked by this internal index stats instance.
  - wrapMemoryAllocator
```
MemoryAllocator wrapMemoryAllocator(MemoryAllocator memoryAllocator)
```
    Wraps the given memory allocator.
    Used for the off-heap memory cost tracking.
    
    Parameters:
    
    memoryAllocator - the memory allocator to wrap.
    
    Returns:
    
    the wrapped memory allocator.
  - createOperationStats
```
IndexOperationStats createOperationStats()
```
    Creates a new per-operation stats instance.
    
    Returns:
    
    the created per-operation stats instance.

Interface PerIndexStats

Field Summary

Method Summary

Field Detail

EMPTY

Method Detail

makeTimestamp

getCreationTime

getQueryCount

incrementQueryCount

getHitCount

getTotalHitLatency

getTotalNormalizedHitCardinality

getInsertCount

getTotalInsertLatency

getUpdateCount

getTotalUpdateLatency

getRemoveCount

getTotalRemoveLatency

getMemoryCost

onInsert

onUpdate

onRemove

onClear

onIndexHit

resetPerQueryStats

wrapMemoryAllocator

createOperationStats