Sidekiq Pro Web UI 配置 Redis 连接池的解决方案

在使用 Sidekiq Pro 的 Web 界面时，配置多个 Redis 连接池可能会遇到一些兼容性问题。本文将详细介绍这些问题的成因以及解决方案。

问题背景

当开发者尝试为 Sidekiq Pro 的 Web UI 配置多个 Redis 连接池时，可能会遇到两种不同类型的错误：

1. Redis gem 兼容性问题：当使用传统的 Redis gem 时，会出现 NoMethodError: private method 'select' called 错误。这是因为 Sidekiq 7 版本已经不再支持 Redis gem，而是全面转向了 redis-client。

2. Redis-client 方法缺失问题：当切换到 redis-client 后，又会出现 NoMethodError: undefined method 'mget' 错误。这是因为直接使用 redis-client 的连接池时，缺少必要的适配层。

根本原因分析

Sidekiq 7 版本进行了重大的底层重构，完全移除了对 Redis gem 的依赖，转而使用 redis-client 作为默认的 Redis 客户端。这一变化带来了性能提升和更现代的架构，但也导致了与旧配置方式的兼容性问题。

解决方案

正确的配置方式是使用 Sidekiq 提供的 RedisClientAdapter 适配器。以下是完整的配置示例：

require "rack"
require "sidekiq-pro"
require "sidekiq/pro/web"
require "securerandom"
require "rack/urlmap"
require "rack/session"
require "redis-client"
require "sidekiq/redis_client_adapter"

# 创建 Redis 连接池
POOL1 = Sidekiq::RedisClientAdapter.new(
  RedisClient.config(url: "redis://localhost:6379/0").new_pool
)
POOL2 = Sidekiq::RedisClientAdapter.new(
  RedisClient.config(url: "redis://localhost:6379/1").new_pool
)

# 配置 Rack 应用
use Rack::Session::Cookie, 
  secret: SecureRandom.hex(32), 
  same_site: true, 
  max_age: 86_400

run Rack::URLMap.new(
  "/sidekiq1" => Sidekiq::Pro::Web.with(redis_pool: POOL1),
  "/sidekiq2" => Sidekiq::Pro::Web.with(redis_pool: POOL2),
)

关键点说明

1. RedisClientAdapter：这是 Sidekiq 提供的适配器层，它将 redis-client 的连接池转换为 Sidekiq 内部可以识别的格式，解决了方法缺失的问题。

2. 连接池创建：使用 RedisClient.config 创建配置对象，然后调用 new_pool 方法创建连接池，最后用 RedisClientAdapter 进行包装。

3. Web UI 配置：使用 Sidekiq::Pro::Web.with 方法为每个 Web UI 实例分配独立的 Redis 连接池。

最佳实践

1. 对于生产环境，建议为每个 Sidekiq Web UI 实例配置独立的 Redis 数据库（通过不同的 DB 编号）。

2. 连接池大小应根据实际并发需求进行调整，通常 5-10 个连接足够应对大多数场景。

3. 确保使用最新版本的 Sidekiq 和 redis-client gem 以获得最佳兼容性和性能。

通过以上配置，开发者可以顺利地为多个 Sidekiq Web UI 实例配置独立的 Redis 连接池，实现多租户或分片部署的需求。