README.md in sidekiq-job-signal-0.1.1 vs README.md in sidekiq-job-signal-0.1.2
- old
+ new
@@ -6,35 +6,57 @@
Install the gem and add to the application's Gemfile by executing:
$ bundle add sidekiq-job-signal
+In your Gemfile, specify the gem as:
+
+ gem "sidekiq-job-signal", require: "sidekiq/job_signal"
+
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install sidekiq-job-signal
## Usage
```rb
Sidekiq::JobSignal.quit(jid: "12345")
+Sidekiq::JobSignal.quit(job_class: "ExampleJob")
# log:
# Turned #{12345}:#{JobWorkerClass} into a no-op: [1,2,3]"
+# If you want to add the `quitting?` method to your job
+class ExampleJob
+ include Sidekiq::Job
+ include Sidekiq::JobSignal::Receiver
+
+ def perform
+ if quitting?
+ # finish early...
+ end
+ end
+end
+
# middleware.rb
Sidekiq.configure_server do |config|
config.server_middleware do |chain|
+ # Defaults to by_class: false, by_jid: true
chain.add ::Sidekiq::JobSignal::ServerMiddleware
+ # OR
+ chain.add ::Sidekiq::JobSignal::ServerMiddleware, by_class: true
+ # OR
+ chain.add ::Sidekiq::JobSignal::ServerMiddleware, by_jid: false, by_class: true
end
Sidekiq::JobSignal.on_quit do |job|
Sidekiq.logger.info "Job was cancelled!"
Sidekiq.logger.info job
end
end
```
-If you like to enable the Sidekiq Web UI for quitting jobs, you can include the following in some kind of initialization file. This will enable a new "Signals" tab.
+If you'd like to enable the Sidekiq Web UI for quitting jobs, you can include the following in some kind of initialization file. This will enable a new "Signals" tab.
```rb
Sidekiq::Web.register Sidekiq::JobSignal::Web
```