Sidekiq Worker Killer 项目教程

1. 项目的目录结构及介绍

Sidekiq Worker Killer 项目的目录结构如下：

sidekiq-worker-killer/
├── LICENSE
├── README.md
├── Rakefile
├── sidekiq-worker-killer.gemspec
├── lib/
│   ├── sidekiq/
│   │   ├── worker_killer.rb
│   │   └── version.rb
│   └── sidekiq-worker-killer.rb
├── spec/
│   ├── spec_helper.rb
│   └── worker_killer_spec.rb

目录结构介绍

• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• Rakefile: 用于运行测试和 lint 检查的 Rake 任务文件。
• sidekiq-worker-killer.gemspec: 项目的 gem 规范文件，包含 gem 的元数据和依赖项。
• lib/: 包含项目的核心代码。
  • sidekiq/: 包含与 Sidekiq 相关的代码。
    • worker_killer.rb: 实现 Worker Killer 功能的主要文件。
    • version.rb: 定义 gem 版本号的文件。
  • sidekiq-worker-killer.rb: 项目的入口文件。
• spec/: 包含项目的测试代码。
  • spec_helper.rb: 测试辅助文件。
  • worker_killer_spec.rb: Worker Killer 功能的测试文件。

2. 项目的启动文件介绍

项目的启动文件是 lib/sidekiq-worker-killer.rb，该文件是整个 gem 的入口点。它负责加载必要的依赖项和模块。

require 'sidekiq/worker_killer'

3. 项目的配置文件介绍

Sidekiq Worker Killer 的配置主要在 lib/sidekiq/worker_killer.rb 文件中完成。以下是配置的示例：

require 'sidekiq/worker_killer'

Sidekiq.configure_server do |config|
  config.server_middleware do |chain|
    chain.add Sidekiq::WorkerKiller, max_rss: 480
  end
end

配置选项

• max_rss: 设置 Sidekiq 进程的最大 RSS（常驻集大小），单位为 MB。超过此值将触发关闭。
• grace_time: 在触发关闭后，Sidekiq 进程将不接受新任务，并等待最多 15 分钟让正在运行的任务完成。
• shutdown_wait: 在 grace_time 到期后，仍在运行的任务将获得 30 秒的时间停止。
• kill_signal: 用于终止 Sidekiq 进程的信号，默认为 SIGKILL。
• gc: 在 Sidekiq 进程停止前尝试运行垃圾回收。
• skip_shutdown_if: 在 max_rss 超过后但在请求关闭前执行的代码块。
• on_shutdown: 在请求关闭前执行的代码块，可用于发送自定义日志或指标到外部服务。

通过这些配置选项，可以灵活地控制 Sidekiq Worker Killer 的行为。