sidekiq-redislog 0.0.1

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - 2.0.0
+branches:
+  only:
+    - master
+notifications:
+  email:
+    recipients:
+      - rpocklin@gmail.com
+matrix:
+  allow_failures:
+services:
+  - redis-server

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+## 0.0.1
+  * Integrated redis telnet monitor log to sidekiq web UI

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sidekiq-redislog.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-redislog (0.0.1)
+      sidekiq (>= 2.2.1)
+      sinatra
+      slim
+      sprockets
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    celluloid (0.14.0)
+      timers (>= 1.0.0)
+    connection_pool (1.0.0)
+    hike (1.2.2)
+    multi_json (1.7.3)
+    rack (1.4.5)
+    rack-protection (1.5.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.4)
+    redis (3.0.4)
+    redis-namespace (1.3.0)
+      redis (~> 3.0.0)
+    sidekiq (2.11.2)
+      celluloid (>= 0.13.0)
+      connection_pool (>= 1.0.0)
+      multi_json
+      redis (>= 3.0)
+      redis-namespace
+    sinatra (1.3.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.3)
+      tilt (~> 1.3, >= 1.3.3)
+    slim (1.3.8)
+      temple (~> 0.6.3)
+      tilt (~> 1.3.3)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    temple (0.6.4)
+    tilt (1.3.7)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test
+  rake
+  sidekiq-redislog!

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Marcelo Silveira
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,57 @@
+# Sidekiq::RedisLog [![Build Status](https://secure.travis-ci.org/rpocklin/sidekiq-redislog.png)](http://travis-ci.org/rpocklin/sidekiq-redislog)
+
+Displays a monitor window which echos the telnet status log of redis for sidekiq.  Autoscrolls.
+
+## Installation
+
+NOTE: Doesn't work with Webrick because it uses SSE (server-sent events) and Webrick is single-threaded.
+Works with Phusion Passenger / Thin / Puma / Rainbows and probably Unicorn.
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-redislog'
+```
+
+1. Start up your rails stack
+2. Navigate to '/sidekiq' (or your custom remapped route)
+3. Click 'redis' tab
+4. You will see activity (at the very least 'OK' should appear in the text area.)
+
+## Dependencies
+
+Depends on Sidekiq >= 2.2.1
+
+## Usage and Modes
+
+- When you run your app you will now see an additional tab 'Redis' in the sidekiq web console.
+- You can create activity by opening the other Sidekiq tabs (Dashboard/Workers/etc) in new browser tabs.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the MIT License. See the [LICENSE][license] file for further details.
+
+[license]: https://github.com/rpocklin/sidekiq-redislog/blob/master/LICENSE
+
+
+## TODO
+
+- XHR polling (< IE8 etc.)
+- Connect/Disconnect buttons since it consumes a thread for the poller.
+
+
+## Notes
+
+If you mount sidekiq to a non-standard route ie. mount Sidekiq::Web => '/admin/sidekiq' then you'll have to
+redirect the stream url (which javascript hits via SSE):
+  ```match '/sidekiq/redis_log_stream' => redirect('/admin/sidekiq/redis_log_stream')```
+  in ```routes.rb```
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/lib/sidekiq/redislog/redis_log_helper.rb

@@ -0,0 +1,39 @@
+module Sinatra
+  module RedisLogHelper
+    def set_sse_headers response
+
+      response.headers.delete('Content-Length') # no content length
+      response.headers['X-Accel-Buffering'] = 'no' # for nginx
+      response.headers["Connection"]    = "keepalive" #optimisation
+      response.headers["Cache-Control"] = "no-cache, no-store" #important for browsers
+      response.headers['Last-Modified'] = Time.now.to_s # #fixes buffering
+
+    end
+
+    def capture_redis stream, host = 'localhost', port = 6379, timeout = 30, command = 'MONITOR'
+
+      telnet_session = Net::Telnet::new("Host" => host,
+                                        "Port" => port,
+                                        "Timeout" => timeout)
+
+      telnet_session.cmd(command) do |data|
+        yield data if block_given?
+      end
+
+      telnet_session.close
+    end
+
+    def get_redis_config
+
+      config = {:host => 'localhost', :port => 6379}
+
+      Sidekiq.redis do |redis|
+        config[:host] = redis.client.host
+        config[:port] = redis.client.port
+      end
+
+      config
+
+    end
+  end
+end

data/lib/sidekiq/redislog/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module RedisLog
+    VERSION = "0.0.1"
+  end
+end

data/lib/sidekiq/redislog/views/sidekiq_redis_log.slim

@@ -0,0 +1,31 @@
+header.row
+  .span2
+    h3 Redis Log
+  .span10
+    textarea id="logger" style='width: 100%;' rows="20" cols='50' readonly="true"
+
+javascript:
+  var show_logs_for = function(event_channel, event_id, log_id) {
+
+    if (!!window.EventSource) {
+      source = new EventSource(event_channel); // match routes.rb
+
+      element = document.getElementById(log_id); // match template
+
+      source.addEventListener(event_id, function(e) {
+        //firefox has no 'data'
+        if (e.data) data = e.data; else data = e;
+
+        element.innerHTML += data + "\n";
+        element.scrollTop = element.scrollHeight;
+      });
+    }
+    else {
+      // Result to xhr polling :(  TODO
+    }
+  };
+
+  $(function() {
+    show_logs_for('/sidekiq/redis_log_stream', 'redis_log', 'logger')
+  });
+

data/lib/sidekiq/redislog/web_extension.rb

@@ -0,0 +1,29 @@
+module Sidekiq
+  module RedisLog
+    module WebExtension
+
+      def self.registered(app)
+
+        app.helpers Sinatra::RedisLogHelper
+
+        app.get "/redis" do
+          view_path = File.join(File.expand_path("..", __FILE__), "views")
+          render(:slim, File.read(File.join(view_path, "sidekiq_redis_log.slim")))
+        end
+
+        app.get "/redis_log_stream", provides: 'text/event-stream' do
+
+          set_sse_headers response
+          config = get_redis_config
+
+          stream :keep_open do |stream|
+            capture_redis stream, config[:host], config[:port] do |data|
+              stream << "event: redis_log\n"
+              stream << "data: #{data}\n\n"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/redislog.rb

@@ -0,0 +1,24 @@
+require "sidekiq/web"
+require "sidekiq/redislog/version"
+require "sidekiq/redislog/redis_log_helper"
+require "sidekiq/redislog/web_extension"
+
+module Sidekiq
+  module RedisLog
+  end
+end
+
+Sidekiq::Web.register Sidekiq::RedisLog::WebExtension
+
+if Sidekiq::Web.tabs.is_a?(Array)
+  # For sidekiq < 2.5
+  Sidekiq::Web.tabs << "redis"
+else
+  Sidekiq::Web.tabs["Redis"] = "redis"
+end
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::RedisLog::Middleware
+  end
+end

data/lib/sidekiq-redislog.rb

@@ -0,0 +1 @@
+require "sidekiq/redislog"

data/sidekiq-redis-log.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sidekiq/redislog/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Robert Pocklington"]
+  gem.email         = ["rpocklin@gmail.com"]
+  gem.description   = %q{View redis log for sidekiq on the web}
+  gem.summary       = %q{Allows you to monitor the redis log of sidekiq to track what is happening under the covers.}
+  gem.homepage      = "https://github.com/rpocklin/sidekiq-redislog/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sidekiq-redislog"
+  gem.require_paths = ["lib"]
+  gem.version       = Sidekiq::RedisLog::VERSION
+
+  gem.add_dependency "sidekiq", ">= 2.2.1"
+  gem.add_dependency "slim"
+  gem.add_dependency "sinatra"
+  gem.add_dependency "sprockets"
+
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rack-test"
+
+end

data/test/test_helper.rb

@@ -0,0 +1,14 @@
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+require "minitest/autorun"
+require "minitest/spec"
+require "minitest/mock"
+
+require "rack/test"
+require "sidekiq"
+require "sidekiq-redislog"
+
+Sidekiq.logger.level = Logger::ERROR
+
+REDIS = Sidekiq::RedisConnection.create(:url => "redis://localhost/15", :namespace => 'sidekiq_redis_log')

data/test/web_extension_test.rb

@@ -0,0 +1,37 @@
+require "test_helper"
+require "net/telnet"
+
+module Sidekiq
+  describe "RedisLog" do
+    include Rack::Test::Methods
+
+    def app
+      Sidekiq::Web
+    end
+
+    before do
+      Sidekiq.redis = REDIS
+      Sidekiq.redis {|c| c.flushdb }
+    end
+
+    it 'can display home with redis log tab' do
+      get '/redis'
+
+      last_response.status.must_equal 200
+      last_response.body.must_match /Sidekiq/
+      last_response.body.must_match /Redis/
+    end
+
+    ## NOTE: requires redis localhost:6379 running
+    it 'can capture redis log via telnet' do
+
+      null_stream = File.open(File::NULL, "w")
+
+      class RedisMonitor
+        include Sinatra::RedisLogHelper
+      end
+
+      RedisMonitor.new.capture_redis null_stream, 'localhost', 6379, 30, 'QUIT'
+    end
+ end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-redislog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Robert Pocklington
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: slim
+  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: sinatra
+  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: sprockets
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: View redis log for sidekiq on the web
+email:
+- rpocklin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/sidekiq-redislog.rb
+- lib/sidekiq/redislog.rb
+- lib/sidekiq/redislog/redis_log_helper.rb
+- lib/sidekiq/redislog/version.rb
+- lib/sidekiq/redislog/views/sidekiq_redis_log.slim
+- lib/sidekiq/redislog/web_extension.rb
+- sidekiq-redis-log.gemspec
+- test/test_helper.rb
+- test/web_extension_test.rb
+homepage: https://github.com/rpocklin/sidekiq-redislog/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1305450152839076812
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 1305450152839076812
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Allows you to monitor the redis log of sidekiq to track what is happening
+  under the covers.
+test_files:
+- test/test_helper.rb
+- test/web_extension_test.rb