https://github.com/locaweb/heartcheck-redis

A plugin to check redis connection with heartcheck
https://github.com/locaweb/heartcheck-redis

hacktoberfest hacktoberfest2021

Last synced: about 1 month ago
JSON representation

A plugin to check redis connection with heartcheck

• Host: GitHub
• URL: https://github.com/locaweb/heartcheck-redis
• Owner: locaweb
• License: mit
• Created: 2015-02-09T18:09:59.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2021-10-20T19:10:44.000Z (about 3 years ago)
• Last Synced: 2024-04-16T18:21:21.840Z (9 months ago)
• Topics: hacktoberfest, hacktoberfest2021
• Language: Ruby
• Homepage:
• Size: 47.9 KB
• Stars: 2
• Watchers: 18
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# Heartcheck::Redis

[![Build Status](https://travis-ci.org/locaweb/heartcheck-redis.svg)](https://travis-ci.org/locaweb/heartcheck-redis)

[![Code Climate](https://codeclimate.com/github/locaweb/heartcheck-redis/badges/gpa.svg)](https://codeclimate.com/github/locaweb/heartcheck-redis)

[![Ebert](https://ebertapp.io/github/locaweb/heartcheck-redis.svg)](https://ebertapp.io/github/locaweb/heartcheck-redis)

##A plugin to check redis connection with [heartcheck](https://github.com/locaweb/heartcheck).

## Installation

Add this line to your application's Gemfile:

```ruby

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)

```ruby

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.

```shell

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

```

### Check Heartcheck example [here](https://github.com/locaweb/heartcheck/blob/master/lib/heartcheck/generators/templates/config.rb)

## 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](https://docs.docker.com/get-docker/)

-   [Docker Compose](https://docs.docker.com/compose/install/)

-   [Bash](https://www.gnu.org/software/bash/)

#### BootStrap Script to run the dockerized environment

```bash

./scripts/heartcheck-redis setup

```

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

## License

* [MIT License](https://github.com/locaweb/heartcheck-redis/blob/master/LICENSE.txt)

## 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