Sidekiq 7配置：可用选项、设置位置及配置验证方法问询

我在Rails应用中使用Sidekiq 7，它支持config/sidekiq.yml和初始化器两种配置方式，想搞清楚三个问题：

• a) 有哪些可用的配置选项？
• b) 这些选项可以在哪里设置？
• c) 如何在不改动生产代码的情况下，通过Rails控制台验证配置是否正确加载？

我的尝试过程 #

尝试的配置验证方法 #

我试过在Rails控制台中执行以下命令查看配置：

bin/rails c

require "sidekiq/cli"
Sidekiq::CLI.instance.parse
Sidekiq::CLI.instance.config

这个方法能看到config/sidekiq.yml里的配置，但初始化器里的配置没生效。

配置文件与初始化器内容 #

config/sidekiq.yml（注释了concurrency，想改用初始化器的值）：

#:concurrency: <%= ENV.fetch("SIDEKIQ_CONCURRENCY") { 15 } %>
:timeout: <%= ENV.fetch("SIDEKIQ_TIMEOUT_SECONDS") { 25 } %>
:queues:
  - default

初始化器代码（config/initializers/sidekiq.rb）：

Sidekiq.configure_server do |config|
  config.concurrency = 88
  config.redis = {
    url: ENV.fetch("SIDEKIQ_REDIS_URL")
  }
end

# configure_client 代码省略

初始化器没有报错，但用上面的控制台方法看不到设置的concurrency=88，不确定是初始化器不支持这个配置，还是验证方法不对。

执行sidekiq -v的输出 #

按照建议执行了bundle exec sidekiq -v，输出如下，但没看到配置值：

# bundle exec sidekiq -v


               m,
               `$b
          .ss,  $$:         .,d$
          `$$P,d$P'    .,md$P"'
           ,$$$$$b/md$$$P^'
         .d$$$$$$/$$$P'
         $$^' `"/$$$'       ____  _     _      _    _
         $:    ',$$:       / ___|(_) __| | ___| | _(_) __ _
         `b     :$$        \___ \| |/ _` |/ _ \ |/ / |/ _` |
                $$:         ___) | | (_| |  __/   <| | (_| |
                $$         |____/|_|\__,_|\___|_|\_|_|\__, |
              .d$$                                       |_|
       

2023-03-08T14:25:30.331Z pid=434 tid=7me INFO: Booted Rails 7.0.4.2 application in development environment
2023-03-08T14:25:30.331Z pid=434 tid=7me INFO: Running in ruby 3.2.1 (2023-02-08 revision 31819e82c8) [aarch64-linux]
2023-03-08T14:25:30.331Z pid=434 tid=7me INFO: See LICENSE and the LGPL-3.0 for licensing details.
2023-03-08T14:25:30.331Z pid=434 tid=7me INFO: Upgrade to Sidekiq Pro for more features and support: https://sidekiq.org
2023-03-08T14:25:30.334Z pid=434 tid=7me INFO: Sidekiq 7.0.6 connecting to Redis with options {:size=>5, :pool_name=>"internal", :url=>"redis://redis:6379/1"}
2023-03-08T14:25:30.335Z pid=434 tid=7me INFO: Sidekiq 7.0.6 connecting to Redis with options {:size=>5, :pool_name=>"default", :url=>"redis://redis:6379/1"}
2023-03-08T14:25:30.336Z pid=434 tid=7me DEBUG: Firing startup event
2023-03-08T14:25:30.336Z pid=434 tid=7me DEBUG: Client Middleware: 
2023-03-08T14:25:30.336Z pid=434 tid=7me DEBUG: Server Middleware: Sidekiq::Metrics::Middleware
2023-03-08T14:25:30.336Z pid=434 tid=7me INFO: Starting processing, hit Ctrl-C to stop
2023-03-08T14:25:30.338Z pid=434 tid=7l6 DEBUG: Firing heartbeat event
^C2023-03-08T14:25:38.874Z pid=434 tid=7me DEBUG: Got INT signal
2023-03-08T14:25:38.875Z pid=434 tid=7me INFO: Shutting down
2023-03-08T14:25:38.875Z pid=434 tid=7me INFO: Terminating quiet threads for default capsule
2023-03-08T14:25:38.876Z pid=434 tid=7ku INFO: Scheduler exiting...
2023-03-08T14:25:38.876Z pid=434 tid=7me DEBUG: Firing quiet event
2023-03-08T14:25:38.876Z pid=434 tid=7me DEBUG: Firing shutdown event
2023-03-08T14:25:38.979Z pid=434 tid=88i INFO: Pausing to allow jobs to finish...
2023-03-08T14:25:40.728Z pid=434 tid=7me INFO: Bye!

解答 #

a) 可用的配置选项 #

Sidekiq 7的核心配置选项包括但不限于：

• concurrency: 并发执行的线程数
• timeout: 任务超时时间（秒）
• queues: 监听的队列列表（支持权重，比如- [default, 5]）
• redis: Redis连接配置（url、pool_size等）
• logfile: 日志文件路径
• loglevel: 日志级别（debug/info/warn/error）
• max_retries: 任务最大重试次数
• retry_in: 重试间隔计算规则
• capsules: 多胶囊配置（Sidekiq 7新增，用于隔离不同队列的并发设置）

b) 配置选项的设置位置 #

注意：Sidekiq.configure_server块中的代码仅在Sidekiq服务器进程启动时执行，Rails控制台属于客户端环境，不会触发这个块的逻辑。

c) 正确的配置验证方法 #

方法1：启动Sidekiq时查看Debug日志

启动Sidekiq时加上--verbose参数，会输出详细的配置信息：

bundle exec sidekiq --verbose

在启动日志中会看到加载的配置，比如并发数、队列、Redis连接信息等。

方法2：在Sidekiq服务器进程中打印配置

可以临时在初始化器中添加日志输出，验证配置是否生效：

Sidekiq.configure_server do |config|
  config.concurrency = 88
  config.redis = {
    url: ENV.fetch("SIDEKIQ_REDIS_URL")
  }
  # 临时添加，启动后查看日志
  Rails.logger.info "Sidekiq Server Config: concurrency=#{config.concurrency}, redis_url=#{config.redis[:url]}"
end

启动Sidekiq后，日志中会显示这些配置值，验证无误后再删除这段代码。

方法3：模拟服务器环境验证（Rails控制台）

如果想在控制台验证服务器配置，可以手动触发configure_server块的执行：

bin/rails c

# 模拟服务器环境
Sidekiq.server = true
# 重新加载初始化器
load Rails.root.join("config/initializers/sidekiq.rb")
# 查看服务器配置
Sidekiq.options[:concurrency]
Sidekiq.options[:redis]

注意：这种方式只是模拟，实际生效还是要以Sidekiq进程启动后的日志为准。

为什么之前的控制台方法看不到初始化器的配置？ #

你之前用Sidekiq::CLI.instance.config查看的是从sidekiq.yml解析的配置，而Sidekiq.configure_server块的代码只有在Sidekiq服务器进程启动时才会执行，Rails控制台默认是客户端环境，不会执行这个块，所以看不到设置的concurrency=88。

内容的提问来源于stack exchange，提问作者davetron5000