StatisticsCacheLogger
in package
implements
CacheLogger
Provide basic second level cache statistics.
Interfaces, Classes, Traits and Enums
- CacheLogger
- Interface for logging.
Table of Contents
- $cacheHitCountMap : array<string|int, int>
- $cacheMissCountMap : array<string|int, int>
- $cachePutCountMap : array<string|int, int>
- clearRegionStats() : void
- Clear region statistics
- clearStats() : void
- Clear all statistics
- collectionCacheHit() : mixed
- Log an entity get from second level cache resulted in a hit.
- collectionCacheMiss() : mixed
- Log an entity get from second level cache resulted in a miss.
- collectionCachePut() : mixed
- Log an entity put into second level cache.
- entityCacheHit() : mixed
- Log an entity get from second level cache resulted in a hit.
- entityCacheMiss() : mixed
- Log an entity get from second level cache resulted in a miss.
- entityCachePut() : mixed
- Log an entity put into second level cache.
- getHitCount() : int
- Get the total number of entries successfully retrieved from cache.
- getMissCount() : int
- Get the total number of cached entries *not* found in cache.
- getPutCount() : int
- Get the total number of put in cache.
- getRegionHitCount() : int
- Get the number of entries successfully retrieved from cache.
- getRegionMissCount() : int
- Get the number of cached entries *not* found in cache.
- getRegionPutCount() : int
- Get the number of cacheable entries put in cache.
- getRegionsHit() : array<string, int>
- getRegionsMiss() : array<string, int>
- getRegionsPut() : array<string, int>
- queryCacheHit() : mixed
- Log a query get from the query cache resulted in a hit.
- queryCacheMiss() : mixed
- Log a query get from the query cache resulted in a miss.
- queryCachePut() : mixed
- Log a query put into the query cache.
Properties
$cacheHitCountMap
private
array<string|int, int>
$cacheHitCountMap
= []
$cacheMissCountMap
private
array<string|int, int>
$cacheMissCountMap
= []
$cachePutCountMap
private
array<string|int, int>
$cachePutCountMap
= []
Methods
clearRegionStats()
Clear region statistics
public
clearRegionStats(string $regionName) : void
Parameters
- $regionName : string
-
The name of the cache region.
Return values
void —clearStats()
Clear all statistics
public
clearStats() : void
Return values
void —collectionCacheHit()
Log an entity get from second level cache resulted in a hit.
public
collectionCacheHit(mixed $regionName, CollectionCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : CollectionCacheKey
-
The cache key of the collection.
Return values
mixed —collectionCacheMiss()
Log an entity get from second level cache resulted in a miss.
public
collectionCacheMiss(mixed $regionName, CollectionCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : CollectionCacheKey
-
The cache key of the collection.
Return values
mixed —collectionCachePut()
Log an entity put into second level cache.
public
collectionCachePut(mixed $regionName, CollectionCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : CollectionCacheKey
-
The cache key of the collection.
Return values
mixed —entityCacheHit()
Log an entity get from second level cache resulted in a hit.
public
entityCacheHit(mixed $regionName, EntityCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : EntityCacheKey
-
The cache key of the entity.
Return values
mixed —entityCacheMiss()
Log an entity get from second level cache resulted in a miss.
public
entityCacheMiss(mixed $regionName, EntityCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : EntityCacheKey
-
The cache key of the entity.
Return values
mixed —entityCachePut()
Log an entity put into second level cache.
public
entityCachePut(mixed $regionName, EntityCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : EntityCacheKey
-
The cache key of the entity.
Return values
mixed —getHitCount()
Get the total number of entries successfully retrieved from cache.
public
getHitCount() : int
Return values
int —getMissCount()
Get the total number of cached entries *not* found in cache.
public
getMissCount() : int
Return values
int —getPutCount()
Get the total number of put in cache.
public
getPutCount() : int
Return values
int —getRegionHitCount()
Get the number of entries successfully retrieved from cache.
public
getRegionHitCount(string $regionName) : int
Parameters
- $regionName : string
-
The name of the cache region.
Return values
int —getRegionMissCount()
Get the number of cached entries *not* found in cache.
public
getRegionMissCount(string $regionName) : int
Parameters
- $regionName : string
-
The name of the cache region.
Return values
int —getRegionPutCount()
Get the number of cacheable entries put in cache.
public
getRegionPutCount(string $regionName) : int
Parameters
- $regionName : string
-
The name of the cache region.
Return values
int —getRegionsHit()
public
getRegionsHit() : array<string, int>
Return values
array<string, int> —getRegionsMiss()
public
getRegionsMiss() : array<string, int>
Return values
array<string, int> —getRegionsPut()
public
getRegionsPut() : array<string, int>
Return values
array<string, int> —queryCacheHit()
Log a query get from the query cache resulted in a hit.
public
queryCacheHit(mixed $regionName, QueryCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : QueryCacheKey
-
The cache key of the query.
Return values
mixed —queryCacheMiss()
Log a query get from the query cache resulted in a miss.
public
queryCacheMiss(mixed $regionName, QueryCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : QueryCacheKey
-
The cache key of the query.
Return values
mixed —queryCachePut()
Log a query put into the query cache.
public
queryCachePut(mixed $regionName, QueryCacheKey $key) : mixed
Parameters
- $regionName : mixed
-
The name of the cache region.
- $key : QueryCacheKey
-
The cache key of the query.