new RedisSentinel()
Interface for sentinel commands
- Source:
Methods
ckquorum(name, handler) → {RedisSentinel}
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.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | master name |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
close(handler)
Close the client - when it is fully closed the handler will be called.
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function |
- Source:
failover(name, handler) → {RedisSentinel}
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)
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | master name |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
flushConfig(handler) → {RedisSentinel}
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.
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
getMasterAddrByName(name, handler) → {RedisSentinel}
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 slave
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | master name |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
master(name, handler) → {RedisSentinel}
Show the state and info of the specified master
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | master name |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
masters(handler) → {RedisSentinel}
Show a list of monitored masters and their state
Parameters:
| Name | Type | Description |
|---|---|---|
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
reset(pattern, handler) → {RedisSentinel}
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 pro
Parameters:
| Name | Type | Description |
|---|---|---|
pattern |
string | pattern String |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
sentinels(name, handler) → {RedisSentinel}
Show a list of sentinel instances for this master, and their state
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | master name |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel
slaves(name, handler) → {RedisSentinel}
Show a list of slaves for this master, and their state
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string | master name |
handler |
function | Handler for the result of this call |
- Source:
Returns:
- Type
- RedisSentinel