Skip to main content

Redis Plugin

The Redis plugin is a runtime-managed UniversalClient layer, not only a single-node *redis.Client.

Runtime Facts​

ItemValue
Go modulegithub.com/go-lynx/lynx-redis
Config prefixlynx.redis
Runtime plugin nameredis.client
Public APIsGetRedis(), GetUniversalRedis()

What The Implementation Actually Supports​

The plugin is built on go-redis UniversalClient and supports:

  • standalone, cluster, and sentinel topologies
  • TLS
  • startup and readiness checks
  • command-level metrics and pool metrics
  • shared runtime resource exposure for higher-level plugins

GetRedis() only returns *redis.Client in standalone mode. GetUniversalRedis() is the stable API across all topologies.

Configuration​

lynx:
  redis:
    addrs:
      - "127.0.0.1:6379"
    db: 0
    min_idle_conns: 5
    max_active_conns: 20
    dial_timeout: 5s
    read_timeout: 5s
    write_timeout: 5s

The old addr examples are outdated. Current config is centered on addrs.

What The Official Template Uses​

lynx-layout/configs/bootstrap.local.yaml currently wires Redis like this:

lynx:
  redis:
    network: tcp
    addrs:
      - 127.0.0.1:6379
    password: lynx123456
    db: 0

So the template is already aligned with the current plugin shape:

  • it uses lynx.redis
  • it uses addrs, not deprecated addr
  • it starts in standalone-friendly form, even though the plugin itself supports cluster and sentinel too

How To Consume It​

import redisplug "github.com/go-lynx/lynx-redis"

universal := redisplug.GetUniversalRedis()
singleNode := redisplug.GetRedis()

Prefer GetUniversalRedis() unless you know you only run in standalone mode.

The official template currently consumes lynx-redis.GetRedis() in internal/data/data.go, which is valid because that template's local config is single-node Redis.