File: Pro-4.0-Upgrade.md

package info (click to toggle)
ruby-sidekiq 5.2.3%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 828 kB
  • sloc: ruby: 4,065; makefile: 24; sh: 6
file content (35 lines) | stat: -rw-r--r-- 1,013 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Welcome to Sidekiq Pro 4.0!

Sidekiq Pro 4.0 is designed to work with Sidekiq 5.0.

## What's New

* Batches now "die" if any of their jobs die.  You can enumerate the set
  of dead batches and their associated dead jobs.  The success callback
  for a dead batch will never fire unless these jobs are fixed.
```ruby
Sidekiq::Batch::DeadSet.new.each do |status|
  status.dead? # => true
  status.dead_jobs # => [...]
end
```
This API allows you to enumerate the batches which need help.
If you fix the issue and the dead jobs succeed, the batch will succeed.
* The older `reliable_fetch` and `timed_fetch` algorithms have been
  removed.  Only super\_fetch is available in 4.0.
* The statsd middleware has been tweaked to remove support for legacy,
  pre-3.6.0 configuration and add relevant tags.
* Requires Sidekiq 5.0.5+.

## Upgrade

* Upgrade to the latest Sidekiq Pro 3.x.
```ruby
gem 'sidekiq-pro', '< 4'
```
* Fix any deprecation warnings you see.
* Upgrade to 4.x.
```ruby
gem 'sidekiq-pro', '< 5'
```