jimeh/amqp-failover
1
0
Fork 0
mirror of https://github.com/jimeh/amqp-failover.git synced 2026-02-19 10:56:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

updated readme

Browse Source
This commit is contained in:
Jim Myhrberg
2011-02-01 14:07:00 +00:00
parent 575df3690e
commit b7d7024c82
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -1,6 +1,6 @@
# amqp-failover #
Add multi-server support with failover and fallback to the [amqp](https://github.com/ruby-amqp/amqp) gem.
Add multi-server support with failover and fallback to the [amqp](https://github.com/ruby-amqp/amqp) gem. Failover is configured by providing multiple servers/configurations to `AMQP.start` or `AMQP.connect`. Both methods will still accept the same options input as they always have, they simply now support additional forms of options which when used, enables the failover features.
## Basic Usage ##
@@ -50,11 +50,17 @@ Specify AMQP servers and Failover options by passing a Hash containing a `:hosts
## Failover Options ##
* `:retry_timeout`, time to wait before retrying a specific AMQP config after failure.
* `:primary_config`, specify which of the supplied configurations is it the primary one. The default value is 0, the first item in the config array. Use 1 for the second and so on.
* `:fallback`, check for the return of the primary server, and fallback to it if and when it returns. WARNING: This currently calls `Process.exit` cause I haven't figured out a way to artificially kill the EM connection without the AMQP channels also being closed, which causes nothing to work even after EM connects to the primary server. It works for me cause dead workers are automatically relaunched with their default config.
* `:fallback_interval`, seconds between each check for original server if :fallback is true.
* `:selection`, not yet implemented.
## Notes ##
I would recommend you test the failover functionality in your own infrastructure before deploy to production, as this gem is still very much alpha/beta quality, and it does do a little bit of monkey patching to the amqp gem. That said, it there's a number of specs which should ensure things work as advertised, and nothing breaks. We are currently using it at Global Personals without any problems.
## Todo ##
* Figure out a sane way to fallback without having to kill the Ruby process.