derrick 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0285870ebaaa8e6ba6bc7af6fb5a7b492e7d80c
+  data.tar.gz: 749a8f109082a389b2f604da95ee1071f0502f82
+SHA512:
+  metadata.gz: 524f95f92f4ab8f4be1563266abb9bba1499c93cb3557806f6b819030c0729b94361b753319a6d127f6ef14344b2444e223a87831b26e8e3705869c3bd881706
+  data.tar.gz: c1b2df39d3d9d99ed81b80b464623089862fedb93c0adba932fa27549a33a98020a1695a5ed82cfed718eb53da7b7a248cf802cc9eb1a55177d746d818ac03cb

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jean Boussier
+
+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,39 @@
+# Derrick
+
+Inspect Redis databases and print statistics about the keys
+
+## Installation
+
+```shell
+    $ gem install derrick
+```
+
+## Usage
+
+```shell
+$ derrick inspect redis://127.0.0.1:6379/5
+```
+
+It will print something like this:
+
+```
+Pattern                      Count  Exp Type
+shop:*:name                  10000 100% string
+shop:*:id                    10000   0% string
+shop:*:versions                  2   0% string: 50%,hash: 50%
+sorted_set:*:product_types       1   0% zset
+```
+
+You can also configure the concurrency level and batch size:
+
+```shell
+$ derrick inspect --concurrency 4 --batch-size 100000 redis://127.0.0.1:6379/5
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/derrick/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/derrick

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'derrick'
+require 'derrick/cli'
+
+Derrick::CLI.run(ARGV)

data/derrick.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'derrick/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'derrick'
+  spec.version       = Derrick::VERSION
+  spec.authors       = ['Jean Boussier']
+  spec.email         = ['jean.boussier@gmail.com']
+  spec.summary       = %q{Inspect Redis databases and print statistics about the keys}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'redis'
+end

data/lib/derrick/cli.rb

@@ -0,0 +1,147 @@
+require 'optparse'
+require 'redis'
+
+require 'byebug'
+
+module Derrick
+  class CLI
+    class ProgressDisplay
+
+      def initialize(progress, output)
+        @progress = progress
+        @output = output
+        @last_output_size = 0
+      end
+
+      def render
+        clear
+        message = "collected: #{@progress.collected}/#{@progress.total} fetched: #{@progress.fetched}/#{@progress.total}"
+        @last_output_size = message.size
+        @output.print message
+      end
+
+      def clear
+        @output.print "\b" * @last_output_size
+      end
+
+      def start
+        @thread = Thread.new do
+          loop do
+            render
+            sleep 1
+          end
+        end
+      end
+
+      def stop
+        @thread.kill
+        clear
+      end
+
+    end
+
+    class Context
+      attr_accessor :concurrency, :batch_size
+
+      def initialize
+        @concurrency = 2
+        @batch_size = 10_000
+      end
+    end
+
+    class AggregateFormatter
+      def initialize(aggregate)
+        @aggregate = Hash[aggregate.sort_by { |p, a| -a.count }]
+      end
+
+      def each
+        yield render_header
+        @aggregate.each { |n, s| yield render_line(n, s) }
+      end
+
+      def render_header
+        [
+          'Pattern'.ljust(key_size),
+          'Count'.rjust(6),
+          'Exp'.rjust(4),
+          'Type',
+        ].join(' ')
+      end
+
+      def render_line(name, stats)
+        [
+          name.ljust(key_size),
+          stats.count.to_s.rjust(6),
+          "#{(stats.expirable_ratio * 100).round}%".rjust(4),
+          types_summary(stats)
+        ].join(' ')
+      end
+
+      def types_summary(stats)
+        if stats.types_count.size == 1
+          stats.types_count.keys.first
+        else
+          stats.types_ratio.map do |type, ratio|
+            "#{type}: #{(ratio * 100).round}%"
+          end.join(',')
+        end
+      end
+
+      def key_size
+        @key_size ||= @aggregate.keys.map(&:size).max
+      end
+    end
+
+    def self.run(args)
+      new(args).run!
+    end
+
+    def initialize(args)
+      @context = Context.new
+      @command, *@arguments = parser.parse(args)
+    end
+
+    def run!
+      abort! unless @command
+      public_send("command_#{@command}", *@arguments)
+    end
+
+    def command_inspect(database_url=nil)
+      inspector = Derrick::Inspector.new(Redis.new(url: database_url), @context)
+
+      progress_display = ProgressDisplay.new(inspector.progress, STDERR)
+      progress_display.start
+
+      aggregate = inspector.report
+      progress_display.stop
+
+      AggregateFormatter.new(aggregate).each do |line|
+        puts line
+      end
+    end
+
+    protected
+
+    def abort!(message=parser.help)
+      puts message
+      exit 1
+    end
+
+    def parser
+      OptionParser.new do |opts|
+        opts.banner = "Inpect Redis databases to compute statistics on keys"
+        opts.separator ""
+        opts.separator "Usage: derrick inspect [options] DATABASE_URL"
+        opts.separator ""
+        opts.separator "Main options:"
+        opts.on('-c', '--concurrency CONCURRENCY') do |concurrency|
+          @context.concurrency = Integer(concurrency)
+        end
+        opts.on('-b', '--batch-size BATCH_SIZE') do |batch_size|
+          @context.batch_size = Integer(batch_size)
+        end
+      end
+    end
+
+  end
+end

data/lib/derrick/inspector.rb

@@ -0,0 +1,182 @@
+require 'thread'
+
+Thread.abort_on_exception = true
+
+module Derrick
+  class Collector
+    def initialize(redis, queue, progress, context)
+      @redis = redis
+      @queue = queue
+      @progress = progress
+      @context = context
+    end
+
+    def run
+      collect_keys
+      @context.concurrency.times { @queue.push(:stop) }
+    end
+
+    def collect_keys
+      cursor = '0'
+      loop do
+        cursor, keys = @redis.scan(cursor, count: @context.batch_size)
+        @queue.push(keys)
+        @progress.increment_collected(keys.size)
+        return if cursor == '0'
+      end
+    end
+  end
+
+  Key = Struct.new(:name, :type, :ttl)
+
+  class Fetcher
+
+    def initialize(redis, input, output, progress)
+      @redis = redis
+      @input = input
+      @output = output
+      @progress = progress
+    end
+
+    def run
+      while (keys = @input.pop) != :stop
+        @output.push(stats(keys))
+      end
+      @output.push(:stop)
+    end
+
+    def stats(keys)
+      types = @redis.pipelined do
+        keys.each do |key|
+          @redis.type(key)
+        end
+      end
+
+      ttls = @redis.pipelined do
+        keys.each do |key|
+          @redis.ttl(key)
+        end
+      end
+
+      @progress.increment_fetched(keys.size)
+
+      keys.map.with_index do |key, index|
+        Key.new(key, types[index], ttls[index])
+      end
+    end
+
+  end
+
+  class Pattern
+    attr_reader :pattern, :count, :expirable_count, :persisted_count, :types_count
+
+    def initialize
+      @count = 0
+      @expirable_count = 0
+      @persisted_count = 0
+      @types_count = Hash.new(0)
+    end
+
+    def expirable_ratio
+      return 1 if count == 0
+      expirable_count.to_f / count
+    end
+
+    def types_ratio
+      Hash[@types_count.map do |type, sub_count|
+        [type, sub_count.to_f / count]
+      end]
+    end
+
+    def aggregate(key)
+      @count += 1
+
+      if key.ttl == -1
+        @persisted_count += 1
+      else
+        @expirable_count += 1
+      end
+
+      @types_count[key.type] += 1
+    end
+
+  end
+
+  class Progress
+
+    attr_reader :total, :collected, :fetched
+
+    def initialize(total)
+      @total = total
+      @mutex = Mutex.new
+
+      @collected = 0
+      @fetched = 0
+    end
+
+    def increment_collected(count)
+      @mutex.synchronize { @collected += count }
+    end
+
+    def increment_fetched(count)
+      @mutex.synchronize { @fetched += count }
+    end
+
+  end
+
+  class Aggregator
+    attr_reader :patterns
+    def initialize(queue, context)
+      @queue = queue
+      @patterns = {}
+      @context = context
+    end
+
+    def run
+      fetcher_count = @context.concurrency
+      loop do
+        keys = @queue.pop
+        if keys == :stop
+          fetcher_count -= 1
+          break if fetcher_count == 0
+        else
+          keys.each { |k| aggregate(k) }
+        end
+      end
+      self
+    end
+
+    def aggregate(key)
+      pattern = pattern_from(key)
+      pattern.aggregate(key)
+    end
+
+    def pattern_from(key)
+      canonical_key = key.name.gsub(/(^|:)(\d+|[0-9a-f]{32,40})($|:)/, '\1*\3')
+      @patterns[canonical_key] ||= Pattern.new
+    end
+
+  end
+
+  class Inspector
+    attr_reader :redis, :progress
+
+    def initialize(redis, context)
+      @redis = redis
+      @context = context
+      @progress = Progress.new(@redis.dbsize)
+    end
+
+    def report
+      keys_queue = Queue.new
+      stats_queue = Queue.new
+      Thread.new { Collector.new(@redis, keys_queue, @progress, @context).run }
+      @context.concurrency.times do
+        Thread.new { Fetcher.new(@redis, keys_queue, stats_queue, @progress).run }
+      end
+      aggregator = Aggregator.new(stats_queue, @context)
+      aggregator.run
+      aggregator.patterns
+    end
+  end
+end

data/lib/derrick/version.rb

@@ -0,0 +1,3 @@
+module Derrick
+  VERSION = "0.0.1"
+end

data/lib/derrick.rb

@@ -0,0 +1,5 @@
+require 'derrick/version'
+require 'derrick/inspector'
+
+module Derrick
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: derrick
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jean Boussier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jean.boussier@gmail.com
+executables:
+- derrick
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/derrick
+- derrick.gemspec
+- lib/derrick.rb
+- lib/derrick/cli.rb
+- lib/derrick/inspector.rb
+- lib/derrick/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Inspect Redis databases and print statistics about the keys
+test_files: []