Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
More Pro 2 notes
  • Loading branch information
mperham committed Jan 29, 2015
1 parent 216cfc7 commit e5b184d
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 6 deletions.
20 changes: 17 additions & 3 deletions Pro-2.0-Upgrade.md
@@ -1,10 +1,16 @@
# Upgrading to Sidekiq Pro 2.0

Sidekiq Pro 2.0 allows nested batches for more complex job workflows.
Sidekiq Pro 2.0 allows nested batches for more complex job workflows
and provides a Lua-based scheduler for reliability and performance.

It also removes deprecated APIs, changes the batch data format and
how features are activated. Read carefully to ensure your upgrade goes
smoothly.

Sidekiq Pro 2.0 requires Sidekiq 3.3.0 or greater. Redis 2.8 is
recommended; Redis 2.4 or 2.6 will work but some functionality will not be
available.

**Note that you CANNOT go back to Pro 1.x once you've created batches
with 2.x. The new batches will not process correctly with 1.x.**

Expand Down Expand Up @@ -75,20 +81,28 @@ both old and new format.**

You no longer need to require anything to use Reliability features.

* Activate reliable fetch:
* Activate reliable fetch and/or reliable scheduler:
```ruby
Sidekiq.configure_server do |config|
config.reliable_fetch!
config.reliable_scheduler!
end
```
* Activate reliable push:
```ruby
Sidekiq::Client.reliable_push!
```

The new reliable scheduler uses Lua inside Redis so enqueuing scheduled
jobs is atomic. Benchmarks also show it 50x faster when enqueuing
lots of jobs. **One caveat**: client-side middleware is not executed
for each job when enqueued with the reliable scheduler. No Sidekiq or
Sidekiq Pro functionality is affected by this change but some 3rd party
plugins might be.

## Other Changes

* You must require `sidekiq/notifications` if you want to use the
* You must require `sidekiq/pro/notifications` if you want to use the
existing notification schemes. I don't recommend using them as the
newer-style `Sidekiq::Batch#on` method is simpler and more flexible.
* Several classes have been renamed. Generally these classes are ones
Expand Down
4 changes: 2 additions & 2 deletions Pro-Changes.md
Expand Up @@ -4,10 +4,10 @@ Sidekiq Pro Changelog
Please see [http://sidekiq.org/pro](http://sidekiq.org/pro) for more details and how to buy.


2.0.0 (see mperham/sidekiq#2130 for progress)
2.0.0 (unreleased)
-----------

- See [[Pro-2.0-Upgrade.md]] for thorough release notes.
- See [the Upgrade Notes](Pro-2.0-Upgrade.md) for detailed notes.

1.9.2
-----------
Expand Down
2 changes: 1 addition & 1 deletion lib/sidekiq/scheduled.rb
Expand Up @@ -44,7 +44,7 @@ class Poller
INITIAL_WAIT = 10

def initialize
@enq = (Sidekiq.options[:poll_enq] || Sidekiq::Scheduled::Enq).new
@enq = (Sidekiq.options[:scheduled_enq] || Sidekiq::Scheduled::Enq).new
end

def poll(first_time=false)
Expand Down

0 comments on commit e5b184d

Please sign in to comment.