Skip to content

Sidekiq Web UI extension for triggering job on ad-hoc basis

License

Notifications You must be signed in to change notification settings

marfoldi/sidekiq_adhoc_job

 
 

Repository files navigation

Sidekiq Adhoc Job for Sidekiq Web UI

This is an extension to the Sidekiq Web UI, which allows triggering jobs on adhoc basis.

Build Information

Build Status

Installation

gem install sidekiq_adhoc_job

Usage

To enable this extension, insert this piece of code in your app at the initialization stage:

require 'sidekiq_adhoc_job'

SidekiqAdhocJob.configure do |config|
  config.module_names = ['YourProject::Worker']
  config.strategy_name = :active_job
  config.load_paths = ['app/jobs/**/*.rb']
end
SidekiqAdhocJob.init

Options:

  • module_names (optional): takes in a list of module names that include the worker classes to be loaded. When not provided, or an empty list is provided, ALL worker classes loaded by your app will be included.
  • strategy_name (optional): takes a symbol representing the strategy to use to load worker classes
    • default (default): check for all classes that include Sidekiq::Worker
    • active_job: check for all classes that extend ActiveJob::Base
  • load_paths (required): takes in a list of file paths that the gem should load when initializing, in order to include the necessary classes in the app ObjectSpace

About

Sidekiq Web UI extension for triggering job on ad-hoc basis

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Ruby 94.5%
  • HTML 5.5%