Sidekiq Failures 项目教程

Sidekiq Failures 项目教程

sidekiq-failuresKeep track of Sidekiq failed jobs项目地址:https://gitcode.com/gh_mirrors/si/sidekiq-failures

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

Sidekiq Failures 是一个用于跟踪 Sidekiq 失败作业的 Ruby gem。以下是其基本的目录结构：

sidekiq-failures/
├── bin/
│   └── sidekiq-failures
├── lib/
│   ├── sidekiq-failures/
│   │   ├── middleware/
│   │   │   ├── client.rb
│   │   │   └── server.rb
│   │   ├── version.rb
│   │   └── failures.rb
│   └── sidekiq-failures.rb
├── test/
│   ├── test_helper.rb
│   └── sidekiq_failures_test.rb
├── Gemfile
├── Gemfile.lock
├── LICENSE.txt
├── README.md
└── sidekiq-failures.gemspec

目录结构介绍

• bin/: 包含可执行文件。
• lib/: 包含主要的代码文件。
  • sidekiq-failures/: 主要的 gem 代码。
    • middleware/: 包含客户端和服务器中间件。
    • version.rb: 版本信息。
    • failures.rb: 主要的功能实现。
  • sidekiq-failures.rb: 加载 gem 的主文件。
• test/: 包含测试文件。
• Gemfile: 依赖管理文件。
• Gemfile.lock: 依赖锁定文件。
• LICENSE.txt: 许可证文件。
• README.md: 项目说明文档。
• sidekiq-failures.gemspec: gem 的规范文件。

2. 项目的启动文件介绍

Sidekiq Failures 的启动文件主要是 lib/sidekiq-failures.rb，这个文件负责加载 gem 的主要功能。

require 'sidekiq/failures'

这个文件会加载 sidekiq/failures 目录下的所有文件，包括中间件和主要功能实现。

3. 项目的配置文件介绍

Sidekiq Failures 的配置主要通过 Sidekiq 的配置文件进行。以下是一个示例配置：

Sidekiq.configure_server do |config|
  config.failures_max_count = 5000 # 设置最大跟踪失败数
  config.failures_default_mode = :all # 设置默认跟踪模式
end

配置项介绍

• failures_max_count: 设置最大跟踪失败数，默认值为 1000。
• failures_default_mode: 设置默认跟踪模式，可选值为 :all, :exhausted, 或 :off。

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

以上是 Sidekiq Failures 项目的基本教程，涵盖了目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

sidekiq-failuresKeep track of Sidekiq failed jobs项目地址:https://gitcode.com/gh_mirrors/si/sidekiq-failures