org.ehcache.core.spi.service

Interface StatisticsService

All Superinterfaces:

Service

public interface StatisticsService
extends Service

Service providing raw statistics for cache and tier usage.

Method Summary

Modifier and Type	Method and Description
void	cleanForNode(java.lang.Object node) Clears all associations
<T extends java.lang.Enum<T>> OperationObserver<T>	createOperationStatistics(java.lang.String name, java.lang.Class<T> outcome, java.lang.String tag, java.lang.Object context) Create operation statistic for provided type
void	deRegisterFromParent(java.lang.Object toDeassociate, java.lang.Object parent) De-registers object from the parent
CacheStatistics	getCacheStatistics(java.lang.String cacheName) Return the object containing the statistics for a given cache name.
<T extends java.io.Serializable> void	registerStatistic(java.lang.Object context, java.lang.String name, StatisticType type, java.util.Set<java.lang.String> tags, java.util.function.Supplier<T> valueSupplier) Register statistics with value supplier
<K,V,S extends java.lang.Enum<S>,T extends java.lang.Enum<T>> OperationStatistic<T>	registerStoreStatistics(Store<K,V> store, java.lang.String targetName, int tierHeight, java.lang.String tag, java.util.Map<T,java.util.Set<S>> translation, java.lang.String statisticName) Registers store of the cache for statistics
void	registerWithParent(java.lang.Object toAssociate, java.lang.Object parent) Registers the object to parent

Methods inherited from interface org.ehcache.spi.service.Service

start, stop

Method Detail

getCacheStatistics

CacheStatistics getCacheStatistics(java.lang.String cacheName)

Return the object containing the statistics for a given cache name.

Parameters:

cacheName - name (alias) of the cache

Returns:

all the cache statistics

registerWithParent

void registerWithParent(java.lang.Object toAssociate,
                        java.lang.Object parent)

Registers the object to parent

Parameters:

toAssociate - object to associate

parent - to which object is associated

registerStoreStatistics

<K,V,S extends java.lang.Enum<S>,T extends java.lang.Enum<T>> OperationStatistic<T> registerStoreStatistics(Store<K,V> store,
                                                                                                            java.lang.String targetName,
                                                                                                            int tierHeight,
                                                                                                            java.lang.String tag,
                                                                                                            java.util.Map<T,java.util.Set<S>> translation,
                                                                                                            java.lang.String statisticName)

Registers store of the cache for statistics

Parameters:

store - Store of the cache to be registered

targetName - statistics name after translation

tierHeight - of the store

tag - with which the statistics is associated

translation - relationship among maintained statistics

statisticName - name of the statistic

Returns:

statistics for the store

deRegisterFromParent

void deRegisterFromParent(java.lang.Object toDeassociate,
                          java.lang.Object parent)

De-registers object from the parent

Parameters:

toDeassociate - object to dissociate

parent - to which object is associated

cleanForNode

void cleanForNode(java.lang.Object node)

Clears all associations

Parameters:

node - for which all associations are cleared

registerStatistic

<T extends java.io.Serializable> void registerStatistic(java.lang.Object context,
                                                        java.lang.String name,
                                                        StatisticType type,
                                                        java.util.Set<java.lang.String> tags,
                                                        java.util.function.Supplier<T> valueSupplier)

Register statistics with value supplier

Type Parameters:

T - the generic type

Parameters:

context - association object

name - of the statistics

type - StatisticType to be registered

tags - with which the statistics is associated

valueSupplier - supplies the value to maintain statistics

createOperationStatistics

<T extends java.lang.Enum<T>> OperationObserver<T> createOperationStatistics(java.lang.String name,
                                                                             java.lang.Class<T> outcome,
                                                                             java.lang.String tag,
                                                                             java.lang.Object context)

Create operation statistic for provided type

Parameters:

name - of the operation observer

outcome - Class of the type of statistic

tag - with which the statistics is associated

context - association object

Returns:

the observer for the provided statistics