rci 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b5b0bba2f64ae1dae849f1470d5a624d64018e0c
+  data.tar.gz: 9534accb397c16d45d6d454ef6da0d1e512585a3
+SHA512:
+  metadata.gz: 2b575bf25ef8bfb2695c187d2ebd2f9eae242bf99d6f5797b0815a2709f1eead3463f508d60273791757acf30e52cc1dd0f0385b164b1740ac8e4e1d583f97c6
+  data.tar.gz: d924009fe7f171a855658861945f07dc1da821b732044b5ccc5db701b7d01d4196590a2f3e8f8eafd05ec2f5f7337cb34629b807cbbd23ef00e8334d5c2ac56f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,27 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, 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, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual
+language or imagery, derogatory comments or personal attacks, trolling,
+public or private harassment, insults, or other 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. Project maintainers who do not
+follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by opening an issue or contacting one or more of the project
+maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org),
+version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tyler Pickett
+
+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,47 @@
+# RCI
+
+(R)edis (C)lient (I)nstrumenter
+
+Adds ActiveSpport::Notifications to calls made against redis using the official redis clients
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rci'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rci
+
+## Usage
+
+Since the instrumentation depends on being able to query the server for the commands
+it supports you'll need to initialize everything with one of two methods:
+
+```
+redis = Redis.new
+
+# Attach to every Redis client in the system (most apps will do this)
+RCI.setup(redis)
+
+# Attach to only a specific Redis client
+RCI.attach_instrumentation_to(redis)
+```
+
+Both of these methods will call out to the Redis server to get a list of commands before
+attaching the instrumentation.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rci/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 @@
+require "bundler/gem_tasks"

data/lib/rci.rb

@@ -0,0 +1,25 @@
+require "rci/version"
+require 'rci/instrumentation'
+require 'rci/commands'
+
+module RCI
+  def self.setup(redis)
+    discover_commands(redis)
+    attach_instrumentation!
+  end
+
+  def self.attach_instrumentation_to(redis)
+    discover_commands(redis)
+    redis.client.singleton_class.send(:prepend, RCI::Instrumentation)
+  end
+
+  private
+
+  def self.attach_instrumentation!
+    Redis::Client.send(:prepend, RCI::Instrumentation)
+  end
+
+  def self.discover_commands(redis)
+    Commands.discover!(redis)
+  end
+end

data/lib/rci/commands.rb

@@ -0,0 +1,42 @@
+require 'set'
+
+module RCI
+  module Commands
+    class << self
+      attr_reader :commands, :read_commands, :read_command_names
+    end
+
+    @read_commands = []
+    @read_command_names = Set.new
+
+    # As of Redis 3.0 there isn't any indication from the COMMAND return
+    # info as to which commands accept a subcommand so we're tracking them here
+    COMMANDS_WITH_SUBCOMMANDS = %i{client cluster command debug script}.to_set.freeze
+    Command = Struct.new(:name, :arity, :flags, :first_key_position, :last_key_position, :step_count)
+
+    def self.command_type(command_array)
+      @read_command_names.include?(command_array.first) ? :read : :write
+    end
+
+    def self.discover!(client)
+      return @commands if @commands
+      @commands = client.command.map{ |command_description|
+        command_name = command_description.shift.to_sym
+        Command.new(command_name, *command_description)
+      }
+      @read_commands = @commands.select { |command| command.flags.include?('readonly') }
+      @read_command_names = @read_commands.map(&:name).to_set
+      @commands
+    end
+
+    def self.extract_command(command_array)
+      command = command_array[0]
+      info = {command: command}
+      if COMMANDS_WITH_SUBCOMMANDS.include?(command)
+        subcommand = command_array[1]
+        info[:subcommand] = subcommand unless subcommand.nil?
+      end
+      info
+    end
+  end
+end

data/lib/rci/instrumentation.rb

@@ -0,0 +1,19 @@
+require 'redis'
+require 'active_support/notifications'
+
+module RCI
+  module Instrumentation
+    def call(command, &block)
+      payload = extract_notification_payload_from(command)
+      ActiveSupport::Notifications.instrument("#{ Commands.command_type(command) }.redis", payload) do
+        super
+      end
+    end
+
+    private
+
+    def extract_notification_payload_from(command_array)
+      Commands.extract_command(command_array)
+    end
+  end
+end

data/lib/rci/version.rb

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

data/rci.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rci/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rci'
+  spec.version       = RCI::VERSION
+  spec.authors       = ['Tyler Pickett']
+  spec.email         = ['t.pickett66@gmail.com']
+
+  spec.summary       = %q{Redis Client Instrumenter}
+  spec.description   = %q{A little gem to wrap around calls to the official Ruby Redis clients and emmit ActiveSupport Notifications}
+  spec.homepage      = 'https://github.com/tpickett66/rci'
+  spec.license       = 'MIT'
+
+  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.required_ruby_version = '>= 2.0'
+
+  spec.add_dependency 'activesupport', '>= 3.0', '< 5.0'
+  spec.add_dependency 'redis', '>= 2.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: rci
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tyler Pickett
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: A little gem to wrap around calls to the official Ruby Redis clients
+  and emmit ActiveSupport Notifications
+email:
+- t.pickett66@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rci.rb
+- lib/rci/commands.rb
+- lib/rci/instrumentation.rb
+- lib/rci/version.rb
+- rci.gemspec
+homepage: https://github.com/tpickett66/rci
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Redis Client Instrumenter
+test_files: []
+has_rdoc: