JobsDashboard

JobsDashboard allows you to log all of your sidekiq jobs and provides an interface to visualize them.

Add this line to your application's Gemfile:

gem 'jobs_dashboard', git: 'https://github.com/9troisquarts/jobs_dashboard'

And then execute:

$ bundle install

Run the migration generator:

rails generate active_record:job_log_migration

Run the migration:

rails db:migrate

Set JobsDashboard::JobLogger as sidekiq default logger

# initializers/sidekiq.rb
require 'jobs_dashboard'

Sidekiq.configure_client do |config|
  # accepts :expiration (optional)
  JobsDashboard.configure_client_middleware config
end

Sidekiq.configure_server do |config|
  # accepts :expiration (optional)
  JobsDashboard.configure_server_middleware config

  # accepts :expiration (optional)
  JobsDashboard.configure_client_middleware config
end

Mount Engine to access web component:

# routes.rb
require 'jobs_dashboard/engine'

Rails.application.routes.draw do
  mount JobsDashboard::Engine, at: '/jobs_dashboard'
end

Set environment variable JOBS_DASHBOARD_AUTH_PASSWORD and JOBS_DASHBOARD_AUTH_USERNAME to activate the basic authentication

Options can be specified in worker's sidekiq_options with the key jobs_dashboard

  sidekiq_options jobs_dashboard: { skip: true }

In the job

include JobsDashboard::Worker
# add log line
add_job_log_line(value)

# add metadata
add_job_metadata(key, value)

Custom attribute can be added on the jobs_dashboard_job_logs table

include JobsDashboard::Worker
add_log_line(message)

Si vous souhaitez ajouter un champ a tous les jobs qui sera utilisé comme filtre / colonnes, suivez les instructions ci dessous :

bundle exec rails g migration add_{{attribute_name}}_to_jobs_dashboard_job_logs

In an initializer

JobsDashboard.setup do |config|
  config.additional_params = [
    {
      attribute_name: 'attribute_name',
      title: 'Title displayed on column header and more'
    }
  ]
end

In the job

include JobsDashboard::Worker
set_job_parameter(attribute_name, value)

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jobs_dashboard.

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