GlobalPerIndexStats (Hazelcast Root 3.12.12 API)

java.lang.Object
- com.hazelcast.monitor.impl.GlobalPerIndexStats

All Implemented Interfaces:

PerIndexStats
```
public class GlobalPerIndexStats
extends Object
implements PerIndexStats
```
The implementation of internal index stats specialized for global indexes.
The main trait of the implementation is the concurrency support, which is required for global indexes because they are shared among partitions.

Field Summary
- Fields inherited from interface com.hazelcast.monitor.impl.PerIndexStats
  EMPTY

Constructor Summary

Constructors
Constructor and Description

GlobalPerIndexStats(boolean ordered, boolean usesCachedQueryableEntries)
Constructs a new instance of global index stats.

Constructors
Constructor and Description
`GlobalPerIndexStats(boolean ordered, boolean usesCachedQueryableEntries)` Constructs a new instance of global index stats.

Method Summary

All Methods Instance Methods Concrete 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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GlobalPerIndexStats
```
public GlobalPerIndexStats(boolean ordered,
                           boolean usesCachedQueryableEntries)
```
    Constructs a new instance of global index stats.
    
    Parameters:
    
    ordered - true if the stats are being created for an ordered index, false otherwise. Affects the on-heap memory cost calculation.
    
    usesCachedQueryableEntries - true if the stats are being created for an index for which queryable entries are cached, false otherwise. Affects the on-heap memory cost calculation.
- Method Detail
  - makeTimestamp
```
public long makeTimestamp()
```
    Description copied from interface: PerIndexStats
    
    Returns a new timestamp.
    Used for latency measurement, expressed in nanoseconds.
    
    Specified by:
    
    makeTimestamp in interface PerIndexStats
  - getCreationTime
```
public long getCreationTime()
```
    Description copied from interface: PerIndexStats
    
    Returns the creation time of the index.
    The value is relative to midnight, January 1, 1970 UTC and expressed in milliseconds.
    
    Specified by:
    
    getCreationTime in interface PerIndexStats
  - getQueryCount
```
public long getQueryCount()
```
    Description copied from interface: PerIndexStats
    
    Returns the total number of queries served by the index.
    The returned value may be less than the one returned by PerIndexStats.getHitCount() since a single query may hit the same index more than once.
    
    Specified by:
    
    getQueryCount in interface PerIndexStats
  - incrementQueryCount
```
public void incrementQueryCount()
```
    Description copied from interface: PerIndexStats
    
    Increments the query count for the index.
    
    Specified by:
    
    incrementQueryCount in interface PerIndexStats
  - getHitCount
```
public long getHitCount()
```
    Description copied from interface: PerIndexStats
    
    Returns the total number of hits into the index.
    The returned value may be greater than the one returned by PerIndexStats.getQueryCount() since a single query may hit the same index more than once.
    
    Specified by:
    
    getHitCount in interface PerIndexStats
  - getTotalHitLatency
```
public long getTotalHitLatency()
```
    Description copied from interface: PerIndexStats
    
    Returns the total hit latency for the index.
    
    Specified by:
    
    getTotalHitLatency in interface PerIndexStats
  - getTotalNormalizedHitCardinality
```
public double getTotalNormalizedHitCardinality()
```
    Description copied from interface: PerIndexStats
    
    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.
    
    Specified by:
    
    getTotalNormalizedHitCardinality in interface PerIndexStats
  - getInsertCount
```
public long getInsertCount()
```
    Description copied from interface: PerIndexStats
    
    Returns the number of insert operations performed on the index.
    
    Specified by:
    
    getInsertCount in interface PerIndexStats
  - getTotalInsertLatency
```
public long getTotalInsertLatency()
```
    Description copied from interface: PerIndexStats
    
    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.
    
    Specified by:
    
    getTotalInsertLatency in interface PerIndexStats
  - getUpdateCount
```
public long getUpdateCount()
```
    Description copied from interface: PerIndexStats
    
    Returns the number of update operations performed on the index.
    
    Specified by:
    
    getUpdateCount in interface PerIndexStats
  - getTotalUpdateLatency
```
public long getTotalUpdateLatency()
```
    Description copied from interface: PerIndexStats
    
    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.
    
    Specified by:
    
    getTotalUpdateLatency in interface PerIndexStats
  - getRemoveCount
```
public long getRemoveCount()
```
    Description copied from interface: PerIndexStats
    
    Returns the number of remove operations performed on the index.
    
    Specified by:
    
    getRemoveCount in interface PerIndexStats
  - getTotalRemoveLatency
```
public long getTotalRemoveLatency()
```
    Description copied from interface: PerIndexStats
    
    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.
    
    Specified by:
    
    getTotalRemoveLatency in interface PerIndexStats
  - getMemoryCost
```
public long getMemoryCost()
```
    Description copied from interface: PerIndexStats
    
    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.
    
    Specified by:
    
    getMemoryCost in interface PerIndexStats
  - onInsert
```
public void onInsert(long timestamp,
                     IndexOperationStats operationStats,
                     Index.OperationSource operationSource)
```
    Description copied from interface: PerIndexStats
    
    Invoked by the associated index after every insert operation.
    
    Specified by:
    
    onInsert in interface PerIndexStats
    
    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:
    
    PerIndexStats.makeTimestamp(), Index.putEntry(com.hazelcast.query.impl.QueryableEntry, java.lang.Object, com.hazelcast.query.impl.Index.OperationSource)
  - onUpdate
```
public void onUpdate(long timestamp,
                     IndexOperationStats operationStats,
                     Index.OperationSource operationSource)
```
    Description copied from interface: PerIndexStats
    
    Invoked by the associated index after every update operation.
    
    Specified by:
    
    onUpdate in interface PerIndexStats
    
    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:
    
    PerIndexStats.makeTimestamp(), Index.putEntry(com.hazelcast.query.impl.QueryableEntry, java.lang.Object, com.hazelcast.query.impl.Index.OperationSource)
  - onRemove
```
public void onRemove(long timestamp,
                     IndexOperationStats operationStats,
                     Index.OperationSource operationSource)
```
    Description copied from interface: PerIndexStats
    
    Invoked by the associated index after every remove operation.
    
    Specified by:
    
    onRemove in interface PerIndexStats
    
    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:
    
    PerIndexStats.makeTimestamp(), Index.removeEntry(com.hazelcast.nio.serialization.Data, java.lang.Object, com.hazelcast.query.impl.Index.OperationSource)
  - onClear
```
public void onClear()
```
    Description copied from interface: PerIndexStats
    
    Invoked by the associated index after the index was cleared.
    
    Specified by:
    
    onClear in interface PerIndexStats
    
    See Also:
    
    Index.clear()
  - onIndexHit
```
public void onIndexHit(long timestamp,
                       long hitCardinality)
```
    Description copied from interface: PerIndexStats
    Invoked by the associated index after every index hit.
    Following operations generate a hit:
    Specified by:
    
    onIndexHit in interface PerIndexStats
    
    Parameters:
    
    timestamp - the time at which the hit-producing operation was started.
    
    hitCardinality - the cardinality of the hit.
    
    See Also:
    
    PerIndexStats.makeTimestamp()
  - resetPerQueryStats
```
public void resetPerQueryStats()
```
    Description copied from interface: PerIndexStats
    
    Resets the per-query stats, if any, currently tracked by this internal index stats instance.
    
    Specified by:
    
    resetPerQueryStats in interface PerIndexStats
  - wrapMemoryAllocator
```
public MemoryAllocator wrapMemoryAllocator(MemoryAllocator memoryAllocator)
```
    Description copied from interface: PerIndexStats
    
    Wraps the given memory allocator.
    Used for the off-heap memory cost tracking.
    
    Specified by:
    
    wrapMemoryAllocator in interface PerIndexStats
    
    Parameters:
    
    memoryAllocator - the memory allocator to wrap.
    
    Returns:
    
    the wrapped memory allocator.
  - createOperationStats
```
public IndexOperationStats createOperationStats()
```
    Description copied from interface: PerIndexStats
    
    Creates a new per-operation stats instance.
    
    Specified by:
    
    createOperationStats in interface PerIndexStats
    
    Returns:
    
    the created per-operation stats instance.

Class GlobalPerIndexStats

Field Summary

Fields inherited from interface com.hazelcast.monitor.impl.PerIndexStats

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GlobalPerIndexStats

Method Detail

makeTimestamp

getCreationTime

getQueryCount

incrementQueryCount

getHitCount

getTotalHitLatency

getTotalNormalizedHitCardinality

getInsertCount

getTotalInsertLatency

getUpdateCount

getTotalUpdateLatency

getRemoveCount

getTotalRemoveLatency

getMemoryCost

onInsert

onUpdate

onRemove

onClear

onIndexHit

resetPerQueryStats

wrapMemoryAllocator

createOperationStats