Documentation

StatisticsCacheLogger
in package
implements CacheLogger

Provide basic second level cache statistics.

Table of Contents

Interfaces

CacheLogger
Interface for logging.

Properties

$cacheHitCountMap  : array<string, int>
$cacheMissCountMap  : array<string, int>
$cachePutCountMap  : array<string, int>

Methods

clearRegionStats()  : void
Clear region statistics
clearStats()  : void
Clear all statistics
collectionCacheHit()  : void
Log an entity get from second level cache resulted in a hit.
collectionCacheMiss()  : void
Log an entity get from second level cache resulted in a miss.
collectionCachePut()  : void
Log an entity put into second level cache.
entityCacheHit()  : void
Log an entity get from second level cache resulted in a hit.
entityCacheMiss()  : void
Log an entity get from second level cache resulted in a miss.
entityCachePut()  : void
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()  : void
Log a query get from the query cache resulted in a hit.
queryCacheMiss()  : void
Log a query get from the query cache resulted in a miss.
queryCachePut()  : void
Log a query put into the query cache.

Properties

Methods

clearRegionStats()

Clear region statistics

public clearRegionStats(string $regionName) : void
Parameters
$regionName : string

The name of the cache region.

collectionCacheHit()

Log an entity get from second level cache resulted in a hit.

public collectionCacheHit(mixed $regionName, CollectionCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : CollectionCacheKey

The cache key of the collection.

collectionCacheMiss()

Log an entity get from second level cache resulted in a miss.

public collectionCacheMiss(mixed $regionName, CollectionCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : CollectionCacheKey

The cache key of the collection.

entityCacheHit()

Log an entity get from second level cache resulted in a hit.

public entityCacheHit(mixed $regionName, EntityCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : EntityCacheKey

The cache key of the entity.

entityCacheMiss()

Log an entity get from second level cache resulted in a miss.

public entityCacheMiss(mixed $regionName, EntityCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : EntityCacheKey

The cache key of the entity.

entityCachePut()

Log an entity put into second level cache.

public entityCachePut(mixed $regionName, EntityCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : EntityCacheKey

The cache key of the entity.

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) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : QueryCacheKey

The cache key of the query.

queryCacheMiss()

Log a query get from the query cache resulted in a miss.

public queryCacheMiss(mixed $regionName, QueryCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : QueryCacheKey

The cache key of the query.

queryCachePut()

Log a query put into the query cache.

public queryCachePut(mixed $regionName, QueryCacheKey $key) : void
Parameters
$regionName : mixed

The name of the cache region.

$key : QueryCacheKey

The cache key of the query.


        
On this page

Search results