Skip to content

Multiserver #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Multiserver #62

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
444b33c
First attempt at supporting multiple Redis servers
Jan 30, 2014
6531b6c
Only using Credis_Cluster when multiple servers are detected. Stickin…
Jan 30, 2014
56e3b43
Using _initRedisConfig instead of _initBackendConfig on line 109
Jan 30, 2014
e80f11d
Removing Mage::log
Jan 30, 2014
75db86e
Finalizing multi-server support by adding regular clustering, master/…
Apr 4, 2014
b59fabf
Adding debug mode and fixing 2 minor bug: $db=>$database and wrapping…
Apr 4, 2014
8da7c16
Removing duplicate line
Apr 4, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
162 changes: 130 additions & 32 deletions Cm/Cache/Backend/Redis.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,39 +90,19 @@ class Cm_Cache_Backend_Redis extends Zend_Cache_Backend implements Zend_Cache_Ba
*/
public function __construct($options = array())
{
if ( empty($options['server']) ) {
Zend_Cache::throwException('Redis \'server\' not specified.');
}

if ( empty($options['port']) && substr($options['server'],0,1) != '/' ) {
Zend_Cache::throwException('Redis \'port\' not specified.');
}

$port = isset($options['port']) ? $options['port'] : NULL;
$timeout = isset($options['timeout']) ? $options['timeout'] : self::DEFAULT_CONNECT_TIMEOUT;
$persistent = isset($options['persistent']) ? $options['persistent'] : '';
$this->_redis = new Credis_Client($options['server'], $port, $timeout, $persistent);

if ( isset($options['force_standalone']) && $options['force_standalone']) {
$this->_redis->forceStandalone();
}

$connectRetries = isset($options['connect_retries']) ? (int)$options['connect_retries'] : self::DEFAULT_CONNECT_RETRIES;
$this->_redis->setMaxConnectRetries($connectRetries);

if ( ! empty($options['read_timeout']) && $options['read_timeout'] > 0) {
$this->_redis->setReadTimeout((float) $options['read_timeout']);
}

if ( ! empty($options['password'])) {
$this->_redis->auth($options['password']) or Zend_Cache::throwException('Unable to authenticate with the redis server.');
}

// Always select database on startup in case persistent connection is re-used by other code
if (empty($options['database'])) {
$options['database'] = 0;
if(isset($options['servers'])) {
if(isset($options['sentinel']) && ($options['sentinel'] || $options['sentinel'] == 'true')){
$this->_initMultiSentinel($options);
} else {
$this->_initRedisCluster($options);
}
} else {
if(isset($options['sentinel']) && ($options['sentinel'] || $options['sentinel'] == 'true')){
$this->_initSentinel($options);
} else {
$this->_initRedisClient($options);
}
}
$this->_redis->select( (int) $options['database']) or Zend_Cache::throwException('The redis database could not be selected.');

if ( isset($options['notMatchingTags']) ) {
$this->_notMatchingTags = (bool) $options['notMatchingTags'];
Expand Down Expand Up @@ -172,6 +152,124 @@ public function __construct($options = array())
}
}

/**
* Initialize Credis_Cluster backend config
* @param array $options
* @return array
*/
protected function _initBackendConfig($options)
{
if ( empty($options['server']) ) {
Zend_Cache::throwException('Redis \'server\' not specified.');
}

if ( empty($options['port']) && substr($options['server'],0,1) != '/' ) {
Zend_Cache::throwException('Redis \'port\' not specified.');
}
$port = isset($options['port']) ? $options['port'] : NULL;
$timeout = isset($options['timeout']) ? $options['timeout'] : self::DEFAULT_CONNECT_TIMEOUT;
$password = isset($options['password']) ? $options['password'] : NULL;
$db = isset($options['database']) ? $options['database'] : 0;
$master = isset($options['master']) && ($options['master'] || $options['master'] == 'true');
$config = array(
'host'=>$options['server'],
'port'=>$port,
'timeout'=> $timeout,
'persistent'=>'',
'database'=>$db,
'password'=>$password,
'master'=>$master
);
return $config;
}
/**
* @param array $options
* @return Cm_Cache_Backend_Redis
*/
protected function _initSentinel($options)
{
$backendConfig = $this->_initBackendConfig($options);
$masterName = isset($options['master_name']) ? $options['master_name'] : 'master';
$selectRandomSlave = isset($options['select_random_slave']) && ($options['select_random_slave'] || $options['select_random_slave'] == 'true');
$readOnMaster = !isset($options['read_on_master']) || ($options['read_on_master'] || $options['read_on_master'] == 'true');
$debug = isset($options['debug']) && ($options['debug'] || $options['debug'] == 'true');
$sentinel = new Credis_Sentinel(new Credis_Client($backendConfig['host'],$backendConfig['port']));
$this->_redis = $sentinel->getCluster($masterName,$selectRandomSlave,$readOnMaster,$debug);
return $this;
}
/**
* @param array $options
* @return Cm_Cache_Backend_Redis
*/
protected function _initMultiSentinel($options)
{
if( !is_array($options['servers']) ) {
Zend_Cache::throwException('Redis \'servers\' config should be an array. Got \''.gettype($options['servers']).'\'');
}
$server = $options['servers'][rand(0,count($options['servers'])-1)];
$options['host'] = $server['host'];
$options['port'] = $server['port'];
return $this->_initSentinel($options);
}
/**
* @param array $options
* @return Cm_Cache_Backend_Redis
*/
protected function _initRedisClient($options)
{
$backendConfig = $this->_initBackendConfig($options);
$persistent = isset($options['persistent']) ? $options['persistent'] : '';
$this->_redis = new Credis_Client(
$backendConfig['host'],
$backendConfig['port'],
$backendConfig['timeout'],
$persistent,
$backendConfig['database'],
$backendConfig['password']
);
$this->_initRedisConfig($this->_redis, $options);
return $this;
}
/**
* @param array $options
* @return Cm_Cache_Backend_Redis
*/
protected function _initRedisCluster($options)
{
if( !is_array($options['servers']) ) {
Zend_Cache::throwException('Redis \'servers\' config should be an array. Got \''.gettype($options['servers']).'\'');
}
$servers = array();
foreach( $options['servers'] as $server) {
$servers[] = $this->_initBackendConfig($server);
}
$replicas = isset($options['replicas'])?(int)$options['replicas']:128;
$readOnMaster = !isset($options['read_on_master']) || ($options['read_on_master'] || $options['read_on_master'] == 'true');
$debug = isset($options['debug']) && ($options['debug'] || $options['debug'] == 'true');
$this->_redis = new Credis_Cluster($servers, $replicas, $readOnMaster, $debug);
foreach($this->_redis->clients() as $client) {
$this->_initRedisConfig($client,$options['servers']);
}
return $this;
}
/**
* Configure Credis_Client options
* @param Credis_Client $redis
* @param array $options
*/
protected function _initRedisConfig(\Credis_Client $redis, $options)
{
if ( isset($options['force_standalone']) && $options['force_standalone']) {
$redis->forceStandalone();
}

$connectRetries = isset($options['connect_retries']) ? (int)$options['connect_retries'] : self::DEFAULT_CONNECT_RETRIES;
$redis->setMaxConnectRetries($connectRetries);

if ( ! empty($options['read_timeout']) && $options['read_timeout'] > 0) {
$redis->setReadTimeout((float) $options['read_timeout']);
}
}
/**
* Load value with given id from cache
*
Expand Down