Skip to content

mayesa/sidekiq-batch

This branch is 2 commits ahead of, 15 commits behind breamware/sidekiq-batch:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

db794fc · Mar 6, 2024
Aug 31, 2022
Mar 6, 2024
Jul 11, 2023
Jan 3, 2017
Aug 22, 2016
Dec 29, 2016
Oct 26, 2020
Aug 22, 2016
Aug 22, 2016
Dec 16, 2022
Aug 22, 2016
Jul 11, 2023

Repository files navigation

Sidekiq::Batch

Join the chat at https://gitter.im/breamware/sidekiq-batch

Gem Version Build Status Code Climate Code Climate Code Climate

Simple Sidekiq Batch Job implementation.

Installation

Add this line to your application's Gemfile:

gem 'sidekiq-batch'

And then execute:

$ bundle

Or install it yourself as:

$ gem install sidekiq-batch

Usage

Sidekiq Batch is MOSTLY a drop-in replacement for the API from Sidekiq PRO. See https://github.com/mperham/sidekiq/wiki/Batches for usage.

Caveats/Gotchas

Consider the following workflow:

  • Batch Z created
  • Worker A queued in batch Z
  • Worker A starts Worker B in batch Z
  • Worker B completes before worker A does
  • Worker A completes

In the standard configuration, the on(:success) and on(:complete) callbacks will be triggered when Worker B completes. This configuration is the default, simply for legacy reasons. This gem adds the following option to the sidekiq.yml options:

:batch_push_interval: 0

When this value is absent (aka legacy), Worker A will only push the increment of batch jobs (aka Worker B) when it completes

When this value is set to 0, Worker A will increment the count as soon as WorkerB.perform_async is called

When this value is a positive number, Worker A will wait a maximum of value-seconds before pushing the increment to redis, or until it's done, whichever comes first.

This comes into play if Worker A is queueing thousands of WorkerB jobs, or has some other reason for WorkerB to complete beforehand.

If you are queueing many WorkerB jobs, it is recommended to set this value to something like 3 to avoid thousands of calls to redis, and call WorkerB like so:

WorkerB.perform_in(4.seconds, some, args)

this will ensure that the batch callback does not get triggered until WorkerA and the last WorkerB job complete.

If WorkerA is just slow for whatever reason, setting to 0 will update the batch status immediately so that the callbacks don't fire.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/breamware/sidekiq-batch.

License

The gem is available as open source under the terms of the MIT License.

About

Sidekiq Batch Jobs Implementation

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Ruby 100.0%