RedisServerWrapper.Sentinel (redis_server_wrapper v0.7.4)

Copy Markdown View Source

GenServer managing a Redis Sentinel topology: master + replicas + sentinel processes.

Usage

{:ok, pid} = RedisServerWrapper.Sentinel.start_link(
  master_port: 6390,
  replicas: 2,
  sentinels: 3
)

RedisServerWrapper.Sentinel.healthy?(pid)
RedisServerWrapper.Sentinel.master_addr(pid)
RedisServerWrapper.Sentinel.stop(pid)

Options

  • :master_name - sentinel master name (default: "mymaster")
  • :master_port - master port (default: 6390)
  • :replicas - number of replica nodes (default: 2)
  • :replica_base_port - starting port for replicas (default: master_port + 1)
  • :sentinels - number of sentinel processes (default: 3)
  • :sentinel_base_port - starting port for sentinels (default: 26389)
  • :quorum - sentinel quorum (default: 2)
  • :down_after_ms - down-after-milliseconds (default: 5000)
  • :failover_timeout_ms - failover timeout (default: 10_000)
  • :bind - bind address (default: "127.0.0.1")
  • :control_host - address used by redis-cli, replication, and Sentinel monitoring (default: first bind address)
  • :password - Redis password
  • :username - optional ACL username paired with :password
  • :tls - use TLS-only data-node and Sentinel connections (default: false)
  • :tls_cert_file, :tls_key_file - server certificate and private key
  • :tls_ca_cert_file or :tls_ca_cert_dir - trusted CA for Redis and redis-cli
  • :tls_client_cert_file, :tls_client_key_file - optional redis-cli client identity
  • :tls_server_name - optional redis-cli SNI name
  • :tls_insecure - explicitly disable redis-cli certificate verification
  • :redis_server_bin - redis-server binary path
  • :redis_cli_bin - redis-cli binary path
  • :distribution - :core (default), :full, or :legacy_stack
  • :timeout - startup timeout per node in ms (default: 10_000)
  • :convergence_timeout - bounded wait for replication and Sentinel discovery (default: the value of :timeout)
  • :loadmodule - modules loaded into the master and every replica; accepts paths or {path, [args]} tuples (default: []). Sentinel processes do not load data modules.
  • :managed - process lifecycle backend forwarded to the master and every replica. See RedisServerWrapper.Server for true, :forcola, and false. Sentinel control processes use the same selected backend. Only managed: false supports detach/1.

Summary

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

detach(server)

Detaches daemonized data nodes so their OS processes survive this GenServer.

healthy?(server)

Checks sentinel health: master reachable, expected replicas and sentinels.

info(server)

Returns info about the topology.

master_addr(server)

Returns the master address.

poke(server)

Queries SENTINEL MASTER for the given master name.

sentinel_addrs(server)

Returns all sentinel addresses.

start(opts \\ [])
start_link(opts \\ [])
stop(server)

Stops the sentinel topology.

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.

detach(server)

@spec detach(GenServer.server()) :: :ok | {:error, :managed_server}

Detaches daemonized data nodes so their OS processes survive this GenServer.

healthy?(server)

@spec healthy?(GenServer.server()) :: boolean()

Checks sentinel health: master reachable, expected replicas and sentinels.

info(server)

@spec info(GenServer.server()) :: map()

Returns info about the topology.

master_addr(server)

@spec master_addr(GenServer.server()) :: String.t()

Returns the master address.

poke(server)

@spec poke(GenServer.server()) :: {:ok, map()} | {:error, term()}

Queries SENTINEL MASTER for the given master name.

sentinel_addrs(server)

@spec sentinel_addrs(GenServer.server()) :: [String.t()]

Returns all sentinel addresses.

start(opts \\ [])

@spec start(keyword()) :: GenServer.on_start()

start_link(opts \\ [])

@spec start_link(keyword()) :: GenServer.on_start()

stop(server)

@spec stop(GenServer.server()) :: :ok

Stops the sentinel topology.