* @ingroup Cache
*/
+use Liuggio\StatsdClient\Factory\StatsdDataFactoryInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
protected $purgeRelayer;
/** @var LoggerInterface */
protected $logger;
+ /** @var StatsdDataFactoryInterface */
+ protected $stats;
/** @var int ERR_* constant for the "last error" registry */
protected $lastRelayError = self::ERR_NONE;
* - channels : Map of (action => channel string). Actions include "purge".
* - relayers : Map of (action => EventRelayer object). Actions include "purge".
* - logger : LoggerInterface object
+ * - stats : LoggerInterface object
*/
public function __construct( array $params ) {
$this->cache = $params['cache'];
? $params['relayers']['purge']
: new EventRelayerNull( [] );
$this->setLogger( isset( $params['logger'] ) ? $params['logger'] : new NullLogger() );
+ $this->stats = isset( $params['stats'] ) ? $params['stats'] : new NullStatsdDataFactory();
}
public function setLogger( LoggerInterface $logger ) {
* Consider using getWithSetCallback() instead of get() and set() cycles.
* That method has cache slam avoiding features for hot/expensive keys.
*
- * @param string $key Cache key
+ * @param string $key Cache key made from makeKey() or makeGlobalKey()
* @param mixed &$curTTL Approximate TTL left on the key if present/tombstoned [returned]
* @param array $checkKeys List of "check" keys
* @param float &$asOf UNIX timestamp of cached value; null on failure [returned]
*
* @see WANObjectCache::get()
*
- * @param array $keys List of cache keys
+ * @param array $keys List of cache keys made from makeKey() or makeGlobalKey()
* @param array &$curTTLs Map of (key => approximate TTL left) for existing keys [returned]
* @param array $checkKeys List of check keys to apply to all $keys. May also apply "check"
* keys to specific cache keys only by using cache keys as keys in the $checkKeys array.
* @see WANObjectCache::get()
* @see WANObjectCache::set()
*
- * @param string $key Cache key
+ * @param string $key Cache key made from makeKey() or makeGlobalKey()
* @param int $ttl Seconds to live for key updates. Special values are:
* - WANObjectCache::TTL_INDEFINITE: Cache forever
* - WANObjectCache::TTL_UNCACHEABLE: Do not cache at all
$minTime = isset( $opts['minAsOf'] ) ? $opts['minAsOf'] : self::MIN_TIMESTAMP_NONE;
$versioned = isset( $opts['version'] );
+ // Get a collection name to describe this class of key
+ $kClass = $this->determineKeyClass( $key );
+
// Get the current key value
$curTTL = null;
$cValue = $this->get( $key, $curTTL, $checkKeys, $asOf ); // current value
&& !$this->worthRefreshExpiring( $curTTL, $lowTTL )
&& !$this->worthRefreshPopular( $asOf, $ageNew, $popWindow, $preCallbackTime )
) {
+ $this->stats->increment( "wanobjectcache.$kClass.hit.good" );
+
return $value;
}
// Lock acquired; this thread should update the key
$lockAcquired = true;
} elseif ( $value !== false && $this->isValid( $value, $versioned, $asOf, $minTime ) ) {
+ $this->stats->increment( "wanobjectcache.$kClass.hit.stale" );
// If it cannot be acquired; then the stale value can be used
return $value;
} else {
// use the INTERIM value from the last thread that regenerated it.
$value = $this->getInterimValue( $key, $versioned, $minTime, $asOf );
if ( $value !== false ) {
+ $this->stats->increment( "wanobjectcache.$kClass.hit.volatile" );
+
return $value;
}
// Use the busy fallback value if nothing else
if ( $busyValue !== null ) {
+ $this->stats->increment( "wanobjectcache.$kClass.miss.busy" );
+
return is_callable( $busyValue ) ? $busyValue() : $busyValue;
}
}
$this->cache->changeTTL( self::MUTEX_KEY_PREFIX . $key, (int)$preCallbackTime - 60 );
}
+ $this->stats->increment( "wanobjectcache.$kClass.miss.compute" );
+
return $value;
}
return $res;
}
+ /**
+ * @param string $key String of the format <scope>:<class>[:<class or variable>]...
+ * @return string
+ */
+ protected function determineKeyClass( $key ) {
+ $parts = explode( ':', $key );
+
+ return isset( $parts[1] ) ? $parts[1] : $parts[0]; // sanity
+ }
+
/**
* @param string $value Wrapped value like "PURGED:<timestamp>:<holdoff>"
* @return array|bool Array containing a UNIX timestamp (float) and holdoff period (integer),
$this->assertSame( 'special', $wanCache->makeGlobalKey( 'a', 'b' ) );
}
+
+ public static function statsKeyProvider() {
+ return [
+ [ 'domain:page:5', 'page' ],
+ [ 'domain:main-key', 'main-key' ],
+ [ 'domain:page:history', 'page' ],
+ [ 'missingdomainkey', 'missingdomainkey' ]
+ ];
+ }
+
+ /**
+ * @dataProvider statsKeyProvider
+ * @covers WANObjectCache::determineKeyClass
+ */
+ public function testStatsKeyClass( $key, $class ) {
+ $wanCache = TestingAccessWrapper::newFromObject( new WANObjectCache( [
+ 'cache' => new HashBagOStuff,
+ 'pool' => 'testcache-hash',
+ 'relayer' => new EventRelayerNull( [] )
+ ] ) );
+
+ $this->assertEquals( $class, $wanCache->determineKeyClass( $key ) );
+ }
}