sidekiq-spy 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7a20cacb912beed5baf1c80012a87e5115dae2bf
-  data.tar.gz: 1db3848aa6af319f5037ee72dc6720683735d53d
+  metadata.gz: 91574e1eabbcadaf02cc6fe5e70e3031e7022b33
+  data.tar.gz: da4ab6eb49ee18c42665a627abc08df7529e4972
 SHA512:
-  metadata.gz: ed49f93281287bbc32d5a5b7629a85d5489e50e35bbae88e16369e764644d87f697593c610a5e149e65d9a4aff8041dc902b2901782d4b2e061e7930e8bc0cef
-  data.tar.gz: d16b91fb061442fb4ec76ed66e415cb10e3ab5776bab6b7c77e5893c88d666072c09559b35870b222151a68005a22f5332be5e57b9aad0a7ce06a014d54a38ed
+  metadata.gz: 49c09665f4349ada057861bb8d9f02dbd2a473ea33ad4fc0843613d03429228fc707b1dae3fb5a5c092d7a9725c5b9e6d4a55a17698a99cf98dc9573c7e2c36a
+  data.tar.gz: 0b80737bf8f199ff2be3daa6e41746438ee55033d23926c106f9228fdad43a58476bcf4020c4eb41206a564a84197c9a6660e38a2639f2821b94a35aa0565736

data/.travis.yml

@@ -1,16 +1,14 @@
 language: ruby
 rvm:
+  - 2.0.0
   - 1.9.3
   - jruby-19mode
   - rbx-19mode
-  - 2.0.0
 notifications:
   email:
     recipients:
       - tp@tiredpixel.com
-      - sidekiq.spy@librelist.com
 matrix:
   allow_failures:
-    - rvm: 1.9.3
     - rvm: jruby-19mode
     - rvm: rbx-19mode

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Sidekiq Spy Changelog
+
+This changelog documents the main changes between released versions.
+For a full list of changes, consult the commit history.
+For many of commits by [tiredpixel](http://www.tiredpixel.com), the commit
+message provides information and examples.
+
+
+## 0.1.0
+
+- first release
+- `sidekiq-spy` executable providing: `--url`, `--host`, `--port`, `--database`,
+  `--namespace`, `--interval`, `--help`, `--version`
+- core Redis statistics: redis, namespace, redis version, uptime (d),
+  connections, memory, memory peak
+- core Sidekiq statistics: busy, retries, processed, enqueued, scheduled, failed
+
+
+## 0.2.0
+
+- test fixes for Ruby 1.9.3, which is supported along with Ruby 2.0.0
+- a plethora of tests; most of the core is now covered
+- command-loop to handle key presses
+- `<q>` for quit (in addition to existing `<ctrl>+<c>`)
+- smaller sleep increments for faster exit
+- content overrun fix
+- workers panel (like `Sidekiq::Web` Workers tab), reporting who is up to what

data/README.md

@@ -1,9 +1,8 @@
 # Sidekiq Spy
 
 [![Gem Version](https://badge.fury.io/rb/sidekiq-spy.png)](http://badge.fury.io/rb/sidekiq-spy)
-[![Build Status](https://travis-ci.org/tiredpixel/sidekiq-spy.png?branch=master,develop)](https://travis-ci.org/tiredpixel/sidekiq-spy)
+[![Build Status](https://travis-ci.org/tiredpixel/sidekiq-spy.png?branch=master,stable)](https://travis-ci.org/tiredpixel/sidekiq-spy)
 [![Code Climate](https://codeclimate.com/github/tiredpixel/sidekiq-spy.png)](https://codeclimate.com/github/tiredpixel/sidekiq-spy)
-[![Coverage Status](https://coveralls.io/repos/tiredpixel/sidekiq-spy/badge.png?branch=master,develop)](https://coveralls.io/r/tiredpixel/sidekiq-spy)
 
 [Sidekiq](https://github.com/mperham/sidekiq) monitoring in the console.
 A bit like Sidekiq::Web. But without the web.
@@ -13,8 +12,9 @@ see how your workers are doing at-a-glance when SSHed into a remote box with
 no web server, this one's for you. <3
 
 This project is so hot out of the oven you might need mitts. But it's already
-functional, with the main statistics from the Sidekiq::Web homepage. In time,
-it would be nice to add the Workers, Queues, Retries, and Scheduled tabs, too.
+functional, with the main statistics from the Sidekiq::Web homepage and the
+Workers tab. In time, it would be nice to add the Queues, Retries, and
+Scheduled tabs, too.
 
 More sleep lost by [tiredpixel](http://www.tiredpixel.com).
 
@@ -50,18 +50,25 @@ We won't tell anyone! ;) (Resque is awesome, too!)
 
     $ sidekiq-spy -n resque
 
-That's about it.
+To quit, press `<q>` or `<ctrl>+<c>`. That's about it.
 
 
 ## ASCII Art (a.k.a. Screenshot)
 
-    Sidekiq Spy 0.0.1                       |                         01:02:58 +0100
+    Sidekiq Spy 0.2.0                                                 16:17:23 +0000
     redis:                               127.0.0.1:6379/0|namespace:
-    redis version:      2.6.11|uptime (d):              8|connections:             3
-    memory:              4.84M|memory peak:        13.52M|
+    redis version:      2.6.11|uptime (d):              2|connections:             5
+    memory:              4.89M|memory peak:         5.03M|
 
-    busy:                    0|retries:                 0|processed:            1304
-    enqueued:                0|scheduled:               0|failed:               1236
+    busy:                    5|retries:                15|processed:            1623
+    enqueued:                0|scheduled:               0|failed:               1535
+
+    WORKER                      QUEUE         CLASS         ARGUMENTS        STARTED
+    sep.da.local:17045-70130396 default       MakeSEPFields [2670]        2013-11-03
+    sep.da.local:17045-70130397 default       MakeSEPFields [2668]        2013-11-03
+    sep.da.local:17045-70130396 default       MakeSEPFields [2669]        2013-11-03
+    sep.da.local:17045-70130397 default       MakeSEPFields [2667]        2013-11-03
+    sep.da.local:17045-70130396 default       MakeSEPFields [2671]        2013-11-03
 
 
 ## Stay Tuned
@@ -77,8 +84,6 @@ That was easy.
 
 Dear Me, Here is a vague wishlist:
 
-- more tests for the display parts
-- Workers table on main page
 - Queues page
 - Retries page
 - Scheduled page

data/lib/sidekiq-spy.rb

@@ -5,7 +5,13 @@ require File.expand_path('../sidekiq-spy/translatable', __FILE__)
 require File.expand_path('../sidekiq-spy/app', __FILE__)
 
 require File.expand_path('../sidekiq-spy/spy/stats', __FILE__)
+require File.expand_path('../sidekiq-spy/spy/workers', __FILE__)
 
 require File.expand_path('../sidekiq-spy/display/screen', __FILE__)
 require File.expand_path('../sidekiq-spy/display/panel', __FILE__)
 require File.expand_path('../sidekiq-spy/display/subpanel', __FILE__)
+
+require File.expand_path('../sidekiq-spy/display/panels/header', __FILE__)
+require File.expand_path('../sidekiq-spy/display/panels/redis_stats', __FILE__)
+require File.expand_path('../sidekiq-spy/display/panels/sidekiq_stats', __FILE__)
+require File.expand_path('../sidekiq-spy/display/panels/workers', __FILE__)

data/lib/sidekiq-spy/app.rb

@@ -1,13 +1,17 @@
+require 'thread'
 require 'sidekiq'
 
 
 module SidekiqSpy
   class App
     
+    REFRESH_SUBINTERVAL = 0.1
+    
     attr_reader :running
     
     def initialize
-      @running     = false
+      @running = false
+      @threads = {}
     end
     
     def config
@@ -26,17 +30,15 @@ module SidekiqSpy
         
         setup
         
-        while @running do
-          refresh
-          
-          @sleep_timer = config.interval
-          
-          while @running && @sleep_timer > 0
-            sleep 1
-            
-            @sleep_timer -= 1
-          end
+        @threads[:command] ||= Thread.new do
+          command_loop # listen for commands
+        end
+        
+        @threads[:refresh] ||= Thread.new do
+          refresh_loop # refresh frequently
         end
+        
+        @threads.each { |tname, t| t.join }
       ensure
         cleanup
       end
@@ -46,6 +48,13 @@ module SidekiqSpy
       @running = false
     end
     
+    def do_command(key)
+      case key
+      when 'q' # quit
+        @running = false
+      end
+    end
+    
     private
     
     def configure_sidekiq
@@ -58,12 +67,40 @@ module SidekiqSpy
       end
     end
     
+    def command_loop
+      while @running do
+        key = next_key
+        
+        next unless key # keep listening if timeout
+        
+        do_command(key)
+      end
+    end
+    
+    def refresh_loop
+      while @running do
+        refresh
+        
+        @sleep_timer = config.interval
+        
+        while @running && @sleep_timer > 0
+          sleep REFRESH_SUBINTERVAL
+          
+          @sleep_timer -= REFRESH_SUBINTERVAL
+        end
+      end
+    end
+    
     def setup
       @screen = Display::Screen.new
     end
     
     def refresh
-      @screen.refresh
+      @screen.refresh if @screen
+    end
+    
+    def next_key
+      @screen.next_key if @screen
     end
     
     def cleanup

data/lib/sidekiq-spy/display/panel.rb

@@ -5,7 +5,16 @@ module SidekiqSpy
   module Display
     class Panel
       
-      def initialize(height, width, top, left, structure, opts = {})
+      include Translatable
+      
+      attr_reader :height
+      attr_reader :width
+      attr_reader :top
+      attr_reader :left
+      attr_reader :dividers
+      attr_reader :divider_length
+      
+      def initialize(height, width, top, left, structure = [], opts = {})
         @height = height
         @width  = width
         @top    = top

data/lib/sidekiq-spy/display/panels/header.rb

@@ -0,0 +1,25 @@
+module SidekiqSpy
+  module Display
+    module Panels
+      class Header < Display::Panel
+        
+        def initialize(height, width, top, left)
+          super(height, width, top, left, structure)
+        end
+        
+        def structure
+          # [
+          #   [relative_column_width, data_left, data_right]
+          # ]
+          [
+            [
+              [1, t[:program], nil],
+              [1, nil,         -> { Time.now.strftime("%T %z") }],
+            ],
+          ]
+        end
+        
+      end
+    end
+  end
+end

data/lib/sidekiq-spy/display/panels/redis_stats.rb

@@ -0,0 +1,37 @@
+module SidekiqSpy
+  module Display
+    module Panels
+      class RedisStats < Display::Panel
+        
+        def initialize(height, width, top, left)
+          super(height, width, top, left, structure, :divider_r => "|")
+        end
+        
+        def structure
+          stats = Spy::Stats.new
+          
+          # [
+          #   [relative_column_width, data_left, data_right]
+          # ]
+          [
+            [
+              [2, t[:redis][:connection], -> { stats.connection }],
+              [1, t[:redis][:namespace],  -> { stats.namespace }],
+            ],
+            [
+              [1, t[:redis][:version],     -> { stats.redis_version }],
+              [1, t[:redis][:uptime],      -> { stats.uptime }],
+              [1, t[:redis][:connections], -> { stats.connections }],
+            ],
+            [
+              [1, t[:redis][:memory],      -> { stats.memory }],
+              [1, t[:redis][:memory_peak], -> { stats.memory_peak }],
+              [1, nil,                     nil],
+            ],
+          ]
+        end
+        
+      end
+    end
+  end
+end

data/lib/sidekiq-spy/display/panels/sidekiq_stats.rb

@@ -0,0 +1,33 @@
+module SidekiqSpy
+  module Display
+    module Panels
+      class SidekiqStats < Display::Panel
+        
+        def initialize(height, width, top, left)
+          super(height, width, top, left, structure, :divider_r => "|")
+        end
+        
+        def structure
+          stats = Spy::Stats.new
+          
+          # [
+          #   [relative_column_width, data_left, data_right]
+          # ]
+          [
+            [
+              [1, t[:sidekiq][:busy],      -> { stats.busy }],
+              [1, t[:sidekiq][:retries],   -> { stats.retries }],
+              [1, t[:sidekiq][:processed], -> { stats.processed }],
+            ],
+            [
+              [1, t[:sidekiq][:enqueued],  -> { stats.enqueued }],
+              [1, t[:sidekiq][:scheduled], -> { stats.scheduled }],
+              [1, t[:sidekiq][:failed],    -> { stats.failed }],
+            ],
+          ]
+        end
+        
+      end
+    end
+  end
+end

data/lib/sidekiq-spy/display/panels/workers.rb

@@ -0,0 +1,50 @@
+module SidekiqSpy
+  module Display
+    module Panels
+      class Workers < Display::Panel
+        
+        def initialize(height, width, top, left)
+          @height = height # #structure needs this before #initialize ends
+          
+          super(height, width, top, left, structure, :divider_r => " ")
+        end
+        
+        def refresh
+          @workers.refresh # refresh data feed
+          
+          super
+        end
+        
+        def structure
+          @workers = Spy::Workers.new
+          
+          # [
+          #   [relative_column_width, data_left, data_right]
+          # ]
+          s = [
+            [ # table header slots
+              [2, t[:heading][:worker], nil],
+              [1, t[:heading][:queue],  nil],
+              [1, t[:heading][:class],  nil],
+              [1, t[:heading][:args],   nil],
+              [1, nil,                  t[:heading][:started_at]],
+            ],
+          ]
+          
+          (0...(@height - 1)).each do |i|
+            s << [ # table row slots
+              [2, -> { @workers.data.values[i][:name] rescue nil },  nil],
+              [1, -> { @workers.data.values[i][:queue] rescue nil }, nil],
+              [1, -> { @workers.data.values[i][:class] rescue nil }, nil],
+              [1, -> { @workers.data.values[i][:args] rescue nil },  nil],
+              [1, nil,                                               -> { @workers.data.values[i][:started_at] rescue nil }],
+            ]
+          end
+          
+          s
+        end
+        
+      end
+    end
+  end
+end

data/lib/sidekiq-spy/display/screen.rb

@@ -5,19 +5,26 @@ module SidekiqSpy
   module Display
     class Screen
       
-      include Translatable
+      CURSES_GETCH_TIMEOUT = 100
+      
+      attr_reader :height
+      attr_reader :width
       
       def initialize
         Curses.init_screen
         Curses.nl
         Curses.noecho
         Curses.curs_set(0)
+        Curses.timeout = CURSES_GETCH_TIMEOUT
         
         @height = Curses.lines
         @width  = Curses.cols
         
-        @panels = {
-          :header => panel_header,
+        @panels = { # attach panels, defining height, width, top, left
+          :header        => Display::Panels::Header.new(      1,             @width, 0, 0),
+          :redis_stats   => Display::Panels::RedisStats.new(  3,             @width, 1, 0),
+          :sidekiq_stats => Display::Panels::SidekiqStats.new(2,             @width, 5, 0),
+          :workers       => Display::Panels::Workers.new(     (@height - 8), @width, 8, 0),
         }
       end
       
@@ -31,50 +38,8 @@ module SidekiqSpy
         @panels.each { |pname, panel| panel.refresh }
       end
       
-      private
-      
-      def panel_header
-        stats = Spy::Stats.new
-        
-        structure = [
-          [
-            [1, t[:program], nil],
-            [1, nil,         -> { Time.now.strftime("%T %z") }],
-          ],
-          [
-            [2, t[:redis][:connection], -> { stats.connection }],
-            [1, t[:redis][:namespace],  -> { stats.namespace }],
-          ],
-          [
-            [1, t[:redis][:version],     -> { stats.redis_version }],
-            [1, t[:redis][:uptime],      -> { stats.uptime }],
-            [1, t[:redis][:connections], -> { stats.connections }],
-          ],
-          [
-            [1, t[:redis][:memory],      -> { stats.memory }],
-            [1, t[:redis][:memory_peak], -> { stats.memory_peak }],
-            [1, nil,                     nil],
-          ],
-          nil,
-          [
-            [1, t[:sidekiq][:busy],      -> { stats.busy }],
-            [1, t[:sidekiq][:retries],   -> { stats.retries }],
-            [1, t[:sidekiq][:processed], -> { stats.processed }],
-          ],
-          [
-            [1, t[:sidekiq][:enqueued],  -> { stats.enqueued }],
-            [1, t[:sidekiq][:scheduled], -> { stats.scheduled }],
-            [1, t[:sidekiq][:failed],    -> { stats.failed }],
-          ],
-          nil,
-        ]
-        
-        opts = {
-          :divider_l => t[:divider][:left],
-          :divider_r => t[:divider][:right],
-        }
-        
-        Display::Panel.new(structure.length, @width, 0, 0, structure, opts)
+      def next_key
+        Curses.getch
       end
       
     end