sidekiq_monitor 0.0.8 → 0.0.9

data/README.md

@@ -87,11 +87,32 @@ class HardWorker
 
   def perform(user_ids)
     puts 'Doing hard work'
-    { processed_users_count: user_ids.length }
+    {
+      message: "#{user_ids.length} users processed",
+      processed_users_count: user_ids.length
+    }
   end
 end
 ```
 
+If you set `:message` as a key of this hash, that value will be displayed in the Result column of jobs tables in the UI. To view the full result hash of a job in the UI, click on the job status button to open up the modal job view.
+
+### Graph
+
+A single histogram will be shown by default in the Graph view, but you can also split the queues into multiple histograms. (This is especially useful if you have a large number of queues and the single histogram has too many bars to be readable.) The keys of this hash are JS regex patterns for matching queues, and the values of the hash will be the titles of each histogram:
+
+```ruby
+# config/initializers/sidekiq_monitor.rb
+Sidekiq::Monitor.options[:graphs] = {
+  'ALL' => 'All',
+  'OTHER' => 'Default Priority',
+  '_high$' => 'High Priority',
+  '_low$' => 'Low Priority'
+}
+```
+
+`ALL` and `OTHER` are special keys: `ALL` will show all queues and `OTHER` will show all queues that aren't matched by the regex keys.
+
 ### 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/assets/javascripts/sidekiq/monitor/graph.js.coffee

@@ -33,82 +33,107 @@ class SidekiqMonitor.Graph
     , @options.poll_interval
     
   render: =>
-    d3.json(SidekiqMonitor.settings.api_url('jobs/graph'), (data) =>
+    d3.json SidekiqMonitor.settings.api_url('jobs/graph'), (data) =>
 
       # Clear out the previously rendered graph 
       $(@options.selector).text('')
 
-      @svg = d3.select(@options.selector).append('svg:svg')
-          .attr('width', @width)
-          .attr('height', @height)
-        .append('svg:g')
-          .attr('transform', 'translate(' + @padding[3] + ',' + (@height - @padding[2]) + ')')
-
-      statuses = data.statuses
-      data = data.queues_status_counts
-
-      @color_scale.domain(statuses)
-
-      # Transpose the data into layers by queue
-      queues = d3.layout.stack()(statuses.map( (queue) =>
-        layers = []
-        for d in data
-          if d[queue]?
-            layers.push {x: d.queue, y: d[queue]+0}
-          else
-            layers.push {x: d.queue, y: 0}
-        layers
-      ))
-
-      # Compute the x-domain (by queue) and y-domain (by top).
-      @x_scale.domain(queues[0].map( (d) => d.x))
-      @y_scale.domain([0, d3.max(queues[queues.length - 1], (d) => d.y0 + d.y )])
-
-      # Groups for queues
-      queue = @svg.selectAll('g.queue')
-          .data(queues)
-        .enter().append('svg:g')
-          .attr('class', 'queue')
-          .style('fill', (d, i) => @z_scale(i) )
-          .style('stroke', (d, i) => d3.rgb(@z_scale(i)).darker() )
-
-      # Rects for queues
-      rect = queue.selectAll('rect')
-          .data(Object)
-        .enter().append('svg:rect')
-          .attr('x', (d) => @x_scale(d.x) )
-          .attr('y', (d) => -@y_scale(d.y0) - @y_scale(d.y) )
-          .attr('height', (d) => @y_scale(d.y) )
-          .attr('width', @x_scale.rangeBand())
-          .append('title')
-            .text((d) => if d.y == 1 then "#{d.y} job" else "#{d.y} jobs")
-
-      # Labels for queues
-      label = @svg.selectAll('text')
-          .data(@x_scale.domain())
-        .enter().append('foreignObject')
-          .attr('x', (d) => @x_scale(d) )
-          .attr('y', 6)
-          .attr('dy', '.71em')
+      queues = data.queues_status_counts.map (queues_status_count) -> queues_status_count.queue
+      graphs_config = SidekiqMonitor.settings.graphs || { 'ALL': null }
+      graphs_config = @standardize_graphs_config(graphs_config, queues)
+      
+      for index, graph_config of graphs_config
+        graph_config['show_legend'] = true if index == '0'
+        @render_graph(data, graph_config)
+
+  render_graph: (data, graph_config) =>
+    @svg = d3.select(@options.selector).append('svg:svg')
+        .attr('width', @width)
+        .attr('height', @height)
+      .append('svg:g')
+        .attr('transform', 'translate(' + @padding[3] + ',' + (@height - @padding[2]) + ')')
+
+    statuses = data.statuses
+    queues_status_counts = []
+    for queue_status_counts in data.queues_status_counts
+      if graph_config['queues'].indexOf(queue_status_counts.queue) > -1
+        queues_status_counts.push queue_status_counts
+    data = queues_status_counts
+    
+    @color_scale.domain(statuses)
+
+    # Transpose the data into layers by queue
+    queues = d3.layout.stack()(statuses.map( (queue) =>
+      layers = []
+      for d in data
+        if d[queue]?
+          layers.push {x: d.queue, y: d[queue]+0}
+        else
+          layers.push {x: d.queue, y: 0}
+      layers
+    ))
+
+    # Compute the x-domain (by queue) and y-domain (by top).
+    @x_scale.domain(queues[0].map( (d) => d.x))
+    @y_scale.domain([0, d3.max(queues[queues.length - 1], (d) => d.y0 + d.y )])
+
+    # Groups for queues
+    queue = @svg.selectAll('g.queue')
+        .data(queues)
+      .enter().append('svg:g')
+        .attr('class', 'queue')
+        .style('fill', (d, i) => @z_scale(i) )
+        .style('stroke', (d, i) => d3.rgb(@z_scale(i)).darker() )
+
+    # Rects for queues
+    rect = queue.selectAll('rect')
+        .data(Object)
+      .enter().append('svg:rect')
+        .attr('x', (d) => @x_scale(d.x) )
+        .attr('y', (d) => -@y_scale(d.y0) - @y_scale(d.y) )
+        .attr('height', (d) => @y_scale(d.y) )
+        .attr('width', @x_scale.rangeBand())
+        .append('title')
+          .text((d) => if d.y == 1 then "#{d.y} job" else "#{d.y} jobs")
+
+    # Labels for queues
+    label = @svg.selectAll('text')
+        .data(@x_scale.domain())
+      .enter().append('foreignObject')
+        .attr('x', (d) => @x_scale(d) )
+        .attr('y', 6)
+        .attr('dy', '.71em')
+        .attr('height', 20)
+        .attr('width', @x_scale.rangeBand())
+        .append('xhtml:div')
+          .text((d) => d)
+          .attr('style', 'font-size: 11px; text-align: center; word-wrap:break-word; padding: 0 3px')
+
+    # Y-axis rules
+    rule = @svg.selectAll('g.rule')
+        .data(@y_scale.ticks(5))
+      .enter().append('svg:g')
+        .attr('class', 'rule')
+        .attr('transform', (d) => 'translate(0,' + -@y_scale(d) + ')' )
+
+    rule.append('svg:text')
+        .attr('x', @width - @padding[1] - @padding[3] + 6)
+        .attr('dy', '.35em')
+        .text(d3.format(',d'))
+
+    # Title
+    if graph_config['title']
+      label = @svg.selectAll('g.text').data(['Test 1']).enter()
+        .append('text')
+          .attr('x', 0)
+          .attr('y', 90 - @height)
           .attr('height', 20)
-          .attr('width', @x_scale.rangeBand())
-          .append('xhtml:div')
-            .text((d) => d)
-            .attr('style', 'font-size: 11px; text-align: center; word-wrap:break-word; padding: 0 3px')
-
-      # Y-axis rules
-      rule = @svg.selectAll('g.rule')
-          .data(@y_scale.ticks(5))
-        .enter().append('svg:g')
-          .attr('class', 'rule')
-          .attr('transform', (d) => 'translate(0,' + -@y_scale(d) + ')' )
-
-      rule.append('svg:text')
-          .attr('x', @width - @padding[1] - @padding[3] + 6)
-          .attr('dy', '.35em')
-          .text(d3.format(',d'))
+          .attr('font-size', '24px')
+          .attr('fill', '#777')
+          .text(graph_config['title'])
 
-      # Legend
+    # Legend
+    if graph_config['show_legend']
       legend_x = @width - 130
       legend_y = 30 - @height
       legend_box_width = 18
@@ -142,7 +167,37 @@ class SidekiqMonitor.Graph
           .attr('y', legend_y + 9)
           .attr('dy', '.35em')
           .text((d) => d)
-    )
+
+  standardize_graphs_config: (graph_config, queues) =>
+    graphs = []
+    matched_queues = []
+    for pattern, title of graph_config
+      graph = {
+        title: title
+        pattern: pattern
+      }
+      if pattern == 'OTHER' || pattern == 'ALL'
+        graphs[pattern] = graph
+        continue
+      else
+        pattern_queues = []
+        for queue in queues
+          re = new RegExp(pattern, 'i')
+          if re.test(queue)
+            pattern_queues.push queue
+            matched_queues.push queue
+        graph['queues'] = pattern_queues
+      graphs[pattern] = graph
+    remaining_queues = @array_difference(queues, matched_queues)
+    graphs['OTHER']['queues'] = remaining_queues if graphs['OTHER']
+    graphs['ALL']['queues'] = queues if graphs['ALL']
+    @object_values(graphs)
+
+  array_difference: (array1, array2) =>
+    array1.filter (value) -> !(array2.indexOf(value) > -1)
+
+  object_values: (object) =>
+    value for key, value of object
 
 $ ->
   new SidekiqMonitor.Graph

data/app/assets/javascripts/sidekiq/monitor/initialize.js.coffee.erb

@@ -3,3 +3,4 @@ window.SidekiqMonitor =
   settings:
     api_url: (path) ->
       "<%= url_helpers.sidekiq_monitor_path %>api/#{path}"
+    graphs: <%= Sidekiq::Monitor.options[:graphs].to_json %>

data/lib/sidekiq/monitor/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Monitor
-    VERSION = '0.0.8'
+    VERSION = '0.0.9'
   end
 end

data/lib/sidekiq/monitor.rb

@@ -9,6 +9,18 @@ Dir.glob("#{directory}/../../app/datatables/sidekiq/monitor/jobs_datatable.rb")
 
 module Sidekiq
   module Monitor
+    DEFAULTS = {
+      :graphs => nil
+    }
+
+    def self.options
+      @options ||= DEFAULTS.dup
+    end
+
+    def self.options=(opts)
+      @options = opts
+    end
+
     def self.table_name_prefix
       'sidekiq_'
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_monitor
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq