flant/redis-sentinel-proxy

redis-sentinel-proxy 镜像文档

镜像概述和主要用途

redis-sentinel-proxy 是由 enriclluelles 开发的轻量级 TCP 代理工具，基于 Go 语言编写。其核心用途是通过 Redis Sentinel 自动发现 Redis 主节点，并将本地端口接收到的 TCP 请求透明转发至该主节点，解决客户端无法直接与 Sentinel 交互或需统一访问入口的场景需求。

核心功能和特性

核心功能

1. 主节点自动发现：持续查询指定 Redis Sentinel 服务器，动态获取名为 NAME 的 Redis 主节点地址及端口。
2. TCP 请求代理：监听本地指定端口（PORT），将所有接收到的 TCP 请求转发至通过 Sentinel 发现的 Redis 主节点。

关键特性

• 轻量高效：Go 语言编写，资源占用低，处理性能优异。
• 配置简化：通过命令行参数直接配置，无需额外配置文件。
• 动态适配：实时跟踪 Sentinel 报告的主节点变化，自动更新代理目标。

使用场景和适用范围

适用场景

• 客户端无 Sentinel 交互能力：当客户端无法直接解析 Sentinel 响应获取主节点时，作为中间层提供透明代理。
• 统一访问入口：需将 Redis 访问入口统一为固定端口，避免客户端因主节点切换修改配置。
• Sentinel 主从切换适配：在 Redis 集群通过 Sentinel 实现主从自动切换时，确保请求始终路由至最新主节点。

适用范围

• 基于 Redis Sentinel 管理的 Redis 集群环境。
• 依赖 TCP 协议通信的 Redis 客户端（如 Redis CLI、各类语言 SDK）。
• 对代理工具资源占用和转发延迟敏感的生产环境。

详细使用方法和配置说明

基本使用语法

工具通过命令行参数配置，语法如下：

bash
./redis-sentinel-proxy -listen IP:PORT -sentinel SENTINEL_ADDR:PORT -master NAME

核心配置参数

Docker 部署方案

1. 直接使用 docker run 部署

bash
docker run -d \
  --name redis-sentinel-proxy \
  -p 6379:6379 \  # 宿主机端口:容器内监听端口（需与 -listen 参数端口一致）
  enriclluelles/redis-sentinel-proxy \  # 镜像名称（实际使用时需替换为官方/私有仓库地址）
  -listen 0.0.0.0:6379 \  # 容器内监听所有网卡的 6379 端口  
  -sentinel 192.168.1.100:26379 \  # 替换为实际 Sentinel 地址:端口  
  -master mymaster  # 替换为实际 Redis 主节点名称  

2. 使用 docker-compose 部署

创建 docker-compose.yml 文件：

yaml
version: '3.8'
services:
  redis-sentinel-proxy:
    image: enriclluelles/redis-sentinel-proxy  # 替换为实际镜像地址
    container_name: redis-sentinel-proxy
    restart: unless-stopped  # 异常退出时自动重启
    ports:
      - "6379:6379"  # 宿主机端口映射（左侧宿主机，右侧容器内监听端口）
    command:
      - -listen
      - "0.0.0.0:6379"  # 容器内监听地址及端口
      - -sentinel
      - "sentinel-host:26379"  # 替换为实际 Sentinel 地址:端口
      - -master
      - "mymaster"  # 替换为实际 Redis 主节点名称

启动命令：

bash
docker-compose up -d

使用注意事项

1. 网络可达性：确保容器可访问 Redis Sentinel 服务器（需配置正确的网络策略或端口映射）。
2. 参数一致性：-listen 参数的容器内端口需与 docker run/docker-compose 中的端口映射右侧值一致。
3. 主节点名称匹配：-master 参数值必须与 Sentinel 中注册的主节点名称完全一致，否则无法获取主节点信息。
4. 日志与调试：工具默认输出代理状态日志，可通过容器日志（docker logs <容器名>）排查主节点发现或转发异常。