dumper 0.2.2 → 0.3.0

data/README.md

@@ -9,9 +9,11 @@ Dumper is a backup management system that offers a whole new way to take daily b
 * Ruby 1.8.7 , Ruby 1.9.2 or later
 * Rails 3.0 or later
 * MySQL with ActiveRecord
-* MongoDB with mongo gem (including Mongoid 2.x)
+* MongoDB with the mongo gem (including Mongoid 2.x)
+* Redis with the redis gem **To take backups from Redis, you must run agent on the Redis host**
+* Runs inside [thin](http://code.macournoyer.com/thin/), [unicorn](http://unicorn.bogomips.org/), [passenger](http://www.modrails.com/) or [resque](https://github.com/defunkt/resque) (mongrel and webrick are also supported for development)
 
-Support for PostgreSQL and Redis are coming soon.
+Support for PostgreSQL is coming soon.
 
 ## Installation
 
@@ -27,14 +29,42 @@ then create `config/initializers/dumper.rb` and put the following line.
 Dumper::Agent.start(:app_key => 'YOUR_APP_KEY')
 ```
 
-or, if you want to conditionally start the agent, pass a block that evaluates to true/false to `#start_if` method.
+That's it!
+
+Now, start your server and go to the Dumper site.
+
+You'll find your application is registered and ready to take backups.
+
+## How does it work?
+
+In a Rails app server process, a new thread is created and periodically checks the Dumper API if a new backup job is scheduled.
+
+When it finds a job, the agent won't run the job inside its own thread, but instead spawns a new process, then go back to sleep. That way, web requests won't be affected by the long-running backup task, and the task will continue to run even when the parent process is killed in the middle.
+
+Dumper agent will try to run on every process by default. Which means, for instance, if you have 10 thin instances on production, the agent will run on those 10 instances. We designate the first agent that hits our API as primary, and the rest as secondary. In this case, 1 thin process becomes the primary and other 9 processes become secondaries. Only the primary is responsible for taking backup jobs, so it is guaranteed that there is no duplicate work on your servers. The primary polls our API with up to 1- to 10-minute interval, while the secondaries poll every hour. If you run fork-based servers like unicorn or passenger, however, the agent thread runs only on the master process, not on child processes.
+
+We do this for fault tolerance. When something goes wrong and the primary dies, one of the secondaries will take over the primary status and continue to serve.
+
+The bottom line is that the agent is designed to be extremely efficient in CPU, memory and bandwidth usage. It's almost impossible to detect any difference in performance with or without it.
+
+## Conditionally start the agent
+
+As explained above, the Dumper agent will try to run on every process by default.
+
+If you want to start the agent on a particular host, pass a block that evaluates to true or false to `start_if` method.
 
 ```ruby
-Dumper::Agent.start_if(:app_key => 'YOUR_APP_KEY') { Rails.env.production? && dumper_enabled_host? }
+Dumper::Agent.start_if(:app_key => 'YOUR_APP_KEY') do
+  Rails.env.production? && dumper_enabled_host?
+end
 ```
 
-That's it!
+In particular, current Redis support is limited in that you must run the agent on the same host with Redis.
 
-Now, start your server and go to the Dumper site.
+```ruby
+Dumper::Agent.start_if(:app_key => 'YOUR_APP_KEY') do
+  Socket.gethostname == 'redis.mydomain.com'
+end
+```
 
-You'll find your application is registered and ready to take backups daily.
+If you are using resque, it's a good idea to run it on the same host with Redis, and start the agent on the resque instance.

data/lib/dumper/stack.rb

@@ -32,7 +32,7 @@ module Dumper
       end
 
       # Which dispatcher?
-      [ :unicorn, :passenger, :thin, :mongrel, :webrick ].find do |name|
+      [ :unicorn, :passenger, :thin, :mongrel, :webrick, :resque ].find do |name|
         @dispatcher = send("#{name}?") ? name : nil
       end
     end
@@ -75,5 +75,9 @@ module Dumper
       # defined?(::WEBrick::VERSION)
       @rackup and @rackup.server.to_s.demodulize == 'WEBrick'
     end
+
+    def resque?
+      defined?(::Resque) && (ENV['QUEUES'] || ENV['QUEUE'])
+    end
   end
 end

data/lib/dumper/version.rb

@@ -1,3 +1,3 @@
 module Dumper
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dumper
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-02 00:00:00.000000000 Z
+date: 2012-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json