Sidekiq Spy

Sidekiq monitoring in the console. A bit like Sidekiq::Web. But without the web.

So, Sidekiq is a beautiful thing. :) But if you know the sadness of wanting to 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 and the Workers, Queues, Retries, and Scheduled tabs.

More sleep lost by tiredpixel.

ASCII Art (a.k.a. Screenshot)

Sidekiq Spy 0.3.0    WORKERS qUeues Retries Scheduled             16:17:23 +0000
redis:                               127.0.0.1:6379/0|namespace:
redis version:      2.6.11|uptime (d):              2|connections:             5
memory:              4.89M|memory peak:         5.03M|

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

Installation

Install using:

$ gem install sidekiq-spy

The default Ruby version supported is defined in .ruby-version. Any other versions supported are defined in .travis.yml.

Usage

View the available options:

$ sidekiq-spy --help

If you're connecting to redis://127.0.0.1:6379/0 with no namespace you can simply:

$ sidekiq-spy

To use a connection string URL:

$ sidekiq-spy -u redis://da.example.com:237/42

Or, if you prefer your options like your Hi-Fi:

$ sidekiq-spy -h da.example.com -p 237 -d 42

Maybe you're using Resque? Sssh! We won't tell anyone! ;) (Resque is awesome, too!)

$ sidekiq-spy -n resque

Navigate between tabs using the <w>, <u>, <r>, <s> keys.

To quit, press <q> or <ctrl>+<c>. That's about it.

Stay Tuned

We have a Librelist mailing list! To subscribe, send an email to sidekiq.spy@librelist.com. To unsubscribe, send an email to sidekiq.spy-unsubscribe@librelist.com. There be archives. That was easy.

Growing Like Flowers

Dear Me, Here is a vague wishlist:

• Queue (not Queues) page
• Retry (not Retries) page
• Paginated data
• a little control to go with your monitoring, maybe...

Contributions

Contributions are embraced with much love and affection! Please fork the repository and wizard your magic, preferably with plenty of fairy-dust sprinkled over the tests. ;) Then send me a pull request. Simples! If you'd like to discuss what you're doing or planning to do, or if you get stuck on something, then just wave. :)

Do whatever makes you happy. We'll probably still like you. :)

Tests are written using minitest, which is included by default in Ruby 1.9 onwards. To run all tests:

rake test

Or, if you're of that turn of mind, use TURN (gem install turn):

turn test/sidekiq-spy/

Blessing

May you find peace, and help others to do likewise.

Licence

© tiredpixel 2013. It is free software, released under the MIT License, and may be redistributed under the terms specified in LICENSE.