项目技术文档：Degrade

1. 安装指南

1.1 安装步骤

要安装 degrade 项目，您可以使用以下命令：

gem install degrade

1.2 依赖项

• Ruby 环境
• Redis 数据库

2. 项目的使用说明

2.1 初始化

首先，您需要初始化 degrade 实例。每个功能都需要一个独立的实例。以下是一个示例：

$redis             = Redis.new
$rollout           = Rollout.new($redis)
$degrade_cassandra = Degrade.new($redis, 
                                  :name             => :cassandra,
                                  :sample           => 5000,
                                  :minimum          => 100,
                                  :threshold        => 0.1,
                                  :errors           => [StandardError],
                                  :failure_strategy => lambda { $rollout.deactivate_all(:cassandra) })

2.2 配置选项

• name: 功能的名称。
• sample: 每 n 个请求后重置计数器，n 在这里定义。
• minimum: 在决定是否达到阈值之前需要看到的最小请求数。
• threshold: 触发失败的请求失败百分比。
• errors: 哪些错误会导致标记为失败。
• failure_strategy: 当达到阈值时调用的 proc。

2.3 使用 perform 方法

将可能失败的调用包装在 perform 方法中：

$degrade_cassandra.perform { $cassandra.get("Timelines", "1/everything") }

2.4 驱动装饰器

为了简化代码，您可以使用驱动装饰器来包装每个服务调用：

class NewsServiceWithDegradation
  def initialize(news_service, degrade)
    @news_service = news_service
    @degrade      = degrade
  end

  def get_news(*args)
    @degrade.perform { @news_service.get_news(*args) }
  end
end

3. 项目API使用文档

3.1 Degrade.new

• 参数:

  • redis: Redis 实例。
  • options: 配置选项，包括 name, sample, minimum, threshold, errors, failure_strategy。

• 返回值: Degrade 实例。

3.2 perform

• 参数: 一个代码块，包含可能失败的调用。
• 返回值: 代码块的返回值。

4. 项目安装方式

4.1 使用 Gem 安装

gem install degrade

4.2 手动安装

1. 克隆项目仓库。
2. 运行 bundle install 安装依赖。
3. 将 degrade 添加到您的项目中。

5. 已知问题与注意事项

• 在高吞吐量的服务中，频繁的请求可能会导致问题。可以通过增加阈值检查和样本重置的随机性来改善。
• 调用 Redis 会增加请求的延迟，请确保您可以接受这一点。
• 不要在 Redis 本身上使用此功能，否则会导致无限递归。

6. 贡献指南

• 分叉项目。
• 添加功能或修复 bug。
• 添加测试。
• 提交拉取请求。

7. 版权信息

版权所有 (c) 2010 James Golick。详情请参阅 LICENSE 文件。