mirror of
https://github.com/mperham/sidekiq.git
synced 2022-11-09 13:52:34 -05:00
doc cleanup
This commit is contained in:
parent
a21e020669
commit
36408003f9
2 changed files with 24 additions and 24 deletions
|
@ -10,38 +10,37 @@ This release has major breaking changes. Read and test carefully in production.
|
|||
- Logging has been redesigned to allow pluggable formatters and several
|
||||
formats ship with Sidekiq:
|
||||
* default - your typical output on macOS
|
||||
* heroku - a Heroku-specific formatter
|
||||
* json - a new format with key=value pairs for search indexing
|
||||
|
||||
Sidekiq will enable the best formatter for the detected environment but
|
||||
you can override it by configuring the log formatter explicitly:
|
||||
* heroku - enabled specifically when running in Heroku
|
||||
* json - a JSON format for search indexing, one hash per line
|
||||
|
||||
```
|
||||
Sidekiq will enable the best formatter for the detected environment but
|
||||
you can override it by configuring the log formatter explicitly. See
|
||||
'sidekiq/logger' for implementation details.
|
||||
|
||||
```ruby
|
||||
Sidekiq.configure_server do |config|
|
||||
config.log_formatter = AcmeCorp::PlainLogFormatter.new
|
||||
# Sidekiq::Logger::Formatters::Pretty.new (default)
|
||||
# Sidekiq::Logger::Formatters::WhitoutTimestamp.new
|
||||
# Sidekiq::Logger::Formatters::JSON.new
|
||||
# config.log_formatter = Sidekiq::Logger::Format::JSON.new
|
||||
end
|
||||
```
|
||||
|
||||
- **Remove the daemonization, logfile and pidfile command line arguments**.
|
||||
I've [noted for years](https://www.mikeperham.com/2014/09/22/dont-daemonize-your-daemons/)
|
||||
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.
|
||||
I've [noted for years](https://www.mikeperham.com/2014/09/22/dont-daemonize-your-daemons/)
|
||||
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. See the Deployment wiki page for options.
|
||||
- **Validate proper usage of the `REDIS_PROVIDER` variable.**
|
||||
This variable is meant to hold the name of the environment
|
||||
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
|
||||
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.5** is no longer supported.
|
||||
* **Redis <4** is no longer supported.
|
||||
|
||||
## Upgrade
|
||||
|
||||
|
|
19
Changes.md
19
Changes.md
|
@ -9,19 +9,20 @@ This release has major breaking changes. Read and test carefully in production.
|
|||
|
||||
- **BREAKING CHANGE** 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 (not recommended as it implies you have no failover),
|
||||
then you may set `REDIS_URL` directly. [#3969]
|
||||
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 (not recommended as it implies you have no failover),
|
||||
then you may set `REDIS_URL` directly. [#3969]
|
||||
- **BREAKING CHANGE** 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]
|
||||
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]
|
||||
- **BREAKING CHANGE** Remove the daemonization, logfile and pidfile
|
||||
arguments to Sidekiq. Use a proper process supervisor (e.g. systemd or
|
||||
foreman) to manage Sidekiq.
|
||||
foreman) to manage Sidekiq. See the Deployment wiki page for links to
|
||||
more resources.
|
||||
|
||||
HEAD
|
||||
---------
|
||||
|
|
Loading…
Add table
Reference in a new issue