diff --git a/Pro-2.0-Upgrade.md b/Pro-2.0-Upgrade.md new file mode 100644 index 00000000..17163176 --- /dev/null +++ b/Pro-2.0-Upgrade.md @@ -0,0 +1,31 @@ +# Upgrading to Sidekiq Pro 2.0 + +Sidekiq Pro 2.0 removes deprecated APIs, changes the batch data format and +how features are activated. To upgrade cleanly: + +## Batches + +* Batch 2.x BIDs are 14 character URL-safe Base64-encoded strings, e.g. + "vTF1-9QvLPnREQ". + Batch 1.x BIDs were 16 character hex-encoded strings, e.g. "4a3fc67d30370edf". +* In 1.x, batch data expired after 72 hours. In 2.x, all data in Redis + for a batch is removed once the batch has run any success callbacks. +* Because of the former point, batch expiry is no longer a concern. + Batch expiry is hardcoded to 30 days and is no longer user-tunable. +* Sidekiq::Batch#notify was removed. This API was a very thin layer + on top of the more flexible `Sidekiq::Batch#on` API that everyone + should be using. +* You must require `sidekiq/notifications` if you want to use the + pre-defined notification schemes. + +## Reliability + +* Reliable fetch is now activated without a require: +```ruby +Sidekiq.configure_server do |config| + config.reliable_fetch! +end +* Reliable push is now activated without a require: +```ruby +Sidekiq::Client.reliable_push! +``` diff --git a/Pro-Changes.md b/Pro-Changes.md index 89a0992a..79ec02d1 100644 --- a/Pro-Changes.md +++ b/Pro-Changes.md @@ -7,16 +7,7 @@ Please see [http://sidekiq.org/pro](http://sidekiq.org/pro) for more details and 2.0.0 (see mperham/sidekiq#2130 for progress) ----------- -- Batch IDs (bids) are now 14 char Base64-encoded strings, not 16 - char hex-encoded strings. -- Rework of the batch data model. This results in a 25% reduction in - data size in Redis. 5000 batches go from 6260 -> 4611 KB in Redis and - creation is 10% faster. -- Batch job errors no longer store the backtrace in Redis unless the - job's `backtrace` option is set. This should result in another big data - size reduction. -- Notifications must now be required first `require 'sidekiq/pro/notifications'` -- Remove deprecated APIs. +- See [[Pro-2.0-Upgrade.md]] for thorough release notes. 1.9.2 -----------