ehcache

net.sf.ehcache.statistics.extended
Interface ExtendedStatistics

All Known Implementing Classes:
ExtendedStatisticsImpl

public interface ExtendedStatistics

The ExtendedStatistics interface.

Author:
cschanck

Nested Class Summary
static interface ExtendedStatistics.Latency
          The Latency interface.
static interface ExtendedStatistics.Operation<T extends Enum<T>>
          The Interface Operation.
static interface ExtendedStatistics.Result
          The Interface Result.
static interface ExtendedStatistics.Statistic<T extends Number>
          The Interface Statistic.
 
Field Summary
static Set<CacheOperationOutcomes.GetOutcome> ALL_CACHE_GET_OUTCOMES
          The Constant ALL_CACHE_GET_OUTCOMES.
static Set<CacheOperationOutcomes.GetOutcome> ALL_CACHE_MISS_OUTCOMES
          The Constant ALL_CACHE_MISS_OUTCOMES.
static Set<CacheOperationOutcomes.PutOutcome> ALL_CACHE_PUT_OUTCOMES
          The Constant ALL_CACHE_PUT_OUTCOMES.
static Set<StoreOperationOutcomes.PutOutcome> ALL_STORE_PUT_OUTCOMES
          The Constant ALL_STORE_PUT_OUTCOMES.
 
Method Summary
 ExtendedStatistics.Result allGet()
          All get.
 ExtendedStatistics.Result allMiss()
          All miss.
 ExtendedStatistics.Result allPut()
          All put.
 ExtendedStatistics.Statistic<Double> cacheHitRatio()
          Cache hit ratio.
 ExtendedStatistics.Operation<CacheOperationOutcomes.ClusterEventOutcomes> clusterEvent()
          Cluster events
 ExtendedStatistics.Result diskAllPut()
          Disk all put.
 ExtendedStatistics.Operation<StoreOperationOutcomes.GetOutcome> diskGet()
          Disk get.
 ExtendedStatistics.Operation<StoreOperationOutcomes.PutOutcome> diskPut()
          Disk put.
 ExtendedStatistics.Operation<StoreOperationOutcomes.RemoveOutcome> diskRemove()
          Disk remove.
 ExtendedStatistics.Operation<CacheOperationOutcomes.EvictionOutcome> eviction()
          Eviction.
 ExtendedStatistics.Operation<CacheOperationOutcomes.ExpiredOutcome> expiry()
          Expiry.
 ExtendedStatistics.Operation<CacheOperationOutcomes.GetOutcome> get()
          Gets the.
 ExtendedStatistics.Result heapAllPut()
          Heap all put.
 ExtendedStatistics.Operation<StoreOperationOutcomes.GetOutcome> heapGet()
          Heap get.
 ExtendedStatistics.Operation<StoreOperationOutcomes.PutOutcome> heapPut()
          Heap put.
 ExtendedStatistics.Operation<StoreOperationOutcomes.RemoveOutcome> heapRemove()
          Heap remove.
 ExtendedStatistics.Statistic<Number> localDiskSize()
          Gets the local disk size.
 ExtendedStatistics.Statistic<Number> localDiskSizeInBytes()
          Gets the local disk size in bytes.
 ExtendedStatistics.Statistic<Number> localHeapSize()
          Gets the local heap size.
 ExtendedStatistics.Statistic<Number> localHeapSizeInBytes()
          Gets the local heap size in bytes.
 ExtendedStatistics.Statistic<Number> localOffHeapSize()
          Gets the local off heap size.
 ExtendedStatistics.Statistic<Number> localOffHeapSizeInBytes()
          Gets the local off heap size in bytes.
 ExtendedStatistics.Statistic<Number> mostRecentRejoinTimeStampMillis()
          Get the timestamp (millis) of the last cluster rejoin event
 ExtendedStatistics.Operation<CacheOperationOutcomes.NonStopOperationOutcomes> nonstop()
          Nonstop events
 ExtendedStatistics.Statistic<Double> nonstopTimeoutRatio()
          Nonstop timeout ratio
 ExtendedStatistics.Result offHeapAllPut()
          Off heap all put.
 ExtendedStatistics.Operation<StoreOperationOutcomes.GetOutcome> offheapGet()
          Offheap get.
 ExtendedStatistics.Operation<StoreOperationOutcomes.PutOutcome> offheapPut()
          Offheap put.
 ExtendedStatistics.Operation<StoreOperationOutcomes.RemoveOutcome> offheapRemove()
          Offheap remove.
<T extends Enum<T>>
Set<ExtendedStatistics.Operation<T>>
operations(Class<T> outcome, String name, String... tags)
          Operations.
 Set<ExtendedStatistics.Statistic<Number>> passthru(String name, Set<String> tags)
          Get the set of cache specific pass thru statistics for a nam/tags pair.
 ExtendedStatistics.Operation<CacheOperationOutcomes.PutOutcome> put()
          Put.
 ExtendedStatistics.Operation<CacheOperationOutcomes.PutIfAbsentOutcome> putIfAbsent()
          put if absent operation
 ExtendedStatistics.Statistic<Number> remoteSize()
          Gets the remote size.
 ExtendedStatistics.Operation<CacheOperationOutcomes.RemoveOutcome> remove()
          Removes the.
 ExtendedStatistics.Operation<CacheOperationOutcomes.RemoveElementOutcome> removeElement()
          remove element operation
 ExtendedStatistics.Operation<CacheOperationOutcomes.ReplaceOneArgOutcome> replaceOneArg()
          single arg replace operation
 ExtendedStatistics.Operation<CacheOperationOutcomes.ReplaceTwoArgOutcome> replaceTwoArg()
          two arg replace operation
 ExtendedStatistics.Operation<CacheOperationOutcomes.SearchOutcome> search()
          Search.
 void setAlwaysOn(boolean alwaysOn)
          Sets the always on.
 void setTimeToDisable(long time, TimeUnit unit)
          Sets the time to disable.
 ExtendedStatistics.Statistic<Number> size()
          Gets the size.
 ExtendedStatistics.Statistic<Number> writerQueueLength()
          Gets the writer queue length.
 ExtendedStatistics.Operation<XaCommitOutcome> xaCommit()
          Xa commit.
 ExtendedStatistics.Operation<XaRecoveryOutcome> xaRecovery()
          Xa recovery.
 ExtendedStatistics.Operation<XaRollbackOutcome> xaRollback()
          Xa rollback.
 

Field Detail

ALL_CACHE_PUT_OUTCOMES

static final Set<CacheOperationOutcomes.PutOutcome> ALL_CACHE_PUT_OUTCOMES
The Constant ALL_CACHE_PUT_OUTCOMES.


ALL_CACHE_GET_OUTCOMES

static final Set<CacheOperationOutcomes.GetOutcome> ALL_CACHE_GET_OUTCOMES
The Constant ALL_CACHE_GET_OUTCOMES.


ALL_CACHE_MISS_OUTCOMES

static final Set<CacheOperationOutcomes.GetOutcome> ALL_CACHE_MISS_OUTCOMES
The Constant ALL_CACHE_MISS_OUTCOMES.


ALL_STORE_PUT_OUTCOMES

static final Set<StoreOperationOutcomes.PutOutcome> ALL_STORE_PUT_OUTCOMES
The Constant ALL_STORE_PUT_OUTCOMES.

Method Detail

setTimeToDisable

void setTimeToDisable(long time,
                      TimeUnit unit)
Sets the time to disable.

Parameters:
time - the time
unit - the unit

setAlwaysOn

void setAlwaysOn(boolean alwaysOn)
Sets the always on.

Parameters:
alwaysOn - the new always on

get

ExtendedStatistics.Operation<CacheOperationOutcomes.GetOutcome> get()
Gets the.

Returns:
the operation

put

ExtendedStatistics.Operation<CacheOperationOutcomes.PutOutcome> put()
Put.

Returns:
the operation

remove

ExtendedStatistics.Operation<CacheOperationOutcomes.RemoveOutcome> remove()
Removes the.

Returns:
the operation

replaceOneArg

ExtendedStatistics.Operation<CacheOperationOutcomes.ReplaceOneArgOutcome> replaceOneArg()
single arg replace operation

Returns:

replaceTwoArg

ExtendedStatistics.Operation<CacheOperationOutcomes.ReplaceTwoArgOutcome> replaceTwoArg()
two arg replace operation

Returns:

putIfAbsent

ExtendedStatistics.Operation<CacheOperationOutcomes.PutIfAbsentOutcome> putIfAbsent()
put if absent operation

Returns:

removeElement

ExtendedStatistics.Operation<CacheOperationOutcomes.RemoveElementOutcome> removeElement()
remove element operation

Returns:

heapGet

ExtendedStatistics.Operation<StoreOperationOutcomes.GetOutcome> heapGet()
Heap get.

Returns:
the operation

offheapGet

ExtendedStatistics.Operation<StoreOperationOutcomes.GetOutcome> offheapGet()
Offheap get.

Returns:
the operation

diskGet

ExtendedStatistics.Operation<StoreOperationOutcomes.GetOutcome> diskGet()
Disk get.

Returns:
the operation

heapPut

ExtendedStatistics.Operation<StoreOperationOutcomes.PutOutcome> heapPut()
Heap put.

Returns:
the operation

offheapPut

ExtendedStatistics.Operation<StoreOperationOutcomes.PutOutcome> offheapPut()
Offheap put.

Returns:
the operation

diskPut

ExtendedStatistics.Operation<StoreOperationOutcomes.PutOutcome> diskPut()
Disk put.

Returns:
the operation

heapRemove

ExtendedStatistics.Operation<StoreOperationOutcomes.RemoveOutcome> heapRemove()
Heap remove.

Returns:
the operation

offheapRemove

ExtendedStatistics.Operation<StoreOperationOutcomes.RemoveOutcome> offheapRemove()
Offheap remove.

Returns:
the operation

diskRemove

ExtendedStatistics.Operation<StoreOperationOutcomes.RemoveOutcome> diskRemove()
Disk remove.

Returns:
the operation

search

ExtendedStatistics.Operation<CacheOperationOutcomes.SearchOutcome> search()
Search.

Returns:
the operation

xaCommit

ExtendedStatistics.Operation<XaCommitOutcome> xaCommit()
Xa commit.

Returns:
the operation

xaRollback

ExtendedStatistics.Operation<XaRollbackOutcome> xaRollback()
Xa rollback.

Returns:
the operation

xaRecovery

ExtendedStatistics.Operation<XaRecoveryOutcome> xaRecovery()
Xa recovery.

Returns:
the operation

eviction

ExtendedStatistics.Operation<CacheOperationOutcomes.EvictionOutcome> eviction()
Eviction.

Returns:
the operation

expiry

ExtendedStatistics.Operation<CacheOperationOutcomes.ExpiredOutcome> expiry()
Expiry.

Returns:
the operation

clusterEvent

ExtendedStatistics.Operation<CacheOperationOutcomes.ClusterEventOutcomes> clusterEvent()
Cluster events

Returns:
the operation

nonstop

ExtendedStatistics.Operation<CacheOperationOutcomes.NonStopOperationOutcomes> nonstop()
Nonstop events

Returns:
the operation

allGet

ExtendedStatistics.Result allGet()
All get.

Returns:
the result

allMiss

ExtendedStatistics.Result allMiss()
All miss.

Returns:
the result

allPut

ExtendedStatistics.Result allPut()
All put.

Returns:
the result

heapAllPut

ExtendedStatistics.Result heapAllPut()
Heap all put.

Returns:
the result

offHeapAllPut

ExtendedStatistics.Result offHeapAllPut()
Off heap all put.

Returns:
the result

diskAllPut

ExtendedStatistics.Result diskAllPut()
Disk all put.

Returns:
the result

cacheHitRatio

ExtendedStatistics.Statistic<Double> cacheHitRatio()
Cache hit ratio.

Returns:

nonstopTimeoutRatio

ExtendedStatistics.Statistic<Double> nonstopTimeoutRatio()
Nonstop timeout ratio

Returns:

operations

<T extends Enum<T>> Set<ExtendedStatistics.Operation<T>> operations(Class<T> outcome,
                                                                    String name,
                                                                    String... tags)
Operations.

Type Parameters:
T - the generic type
Parameters:
outcome - the outcome
name - the name
tags - the tags
Returns:
the sets the

passthru

Set<ExtendedStatistics.Statistic<Number>> passthru(String name,
                                                   Set<String> tags)
Get the set of cache specific pass thru statistics for a nam/tags pair. Used for custom pass thru statistics, as opposed to well known standard ones.

Parameters:
name - name
tags - set of tags
Returns:

size

ExtendedStatistics.Statistic<Number> size()
Gets the size.

Returns:
the size

localHeapSize

ExtendedStatistics.Statistic<Number> localHeapSize()
Gets the local heap size.

Returns:
the local heap size

localHeapSizeInBytes

ExtendedStatistics.Statistic<Number> localHeapSizeInBytes()
Gets the local heap size in bytes.

Returns:
the local heap size in bytes

localOffHeapSize

ExtendedStatistics.Statistic<Number> localOffHeapSize()
Gets the local off heap size.

Returns:
the local off heap size

localOffHeapSizeInBytes

ExtendedStatistics.Statistic<Number> localOffHeapSizeInBytes()
Gets the local off heap size in bytes.

Returns:
the local off heap size in bytes

localDiskSize

ExtendedStatistics.Statistic<Number> localDiskSize()
Gets the local disk size.

Returns:
the local disk size

localDiskSizeInBytes

ExtendedStatistics.Statistic<Number> localDiskSizeInBytes()
Gets the local disk size in bytes.

Returns:
the local disk size in bytes

remoteSize

ExtendedStatistics.Statistic<Number> remoteSize()
Gets the remote size.

Returns:
the remote size

writerQueueLength

ExtendedStatistics.Statistic<Number> writerQueueLength()
Gets the writer queue length.

Returns:
the writer queue length

mostRecentRejoinTimeStampMillis

ExtendedStatistics.Statistic<Number> mostRecentRejoinTimeStampMillis()
Get the timestamp (millis) of the last cluster rejoin event

Returns:
statistic for cluster rejoin timestamp

ehcache

Copyright 2001-2015, Terracotta, Inc.