sidekiq_monitor 0.1.2 → 0.1.3

data/README.md

@@ -122,6 +122,49 @@ The UI uses polling to update its data. By default, the polling interval is 3000
 Sidekiq::Monitor.options[:poll_interval] = 5000
 ```
 
+### UI Customization
+
+#### Custom Statuses
+
+The UI's status filter and histograms show the most common job statuses, but if you'd like to add additional statuses to them (for example, if you want to show "interrupted" jobs or have added custom statuses through middleware), you can make the UI include them like so:
+
+```ruby
+# config/initializers/sidekiq_monitor.rb
+Sidekiq::Monitor::Job.add_status('interrupted')
+```
+
+#### Custom Job Views
+
+When you click on a job, a modal showing its properties is displayed. You can add subviews to this modal by creating a view in your app and calling `Sidekiq::Monitor::CustomViews.add`, passing it the subview's title, the subview's filepath, and a block. The subview is only rendered if the block evaluates to true for the given job.
+
+If you need to add JavaScript for the subview, you can do so by adding an asset path to `Sidekiq::Monitor.options[:javascripts]`.
+
+For example, the following code adds a subview that shows a "Retry" button for jobs with the specified statuses:
+
+```ruby
+# config/initializers/sidekiq_monitor.rb
+view_path = Rails.root.join('app', 'views', 'sidekiq', 'monitor', 'retry').to_s
+Sidekiq::Monitor::CustomViews.add('My View Title', view_path) do |job|
+  %w{complete failed}.include?(job.status)
+end
+Sidekiq::Monitor.options[:javascripts] << 'sidekiq/monitor/retry'
+```
+
+```
+/ app/views/sidekiq/monitor/retry.slim
+a class='btn btn-success' href='#' data-action='retry_job' data-job-id=job.id = 'Retry'
+```
+
+```coffee
+# app/assets/javascripts/sidekiq/monitor/retry.js.coffee
+$ ->
+  $('body').on 'click', '.job-modal [data-action=retry_job]', (e) ->
+    id = $(e.target).attr('data-job-id')
+    $.get SidekiqMonitor.settings.api_url("jobs/retry/#{id}")
+    alert 'Job has been retried'
+    false
+```
+
 ### Authentication
 
 You'll likely want to restrict access to this interface in a production setting. To do this, you can use routing constraints:

data/app/datatables/sidekiq/monitor/jobs_datatable.rb

@@ -1,6 +1,6 @@
 module Sidekiq
   module Monitor
-    class JobsDatatable < AjaxDatatablesRails
+    class JobsDatatable < RailsDatatables
       include ActionView::Helpers::DateHelper
 
       @search_filters = []

data/lib/sidekiq/monitor.rb

@@ -1,6 +1,6 @@
 require 'slim'
 require 'jquery-datatables-rails'
-require 'ajax-datatables-rails'
+require 'rails-datatables'
 
 directory = File.dirname(File.absolute_path(__FILE__))
 Dir.glob("#{directory}/monitor/**/*.rb") { |file| require file }

data/lib/sidekiq/monitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Monitor
-    VERSION = '0.1.2'
+    VERSION = '0.1.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_monitor
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -60,7 +60,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ajax-datatables-rails
+  name: rails-datatables
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements: