Project

rci

0.0
Repository is archived
No commit activity in last 3 years
No release in over 3 years
A little gem to wrap around calls to the official Ruby Redis clients and emmit ActiveSupport Notifications
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.9
>= 0
~> 10.0
~> 3.3

Runtime

< 5.0, >= 3.0
>= 2.0
 Project Readme

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:

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