HireFire 技术文档

1. 安装指南

1.1 环境要求

• Ruby on Rails 环境
• Heroku 平台
• Delayed Job 或 Resque 作为后台任务处理库

1.2 安装步骤

在 Ruby on Rails 环境中，首先需要在 Gemfile 中添加以下内容：

gem 'rails'
# gem 'delayed_job' # 如果使用 Delayed Job，取消注释此行
# gem 'resque'      # 如果使用 Resque，取消注释此行
gem 'hirefire'

注意： 顺序很重要，确保 Delayed Job 或 Resque 在 HireFire 之前。

接下来，设置 Heroku 环境变量，以便 HireFire 可以管理你的 worker：

heroku config:add HIREFIRE_EMAIL=<your_email> HIREFIRE_PASSWORD=<your_password>

这些是你在 Heroku 网页界面中用于管理 worker 的邮箱和密码。你也可以使用 Heroku API 令牌作为 HIREFIRE_PASSWORD 的值。你可以通过 Heroku UI 或 CLI 命令 heroku auth:token 获取 API 令牌。

2. 项目的使用说明

2.1 默认配置

完成上述安装步骤后，默认配置已经设置完成。你可能需要根据应用程序的需求调整自动扩展配置。创建一个初始化文件（或在启动时加载的类似配置文件），并配置 HireFire 的扩展行为：

# Rails.root/config/initializers/hirefire.rb
HireFire.configure do |config|
  config.environment      = nil # 生产环境默认为 :heroku，开发环境默认为 :noop
  config.max_workers      = 5   # 默认值为 1
  config.min_workers      = 0   # 默认值为 0
  config.job_worker_ratio = [
      { :jobs => 1,   :workers => 1 },
      { :jobs => 15,  :workers => 2 },
      { :jobs => 35,  :workers => 3 },
      { :jobs => 60,  :workers => 4 },
      { :jobs => 80,  :workers => 5 }
    ]
end

2.2 配置解释

上述配置确保你最多同时运行 5 个 worker (config.max_workers = 5)。然后我们定义了一个哈希数组，表示 job 与 worker 的比例关系。例如：

• 当队列中有 1-14 个 job 时，启动 1 个 worker
• 当队列中有 15-34 个 job 时，启动 2 个 worker
• 当队列中有 35-59 个 job 时，启动 3 个 worker
• 当队列中有 60-79 个 job 时，启动 4 个 worker
• 当队列中有 80 个以上 job 时，启动 5 个 worker

当队列中的所有 job 处理完毕后，所有 worker 将被关闭，下次有新 job 入队时，重新启动一个 worker。

2.3 非 Ruby on Rails 环境

在非 Ruby on Rails 环境中，设置几乎相同，只是需要在 Delayed Job 或 Resque 加载完成后手动初始化 HireFire：

require 'delayed_job'
# require 'delayed_job' # 如果使用 Delayed Job，取消注释此行
# require 'resque'      # 如果使用 Resque，取消注释此行
HireFire::Initializer.initialize!

注意： 顺序同样重要，确保 Delayed Job 或 Resque 在 HireFire 之前。

3. 项目 API 使用文档

3.1 配置 API

HireFire 提供了灵活的配置 API，允许你根据应用程序的需求自定义扩展行为。以下是一些常用的配置选项：

• config.environment: 设置环境，默认为 :heroku（生产环境）或 :noop（开发环境）。
• config.max_workers: 设置最大 worker 数量，默认为 1。
• config.min_workers: 设置最小 worker 数量，默认为 0。
• config.job_worker_ratio: 定义 job 与 worker 的比例关系。

3.2 动态配置

你还可以使用 Lambda 表达式动态定义 job 与 worker 的比例关系：

HireFire.configure do |config|
  config.max_workers = 5
  config.job_worker_ratio = [
    { :when => lambda {|jobs| jobs < 15 }, :workers => 1 },
    { :when => lambda {|jobs| jobs < 35 }, :workers => 2 },
    { :when => lambda {|jobs| jobs < 60 }, :workers => 3 },
    { :when => lambda {|jobs| jobs < 80 }, :workers => 4 }
  ]
end

4. 项目安装方式

4.1 通过 Gemfile 安装

在 Ruby on Rails 项目中，通过 Gemfile 安装 HireFire：

gem 'hirefire'

然后运行 bundle install 安装依赖。

4.2 手动安装

在非 Ruby on Rails 环境中，可以通过以下命令手动安装 HireFire：

gem install hirefire

然后在应用程序中手动初始化 HireFire。

5. 常见问题解答

• 问题: 当有新 job 入队时，是否会立即启动 worker？

  • 回答: 是的，一旦有新 job 入队，HireFire 会立即计算所需的 worker 数量并启动相应数量的 worker。

• 问题: 当没有 job 需要处理时，是否会立即停止 worker？

  • 回答: 是的，每个 worker 都会自动检测是否有 job 需要处理。如果没有 job 需要处理，所有 worker 将立即停止。

• 问题: 如何节省成本？

  • 回答: 根据 Heroku 的文档，Worker（与 Dyno 相同）是按秒计费的。例如，如果有 10 个 job 入队，启动一个 worker 处理这些 job 并在一分钟内完成，理论上你只需支付 $0.0008。

• 问题: 如果 job 设置为在未来某个时间运行，worker 是否会保持启动状态等待该 job？

  • 回答: 不会，因为如果你将一个 job 设置为 3 小时后运行，worker 可能会在这 3 小时内无所事事。建议避免在未来时间调度 job。

• 问题: 是否会从 5 个 worker 缩减到 4 个 worker？

  • 回答: 不会，因为无法确定哪个 worker 正在处理 job，可能会终止正在处理 job 的 worker，导致 job 处理中断。此外，job 会更快处理完毕，一旦队列为空，所有 worker 都会被终止。

通过本文档，你应该能够顺利安装、配置并使用 HireFire 来管理你的 Heroku worker，从而实现自动扩展和成本优化。