sidekiq-redis-logger 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Alex Coomans
+
+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,29 @@
+# Sidekiq::Redis::Logger
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sidekiq-redis-logger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-redis-logger
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sidekiq-redis-logger.rb

@@ -0,0 +1 @@
+require "sidekiq/redis-logger"

data/lib/sidekiq/redis-logger.rb

@@ -0,0 +1,20 @@
+require "sidekiq/web"
+require "sidekiq/redis-logger/logger"
+require "sidekiq/redis-logger/middleware"
+require "sidekiq/redis-logger/version"
+require "sidekiq/redis-logger/web_extension"
+
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.insert_before Sidekiq::Middleware::Server::Logging, Sidekiq::RedisLogger::Middleware
+  end
+  config.logger = Sidekiq::RedisLogger::Logger.new(Sidekiq::Logging.logger)
+end
+
+if Sidekiq::Web.tabs.is_a?(Array)
+  # For sidekiq < 2.5
+  Sidekiq::Web.tabs << "logs"
+else
+  Sidekiq::Web.tabs["Logs"] = "logs"
+end
+Sidekiq::Web.register Sidekiq::RedisLogger::WebExtension

data/lib/sidekiq/redis-logger/logger.rb

@@ -0,0 +1,111 @@
+require 'logger'
+
+module Sidekiq
+  module RedisLogger
+    class Logger
+      include ::Logger::Severity
+
+      class Pretty < ::Logger::Formatter
+        # Provide a call() method that returns the formatted message.
+        def call(severity, time, program_name, message)
+          "#{time.utc.iso8601} #{Process.pid} TID-#{Thread.current.object_id.to_s(36)}#{context} #{severity}: #{message}\n"
+        end
+
+        def context
+          c = Thread.current[:sidekiq_context]
+          c ? " #{c}" : ''
+        end
+      end
+
+      def self.with_jid_context(jid)
+        begin
+          Thread.current[:sidekiq_jid] = jid
+          yield
+        ensure
+          Thread.current[:sidekiq_jid] = nil
+        end
+      end
+
+      # alt is an extra output
+      def initialize(alt = nil, limit = 10000)
+        @formatter = Pretty.new
+        @alt = alt
+        @limit = limit
+        @level = INFO
+      end
+
+      def add(severity, message = nil, progname = nil, &block)
+        severity ||= UNKNOWN
+        return true if severity < @level
+        if message.nil?
+          if block_given?
+            message = yield
+          else          
+            message = progname
+            progname = nil
+          end
+        end
+        msg = format_message(format_severity(severity), Time.now, progname, message)
+        Sidekiq.redis do |conn|
+          jid = Thread.current[:sidekiq_jid]
+          conn.lpush("logger:#{jid}", msg) if jid
+          conn.expire("logger:#{jid}", 20 * 60) if jid
+          conn.lpush("logger", msg)
+          conn.ltrim("logger", 0, @limit - 1)
+        end
+        @alt.add(severity, message, progname) if @alt
+        return true
+      end
+      alias log add
+
+      def <<(msg)
+        Sidekiq.redis do |conn|
+          jid = Thread.current[:sidekiq_jid]
+          conn.lpush("logger:#{jid}", msg) if jid
+          conn.expire("logger:#{jid}", 20 * 60) if jid
+          conn.lpush("logger", msg)
+          conn.ltrim("logger", 0, @limit - 1)
+        end
+        @alt << msg if @alt
+      end
+
+      def debug(progname = nil, &block)
+        add(DEBUG, nil, progname, &block)
+      end
+
+      def info(progname = nil, &block)
+        add(INFO, nil, progname, &block)
+      end
+
+      def warn(progname = nil, &block)
+        add(WARN, nil, progname, &block)
+      end
+
+      def error(progname = nil, &block)
+        add(ERROR, nil, progname, &block)
+      end
+
+      def fatal(progname = nil, &block)
+        add(FATAL, nil, progname, &block)
+      end
+
+      def unknown(progname = nil, &block)
+        add(UNKNOWN, nil, progname, &block)
+      end
+
+      def close
+        return true
+      end
+
+      private
+        SEV_LABEL = %w(DEBUG INFO WARN ERROR FATAL ANY)
+        def format_severity(severity)
+          SEV_LABEL[severity] || 'ANY'
+        end
+  
+        def format_message(severity, datetime, progname, msg)
+          @formatter.call(severity, datetime, progname, msg)
+        end
+    end
+  end
+end

data/lib/sidekiq/redis-logger/middleware.rb

@@ -0,0 +1,11 @@
+module Sidekiq
+  module RedisLogger
+    class Middleware
+      def call(worker, item, queue)
+        Sidekiq::RedisLogger::Logger.with_jid_context(item["jid"]) do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq/redis-logger/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module RedisLogger
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/redis-logger/views/logs.slim

@@ -0,0 +1,12 @@
+h3 Logs
+
+pre
+  code id="log-output"
+    | Loading...
+    
+javascript:
+  $(function () {
+    setInterval(function(){
+      $("#log-output").load("#{root_path}logs/poll");
+    }, 3000);
+  });

data/lib/sidekiq/redis-logger/web_extension.rb

@@ -0,0 +1,29 @@
+module Sidekiq
+  module RedisLogger
+    module WebExtension
+      def self.registered(app)
+        app.helpers do
+          def find_template(view, *a, &b)
+            dir = File.expand_path("../views/", __FILE__)
+            super(dir, *a, &b)
+            super
+          end
+        end
+        
+        app.get "/logs" do
+          slim :logs
+        end
+      
+        app.get "/logs/poll" do
+          Sidekiq.redis do |conn|
+            if params[:jid]
+              conn.exists("logger:#{params[:jid]}") ? conn.lrange("logger:#{jid}", 0, 100).reverse.join : "No log"
+            else
+              conn.lrange("logger", 0, 100).reverse.join
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/sidekiq-redis-logger.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sidekiq/redis-logger/version"
+
+Gem::Specification.new do |gem|
+  gem.name          = "sidekiq-redis-logger"
+  gem.version       = Sidekiq::RedisLogger::VERSION
+  gem.authors       = ["Alex Coomans"]
+  gem.email         = ["alex@alexcoomans.com"]
+  gem.description   = %q{Direct Sidekiq logs into Redis as well}
+  gem.summary       = %q{Direct Sidekiq logs into Redis as well and provide a web UI tab for watching}
+  gem.homepage      = "https://github.com/drcapulet/sidekiq-redis-logger"
+
+  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.require_paths = ["lib"]
+  
+  gem.add_dependency "sidekiq", ">= 2.6.0"
+  gem.add_dependency "slim"
+  gem.add_dependency "sinatra"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-redis-logger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Alex Coomans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: &70110350649380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70110350649380
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: &70110350648720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70110350648720
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &70110350648080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70110350648080
+description: Direct Sidekiq logs into Redis as well
+email:
+- alex@alexcoomans.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sidekiq-redis-logger.rb
+- lib/sidekiq/redis-logger.rb
+- lib/sidekiq/redis-logger/logger.rb
+- lib/sidekiq/redis-logger/middleware.rb
+- lib/sidekiq/redis-logger/version.rb
+- lib/sidekiq/redis-logger/views/logs.slim
+- lib/sidekiq/redis-logger/web_extension.rb
+- sidekiq-redis-logger.gemspec
+homepage: https://github.com/drcapulet/sidekiq-redis-logger
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Direct Sidekiq logs into Redis as well and provide a web UI tab for watching
+test_files: []