locaweb/heartcheck-redis

A plugin to check redis connection with heartcheck

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

heartcheck-redis's Issues

Rubycritic gem installation to insurance the code quality

I verified that missing gems to insurance the code quality.

That's why I suggest that, please, install the Rubycritic gem in the project.

Observation: The configured minimum score must be the first score that the gem create.

Thanks. 😃

Add ebertapp on the repo

Add specific version of rubocop for test files!

We need to guarantee the code standard and quality in tests files!

For that mission we need to install, configure and fixes the offenses of rubocop-rspec:
https://github.com/rubocop/rubocop-rspec

Thanks!

DoD

• Rubocop-rspec installed and configured;
• No offenses being reported.

Make development easier with docker!

As suggestion we can add docker to project, so it'll be easier to setup the environment facilitating the contribution!

Use GitHub Actions instead TravisCI

We want to replace travis CI by Github actions.

You can follow the example: locaweb/heartcheck#51

DoD

• Must pass all tests in forked repo;
• Must remove travis.