README.md

Heartcheck::Redis

##A plugin to check redis connection with heartcheck.

Installation

Add this line to your application's Gemfile:

gem 'heartcheck-redis'

And then execute:

$ bundle

Or install it yourself as:

$ gem install heartcheck-redis

Usage

You can check any redis connection that there's in your app. Each service need to respond to :name (an indetifier) and :connection (an activerecord connection)

Heartcheck.setup do |config|
  config.add :redis do |c|
    c.add_service(name: 'MyRedisConnection', connection: Redis.new)
  end
end

For ruby old versions (older than ruby-2.2.2)

If You are using an old version of Ruby, You may run Bundle's script with a specific gemfile.

    $ bundle install --gemfile=Gemfile-old-ruby

Check Heartcheck example here

Development setup using Docker

The Docker Hearthcheck-Redis provides a container with the current stable version of Ruby released and a second Docker container running Memcached. The development setup requires you to have these tools available in your local environment:

• Docker
• Docker Compose
• Bash

BootStrap Script to run the dockerized environment

./scripts/heartcheck-redis setup

Run the command ./scripts/heartcheck-redis -h to see available options.

License

• MIT License

Contributing

1. Fork it ( https://github.com/locaweb/heartcheck-redis )
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