Rack::Timeout 技术文档

1. 安装指南

1.1 使用 Bundler 安装

在 Rails 项目中，可以通过在 Gemfile 中添加以下内容来安装 rack-timeout：

gem "rack-timeout"

然后运行 bundle install 来安装 gem。

1.2 手动安装

如果你需要手动控制 rack-timeout 的加载位置，可以在 Gemfile 中这样配置：

gem "rack-timeout", require: "rack/timeout/base"

然后在 config/initializers/rack_timeout.rb 中手动插入中间件：

Rails.application.config.middleware.insert_before Rack::Runtime, Rack::Timeout, service_timeout: 15

1.3 Sinatra 和其他 Rack 应用

在 config.ru 文件中添加以下内容：

require "rack-timeout"
use Rack::Timeout, service_timeout: 15

2. 项目的使用说明

2.1 基本用法

rack-timeout 是一个用于终止超时请求的工具。默认情况下，请求的超时时间为 15 秒。你可以通过设置 RACK_TIMEOUT_SERVICE_TIMEOUT 环境变量来修改超时时间。

2.2 配置选项

rack-timeout 提供了多个配置选项，可以通过环境变量或中间件初始化参数进行设置。以下是默认配置：

service_timeout:   15     # RACK_TIMEOUT_SERVICE_TIMEOUT
wait_timeout:      30     # RACK_TIMEOUT_WAIT_TIMEOUT
wait_overtime:     60     # RACK_TIMEOUT_WAIT_OVERTIME
service_past_wait: false  # RACK_TIMEOUT_SERVICE_PAST_WAIT
term_on_timeout:   false  # RACK_TIMEOUT_TERM_ON_TIMEOUT

这些配置可以通过以下方式进行覆盖：

use Rack::Timeout, service_timeout: 15, wait_timeout: 30

3. 项目API使用文档

3.1 中间件初始化参数

• service_timeout: 请求处理的超时时间，默认 15 秒。
• wait_timeout: 请求等待的超时时间，默认 30 秒。
• wait_overtime: 请求等待的超时后的额外时间，默认 60 秒。
• service_past_wait: 是否在等待超时后继续处理请求，默认 false。
• term_on_timeout: 是否在超时时终止进程，默认 false。

3.2 环境变量

• RACK_TIMEOUT_SERVICE_TIMEOUT: 请求处理的超时时间。
• RACK_TIMEOUT_WAIT_TIMEOUT: 请求等待的超时时间。
• RACK_TIMEOUT_WAIT_OVERTIME: 请求等待的超时后的额外时间。
• RACK_TIMEOUT_SERVICE_PAST_WAIT: 是否在等待超时后继续处理请求。
• RACK_TIMEOUT_TERM_ON_TIMEOUT: 是否在超时时终止进程。

4. 项目安装方式

4.1 通过 Bundler 安装

在 Gemfile 中添加 gem "rack-timeout"，然后运行 bundle install。

4.2 手动安装

在 Gemfile 中添加 gem "rack-timeout", require: "rack/timeout/base"，然后在初始化文件中手动插入中间件。

4.3 Sinatra 和其他 Rack 应用

在 config.ru 文件中添加 require "rack-timeout" 和 use Rack::Timeout, service_timeout: 15。

通过以上步骤，你可以成功安装并配置 rack-timeout，从而有效地管理应用程序中的超时请求。