1
0
Fork 0
mirror of https://github.com/mperham/sidekiq.git synced 2022-11-09 13:52:34 -05:00
mperham--sidekiq/6.0-Upgrade.md
2018-12-28 10:07:03 -08:00

1.8 KiB

Welcome to Sidekiq 6.0!

Sidekiq 6.0 contains some breaking changes which streamline proper operation of Sidekiq. It also drops support for EOL versions of Ruby and Rails.

What's New

This release has major breaking changes. Read and test carefully in production.

  • Include new JSON log format for use where you want machine-ingestible log output. Enable with:
Sidekiq.configure_server do |config|
  config.logger_format = :json # or :default
end
  • Remove the daemonization, logfile and pidfile command line arguments. I've noted for years how modern services should be managed with a proper init system. Managing services manually is more error-prone, let your operating system do it for you.
  • Validate proper usage of the REDIS_PROVIDER variable. This variable is meant to hold the name of the environment variable which contains your Redis URL, so that you can switch Redis providers quickly and easily with a single variable change. It is not meant to hold the actual Redis URL itself. If you want to manually set the Redis URL then you may set REDIS_URL directly. [#3969]
  • Increase default shutdown timeout from 8 seconds to 25 seconds. Both Heroku and ECS now use 30 second shutdown timeout by default and we want Sidekiq to take advantage of this time. If you have deployment scripts which depend on the old default timeout, use -t 8 to get the old behavior. [#3968]
  • Rails <5 is no longer supported.
  • Ruby <2.4 is no longer supported.

Upgrade

As always, please upgrade Sidekiq one major version at a time. If you are already running Sidekiq 5.x, then:

  • Upgrade to the latest Sidekiq 5.x.
gem 'sidekiq', '< 6'
  • Fix any deprecation warnings you see.
  • Upgrade to 6.x.
gem 'sidekiq', '< 7'