redis_scanner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edfb7559c6d635bfd8cd409776cd54334c8be449
+  data.tar.gz: 6a488cfff92de0b0f5b2e10c71e2d8586fd738d6
+SHA512:
+  metadata.gz: e3b0ab5826f98726db115056a91e8e23dc1df22d171a41906d1057567114f2b4259bd4aa7dabf035123083725b18ac68c4129b5c761bc8f423274e16cfa9839a
+  data.tar.gz: 48c2aca4dda664b4ec2da7ddd6831b96ef5e34a93ca44eae01641c45261c91399eb9b0b8a16303d37b691eca3b5abf1626399843118c1740720a92db77bb51aa

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at vincent@boohee.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/README.md

@@ -0,0 +1,53 @@
+# RedisScanner
+
+RedisScanner is a tiny tool for scanning all redis keys and creating statistic result. The features are the followings.
+
+* Scans keys using *scan* replacing *keys* command.
+* Creates statistic result by key's pattern.
+
+## Installation
+
+Install redis_scanner in shell.
+
+```shell
+gem install redis_scanner
+```
+
+*Installation prerequirement*
+
+You should install [ruby](https://www.ruby-lang.org/) first.
+
+## Usage
+
+* Use default options
+
+```shell
+redis_scanner
+```
+
+* Scan keys with some pattern
+
+```shell
+redis_scanner -m u:*
+```
+
+* Output statistic result to a file
+
+```shell
+redis_scanner -f keys_stat.txt
+```
+
+* Redis options. The options are same of redis-cli.
+
+```shell
+redis_scanner -h <host> -p <port> ...
+```
+
+## Development
+
+You are free to modify it for your need.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/xiewenwei/redis_scanner. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/redis_scanner

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'optparse'
+require 'redis_scanner'
+
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: redis_scanner [options]"
+
+  opts.on("-f FILE", "--file FILE", "Output file") do |v|
+    options[:file] = v
+  end
+
+  opts.on("-m MATCH", "--match MATCH", "Scan pattern") do |v|
+    options[:match] = v
+  end
+
+  # redis client options
+  # -h <hostname>      Server hostname (default: 127.0.0.1).
+  # -p <port>          Server port (default: 6379).
+  # -s <socket>        Server socket (overrides hostname and port).
+  # -a <password>      Password to use when connecting to the server.
+  # -n <db>            Database number.
+  opts.on("-h HOST", "--host HOST", "Server hostname (default: 127.0.0.1)") do |v|
+    options[:host] = v
+  end
+
+  opts.on("-p PORT", "--port PORT", "Server port (default: 6379)") do |v|
+    options[:port] = v
+  end
+
+  opts.on("-s SOCKET", "--socket SOCKET", "Server socket (overrides hostname and port)") do |v|
+    options[:socket] = v
+  end
+
+  opts.on("-a PASSWORD", "--password PASSWORD", "Password to use when connecting to the server.") do |v|
+    options[:password] = v
+  end
+
+  opts.on("-n DB", "--db DB", "Database number") do |v|
+    options[:db] = v
+  end
+
+end.parse!
+
+# puts "options is #{options.inspect}"
+
+RedisScanner.scan options

data/lib/redis_scanner/engine.rb

@@ -0,0 +1,58 @@
+module RedisScanner
+  class Engine
+    def initialize(redis, options)
+      @redis = redis
+      @options = options
+    end
+
+    def run
+      convert_to_sorted_array scan
+    end
+
+    private
+
+    def convert_to_sorted_array(stat)
+      stat.to_a.sort do |x, y|
+        if x[1] == y[1]
+          x[0] <=> y[0]
+        else
+          y[1] <=> x[1]
+        end
+      end
+    end
+
+    def scan
+      cursor = 0
+      stat = Hash.new(0)
+      while true
+        if @options[:match]
+          cursor, result = @redis.scan cursor, match: @options[:match]
+        else
+          cursor, result = @redis.scan cursor
+        end
+        result.each do |key|
+          pattern = resolve_pattern(key)
+          stat[pattern] += 1
+        end
+        cursor = cursor.to_i
+        break if cursor == 0
+      end
+      stat
+    end
+
+    PATTERNS = [
+      [/.*(:\d+:).*/, ":<id>:"],
+      [/.*(:\w+-\w+-\w+-\w+-\w+:).*/, ":<user_key>:"]
+    ]
+
+    def resolve_pattern(key)
+      PATTERNS.each do |pattern, replacer|
+        if m = pattern.match(key)
+          key = key.sub(m[1], replacer)
+          break
+        end
+      end
+      key
+    end
+  end
+end

data/lib/redis_scanner/version.rb

@@ -0,0 +1,3 @@
+module RedisScanner
+  VERSION = "0.1.0"
+end

data/lib/redis_scanner.rb

@@ -0,0 +1,32 @@
+require "redis_scanner/version"
+require "redis_scanner/engine"
+require "redis"
+
+module RedisScanner
+  def self.scan(options)
+    redis = Redis.new extract_redis_options(options)
+    engine = Engine.new redis, options
+    result = engine.run
+    output_result(result, options)
+  end
+
+  def self.output_result(result, options)
+    if options[:file]
+      File.open(options[:file], "w") do |file|
+        result.each { |key, count| file.puts "#{key} #{count}" }
+      end
+    else
+      puts "=========result is========="
+      result.each { |key, count| puts "#{key} #{count}" }
+      puts "==========================="
+    end
+  end
+
+  def self.extract_redis_options(options)
+    result = {}
+    [:host, :port, :socket, :password, :db].each do |key|
+      result[key] = options[key]
+    end
+    result
+  end
+end

data/redis_scanner.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_scanner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_scanner"
+  spec.version       = RedisScanner::VERSION
+  spec.authors       = ["Vincent Xie"]
+  spec.email         = ["xiewenwei@gmail.com"]
+
+  spec.summary       = %q{RedisScanner is a tiny tool for scanning redis's keys and creating statistic information.}
+  spec.description   = %q{RedisScanner is a tiny tool for scanning redis's keys and creating statistic information. It scans keys using redis scan command and computing statistic result by key's pattern.}
+  spec.homepage      = "http://github.com/xiewenwei/redis_scanner.git"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "redis"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: redis_scanner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Xie
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: RedisScanner is a tiny tool for scanning redis's keys and creating statistic
+  information. It scans keys using redis scan command and computing statistic result
+  by key's pattern.
+email:
+- xiewenwei@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/redis_scanner
+- lib/redis_scanner.rb
+- lib/redis_scanner/engine.rb
+- lib/redis_scanner/version.rb
+- redis_scanner.gemspec
+homepage: http://github.com/xiewenwei/redis_scanner.git
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: RedisScanner is a tiny tool for scanning redis's keys and creating statistic
+  information.
+test_files: []