sidekiq_monitor 0.0.3 → 0.0.4

data/README.md

@@ -4,7 +4,7 @@ Advanced monitoring for Sidekiq
 
 Description
 -----------
-Sidekiq Monitor offers a detailed, malleable UI for monitoring Sidekiq jobs.
+Sidekiq Monitor offers a detailed UI for monitoring Sidekiq jobs, letting you filter, search, and sort jobs by many attributes, view error backtraces, set job completion metadata, and more.
 
 It lets you:
 
@@ -30,6 +30,12 @@ And it looks like this:
 
 [<img src="https://raw.github.com/socialpandas/sidekiq_monitor/master/examples/screenshot.png" />](https://raw.github.com/socialpandas/sidekiq_monitor/master/examples/screenshot.png)
 
+Sidekiq Monitor stores jobs using ActiveRecord, allowing you to perform complex queries and delete specific collections of jobs:
+
+```ruby
+Sidekiq::Monitor::Job.where(queue: 'user_update').where('enqueued_at > ?', 2.days.ago).destroy_all
+```
+
 Installation
 ------------
 

data/app/assets/javascripts/sidekiq/monitor/abstract_jobs_table.js.coffee

@@ -58,8 +58,8 @@ class SidekiqMonitor.AbstractJobsTable
       @show_job(job)
       false
     @table.on 'click', '.retry-job', (e) =>
-      jid = $(e.target).attr('data-job-jid')
-      $.getJSON SidekiqMonitor.settings.api_url('jobs/retry?jid='+jid), =>
+      id = $(e.target).attr('data-job-id')
+      $.getJSON SidekiqMonitor.settings.api_url('jobs/retry/'+id), =>
         @reload_table()
       false
 
@@ -77,8 +77,10 @@ class SidekiqMonitor.AbstractJobsTable
   show_job: (job) =>
     return false if !job?
     
+    id = job[@columns.id]
     jid = job[@columns.jid]
     class_name = job[@columns.class_name]
+    name = job[@columns.name]
     started_at = job[@columns.started_at]
     duration = job[@columns.duration]
     status = job[@columns.status]
@@ -122,9 +124,13 @@ class SidekiqMonitor.AbstractJobsTable
               <th>Class</th>
               <td>#{class_name}</td>
             </tr>
+            <tr>
+              <th>Name</th>
+              <td>#{name}</td>
+            </tr>
             <tr>
               <th>Args</th>
-              <td>#{args}</td>
+              <td>#{JSON.stringify(args, null, 2)}</td>
             </tr>
             <tr>
               <th>Started</th>
@@ -140,12 +146,23 @@ class SidekiqMonitor.AbstractJobsTable
             </tr>
           </table>
           #{result_html}
+          <div class="job-custom-views"></div>
         </div>
       </div>
     """
     $('.job-modal').modal('hide')
     $('body').append(modal_html)
-    $('.job-modal:last').modal()
+    modal = $('.job-modal:last')
+    modal.modal
+      width: 480
+    $.getJSON SidekiqMonitor.settings.api_url("jobs/custom_views/#{id}"), (views) ->
+      html = ''
+      for view in views
+        html += """
+          <h4>#{view['name']}</h4>
+          #{view['html']}
+        """
+      $('.job-custom-views', modal).html(html)
 
   on_poll: =>
     @reload_table()

data/app/assets/javascripts/sidekiq/monitor/jobs_table.js.coffee

@@ -4,18 +4,20 @@ class SidekiqMonitor.JobsTable extends SidekiqMonitor.AbstractJobsTable
     options =
       table_selector: 'table.jobs'
       columns:
-        jid: 0
-        queue: 1
-        class_name: 2
-        name: 3
-        enqueued_at: 4
-        started_at: 5
-        duration: 6
-        message: 7
-        status: 8
-        result: 9
-        args: 10
+        id: 0
+        jid: 1
+        queue: 2
+        class_name: 3
+        name: 4
+        enqueued_at: 5
+        started_at: 6
+        duration: 7
+        message: 8
+        status: 9
+        result: 10
+        args: 11
       column_options: [
+        { bVisible: false }
         { bVisible: false }
         null
         null
@@ -44,7 +46,7 @@ class SidekiqMonitor.JobsTable extends SidekiqMonitor.AbstractJobsTable
                 'info'
             html = """<a href="#" class="btn btn-#{class_name} btn-mini status-value">#{oObj.aData[@columns.status]}</a>"""
             if status == 'failed'
-              html += """<a href="#" class="btn btn-mini btn-primary retry-job" data-job-jid="#{oObj.aData[0]}">Retry<a>"""
+              html += """<a href="#" class="btn btn-mini btn-primary retry-job" data-job-id="#{oObj.aData[@columns.id]}">Retry<a>"""
             """<span class="action-buttons">#{html}</span>"""
         }
         { bVisible: false }

data/app/assets/javascripts/sidekiq/monitor/queue_jobs_table.js.coffee

@@ -4,18 +4,20 @@ class SidekiqMonitor.QueuesTable extends SidekiqMonitor.AbstractJobsTable
     options =
       table_selector: 'table.queue-jobs'
       columns:
-        jid: 0
-        queue: 1
-        class_name: 2
-        name: 3
-        enqueued_at: 4
-        started_at: 5
-        duration: 6
-        message: 7
-        status: 8
-        result: 9
-        args: 10
+        id: 0
+        jid: 1
+        queue: 2
+        class_name: 3
+        name: 4
+        enqueued_at: 5
+        started_at: 6
+        duration: 7
+        message: 8
+        status: 9
+        result: 10
+        args: 11
       column_options: [
+        { bVisible: false }
         { bVisible: false }
         { bVisible: false }
         null
@@ -44,7 +46,7 @@ class SidekiqMonitor.QueuesTable extends SidekiqMonitor.AbstractJobsTable
                 'info'
             html = """<a href="#" class="btn btn-#{class_name} btn-mini status-value">#{oObj.aData[@columns.status]}</a>"""
             if status == 'failed'
-              html += """<a href="#" class="btn btn-mini btn-primary retry-job" data-job-jid="#{oObj.aData[0]}">Retry<a>"""
+              html += """<a href="#" class="btn btn-mini btn-primary retry-job" data-job-id="#{oObj.aData[@columns.id]}">Retry<a>"""
             """<span class="action-buttons">#{html}</span>"""
         }
         { bVisible: false }

data/app/controllers/sidekiq/monitor/api/jobs_controller.rb

@@ -8,11 +8,25 @@ module Sidekiq
           render json: JobsDatatable.new(view_context)
         end
 
+        def custom_views
+          job = Job.find(params[:id])
+          render json: {}, status: 404 and return if job.blank?
+
+          views = CustomViews.for_job(job)
+          views = views.collect do |view|
+            {
+              name: view[:name],
+              html: render_to_string(view[:path], locals: {job: job, path: view[:path]})
+            }
+          end
+          render json: views, status: :ok
+        end
+
         def retry
-          jid = params[:jid]
-          render json: {}, status: 404 and return if jid.blank?
+          id = params[:id]
+          render json: {}, status: 404 and return if id.blank?
 
-          job = Job.find_by_jid(jid)
+          job = Job.find(id)
           render json: {}, status: 404 and return if job.blank?
 
           args = job.args

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

@@ -6,6 +6,7 @@ module Sidekiq
       def initialize(view)
         @model_name = Sidekiq::Monitor::Job
         @columns = [
+          'sidekiq_jobs.id',
           'sidekiq_jobs.jid',
           'sidekiq_jobs.queue',
           'sidekiq_jobs.class_name',
@@ -33,6 +34,7 @@ module Sidekiq
       def data
         jobs.map do |job|
           [
+            job.id,
             job.jid,
             job.queue,
             job.class_name,

data/app/views/sidekiq/monitor/jobs/_jobs.slim

@@ -1,6 +1,7 @@
 table class="jobs-table jobs table table-hover table-bordered table-striped table-white" data-source="#{root_path}api/jobs"
   thead
     th ID
+    th JID
     th Queue
     th Class
     th Name

data/app/views/sidekiq/monitor/queues/_jobs.slim

@@ -1,6 +1,7 @@
 table class="jobs-table queue-jobs table table-hover table-bordered table-striped table-white" data-source="#{root_path}api/jobs"
   thead
     th ID
+    th JID
     th Queue
     th Class
     th Name

data/config/routes.rb

@@ -4,7 +4,7 @@ Sidekiq::Monitor::Engine.routes.draw do
   
   namespace 'api' do
     match '/jobs' => 'jobs#index'
-    match '/jobs/:action' => 'jobs'
+    match '/jobs/:action(/:id)' => 'jobs'
     match '/queues/:queue' => 'queues#show'
   end
 end

data/lib/sidekiq/monitor.rb

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

data/lib/sidekiq/monitor/custom_views.rb

@@ -0,0 +1,26 @@
+module Sidekiq
+  module Monitor
+    class CustomViews
+      @views = []
+
+      class << self
+        def add(name, path, &block)
+          @views << {
+            name: name,
+            path: path,
+            filter: block
+          }
+        end
+
+        def for_job(job)
+          views = []
+          @views.each do |view|
+            is_valid = view[:filter].call(job)
+            views << view.dup if is_valid
+          end
+          views
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/monitor/processor.rb

@@ -19,6 +19,7 @@ module Sidekiq
       def start(worker, msg, queue)
         jid = msg['jid']
         args = msg['args']
+        now = DateTime.now
         job = Sidekiq::Monitor::Job.find_by_jid(jid)
         if job.blank?
           name = job_name(worker.class, args)
@@ -28,11 +29,12 @@ module Sidekiq
             class_name: worker.class.name,
             args: args,
             retry: msg['retry'],
+            enqueued_at: now,
             name: name
           )
         end
         job.update_attributes(
-          started_at: DateTime.now,
+          started_at: now,
           status: 'running'
         )
       end

data/lib/sidekiq/monitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Monitor
-    VERSION = '0.0.3'
+    VERSION = '0.0.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_monitor
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-06 00:00:00.000000000 Z
+date: 2013-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-datatables-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ajax-datatables-rails
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +115,7 @@ files:
 - lib/generators/sidekiq/monitor/install/templates/create_sidekiq_jobs.rb
 - lib/sidekiq/monitor/cleaner.rb
 - lib/sidekiq/monitor/client/middleware.rb
+- lib/sidekiq/monitor/custom_views.rb
 - lib/sidekiq/monitor/engine.rb
 - lib/sidekiq/monitor/processor.rb
 - lib/sidekiq/monitor/server/middleware.rb