RedisSentinel
class RedisSentinel (View source)
Helper autocomplete for phpredis extension
Methods
Creates a Redis Sentinel
Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover. This command should be used in monitoring systems to check if a Sentinel deployment is ok.
Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels (however a new version of the configuration will be published so that the other Sentinels will update their configurations).
Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
Return the ip and port number of the master with that name. If a failover is in progress or terminated successfully for this master it returns the address and port of the promoted replica.
Return the state and info of the specified master
Return a list of monitored masters and their state
Ping the sentinel
Reset all the masters with matching name. The pattern argument is a glob-style pattern.
Return a list of sentinel instances for this master, and their state
Return a list of sentinel instances for this master, and their state
Details
__construct(array $options)
Creates a Redis Sentinel
Accepts and array of options.
Available options:
- 'host' => string, Sentinel IP address or hostname
- 'port' => int, Sentinel Port (optional, default is 26379)
- 'connectTimeout' => float, Value in seconds (optional, default is 0 meaning unlimited)
- 'persistent' => string, Persistent connection id (optional, default is NULL meaning not persistent)
- 'retryInterval' => int, Value in milliseconds (optional, default is 0)
- 'readTimeout' => float, Value in seconds (optional, default is 0 meaning unlimited)
- 'auth' => string|array, Authentication credentials (optional, default is NULL meaning NOAUTH)
bool
ckquorum(string $master)
Check if the current Sentinel configuration is able to reach the quorum needed to failover a master, and the majority needed to authorize the failover. This command should be used in monitoring systems to check if a Sentinel deployment is ok.
bool
failover(string $master)
Force a failover as if the master was not reachable, and without asking for agreement to other Sentinels (however a new version of the configuration will be published so that the other Sentinels will update their configurations).
bool
flushconfig()
Force Sentinel to rewrite its configuration on disk, including the current Sentinel state.
Normally Sentinel rewrites the configuration every time something changes in its state (in the context of the subset of the state which is persisted on disk across restart). However sometimes it is possible that the configuration file is lost because of operation errors, disk failures, package upgrade scripts or configuration managers. In those cases a way to to force Sentinel to rewrite the configuration file is handy.
This command works even if the previous configuration file is completely missing.
getMasterAddrByName(string $master)
Return the ip and port number of the master with that name. If a failover is in progress or terminated successfully for this master it returns the address and port of the promoted replica.
master(string $master)
Return the state and info of the specified master
masters()
Return a list of monitored masters and their state
bool
ping()
Ping the sentinel
bool
reset(string $pattern)
Reset all the masters with matching name. The pattern argument is a glob-style pattern.
The reset process clears any previous state in a master (including a failover in progress), and removes every replica and sentinel already discovered and associated with the master.
sentinels(string $master)
Return a list of sentinel instances for this master, and their state
slaves(string $master)
Return a list of sentinel instances for this master, and their state