Sha256: e713424da0517275e533a3561119221cad3255c9a4bee56852f208a49dea0920

Contents?: true

Size: 1.91 KB

Versions: 1

Compression:

Stored size: 1.91 KB

Contents

# Redis::ReconnectWithReadonly

Reconnect your redis connection if `Redis::CommandError READONLY You can't write against a read only slave.` occurs because of failover.

When redis cluster failovers, the redis master is depromoted to slave and will be READONLY. Such case we have to reconnect redis connection so that new connection goes to new master which is writable.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'redis-reconnect_with_readonly'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install redis-reconnect_with_readonly

## Usage

```ruby
require 'redis/reconnect_with_readonly'
```

## Configuration

This gem tries to reconnect `reconnect_attempts` times.
It will wait `initial_retry_wait * number of retries` seconds on each retry.
The waiting interval can be suppressed up to `max_retry_wait` seconds.

```
Redis::ReconnectWithReadonly.reconnect_attempts = 10  # default: 3 (times)
Redis::ReconnectWithReadonly.initial_retry_wait = 1.0 # default: 0.5 (sec)
Redis::ReconnectWithReadonly.max_retry_wait     = 5.0 # default: nil which means no max (sec)
```

## Implementation

This gem monkey patches `Redis::Client`.

## Development

```
$ redis-server --port 6379
$ redis-server --port 6380
```

```
$ redis-cli -h localhost -p 6380
localhost:6380> slaveof localhost 6379
```

```
$ bin/console
> redis = Redis.new(:host => "localhost", :port => 6380)
> redis.set('key', 'val')
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/redis-reconnect_with_readonly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

## ChangeLog

[CHANGELOG.md](./CHANGELOG.md)

Version data entries

1 entries across 1 versions & 1 rubygems

Version Path
redis-reconnect_with_readonly-0.9.1 README.md