burninator 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 !binary "U0hBMQ==":
-  metadata.gz: cf37a9aa94004a0c632b93436c807ea11dae991c
-  data.tar.gz: 30e66ae4a8eb2a498a8760504d2e6483072c9397
+  metadata.gz: d2ab5383df34974224a6e7ffef9ef840494605ea
+  data.tar.gz: cc519f7bb61e1fff82149a24cc8fcbfd3d43175f
 !binary "U0hBNTEy":
-  metadata.gz: fec7cfdc0d066bd538aa1a9f58f8fa3b60339a77de520cdeb7173e1ef5e436dfff574030b7c53acf6eada7e15b8e8a7f9c23798d94c7f1835ca620b9ccd14188
-  data.tar.gz: 24bfdce22414d1964e3f41b5dbe251a46af01ea14a2908521dd750bc4ec4f471267becdd189378642c5a472cfb7aa74d2f133adc91c3940ec446532a67fa5d02
+  metadata.gz: be185bba1093d74f2a2fbaedc62c3a63a746ceba7b76eef9f7ed65264aa22677423e86731a9823397c64ba3c557b38255825d50daef059c9ccd7afd3a7d50bc6
+  data.tar.gz: 1db925daaa85812506d1a9489b9d5b41b8a70cfda531271d30af25b5b4f8cd7a5b4c67a05bbb098ecbb5280d85ece6181151befc9fa537596bb66e434f958d56

data/README.md

@@ -1 +1,61 @@
 # burninator
+
+[![Code Climate](https://codeclimate.com/github/jpignata/burninator.png)](https://codeclimate.com/github/jpignata/burninator)
+[![Gem Version](https://badge.fury.io/rb/burninator.png)](http://badge.fury.io/rb/burninator)
+
+### Status: Beta (Caveat Utilitor)
+
+## Summary
+
+![burninator](http://25.media.tumblr.com/tumblr_li2bl6oSh01qh5zi3o1_500.jpg)
+
+Warm a standby database with some percentage of real production query traffic.
+
+It's common for Heroku customers to have a standby database follower in the
+event of a primary failure, however if you cutover to that follower and its
+caches are cold you're likely in for a rough time until its SQL and page
+caches warm up.
+
+Burninator uses a Redis pub/sub channel to broadcast some percentage of
+query traffic (by default 5%) from Rails application servers to a central
+warming process that will run queries against the follower. It uses the
+ActiveSupport notifications instrumentation API to listen for queries. These
+queries are broadcast through the channel to the warming process which
+will run them onto the standby database.
+
+Since you're standby is seeing some percentage of real production query
+traffic, its caches should keep warm and ready for failover.
+
+## Installation
+
+Assuming you're using Heroku:
+
+In your Gemfile:
+
+```ruby
+gem "burninator"
+```
+
+In an initializer:
+
+```ruby
+burninator = Burninator.new(redis: $redis, percentage: 25)
+burninator.broadcast
+```
+
+In your Procfile:
+
+```ruby
+burninator: rake burninator:warm
+```
+
+Deploy and start burninating:
+
+```sh
+$ heroku config:add WARM_TARGET_URL="postgres://..."
+$ heroku scale burninator=1
+```
+
+## License
+
+Please see LICENSE.

data/lib/burninator/broadcaster.rb

@@ -0,0 +1,39 @@
+require "securerandom"
+require "active_support/core_ext/string"
+require "active_support/notifications"
+require "redis"
+
+class Burninator
+  class Broadcaster
+    KEY = "sql.active_record"
+
+    def initialize(redis, channel, percentage)
+      @redis = redis
+      @channel = channel
+      @percentage = percentage
+    end
+
+    def run
+      @subscriber ||= ActiveSupport::Notifications.subscribe(KEY) do |*args|
+        event = ActiveSupport::Notifications::Event.new(*args)
+        sql = event.payload[:sql].squish
+
+        if publish?(sql)
+          @redis.publish(@channel, Marshal.dump(event.payload))
+        end
+      end
+    end
+
+    def stop
+      ActiveSupport::Notifications.unsubscribe(@subscriber)
+    end
+
+    private
+
+    def publish?(sql)
+      return false unless sql =~ /\Aselect /i
+
+      SecureRandom.random_number(100 / @percentage) == 0
+    end
+  end
+end

data/lib/burninator/connection.rb

@@ -0,0 +1,29 @@
+require "active_record"
+
+class Burninator
+  class Connection
+    def initialize(url, warm_target = nil)
+      @warm_target = warm_target
+      connect(url)
+    end
+
+    def execute(query, binds = [])
+      query = "/* BURNINATOR */ " + query
+      connection.exec_query(query, nil, binds)
+    end
+
+    private
+
+    def warm_target
+      @warm_target ||= Class.new(ActiveRecord::Base)
+    end
+
+    def connect(url)
+      warm_target.establish_connection(url)
+    end
+
+    def connection
+      @connection ||= warm_target.connection
+    end
+  end
+end

data/lib/burninator/tasks/warm.rake

@@ -0,0 +1,8 @@
+task :environment
+
+namespace :burninator do
+  desc "Warm follower database"
+  task warm: :environment do
+    Burninator.new.warm
+  end
+end

data/lib/burninator/tasks.rb

@@ -0,0 +1,7 @@
+class Burninator::Tasks < Rails::Railtie
+  rake_tasks do
+    Dir[File.join(File.dirname(__FILE__), "tasks/*.rake")].each do |rake_task|
+      load rake_task
+    end
+  end
+end

data/lib/burninator/warmer.rb

@@ -0,0 +1,30 @@
+class Burninator
+  class Warmer
+    def initialize(redis, channel, connection)
+      @redis = redis
+      @channel = channel
+      @connection = connection
+    end
+
+    def run
+      @redis.subscribe(@channel) do |on|
+        on.message do |_, serialized|
+          event = Marshal.load(serialized)
+          process(event)
+        end
+      end
+    end
+
+    private
+
+    def process(event)
+      query = event[:sql]
+      binds = event[:binds]
+
+      @connection.execute(query, binds)
+    rescue ActiveRecord::StatementInvalid => e
+      Rails.logger.error("Error running #{query}")
+      Rails.logger.error("#{e.class}: #{e.message}")
+    end
+  end
+end

data/lib/burninator.rb

@@ -0,0 +1,60 @@
+require "burninator/broadcaster"
+require "burninator/warmer"
+require "burninator/connection"
+require "burninator/tasks"
+
+class Burninator
+  DEFAULT_PERCENTAGE = 5
+
+  def initialize(options = {})
+    @redis = options[:redis]
+    @percentage = options.fetch(:percentage, DEFAULT_PERCENTAGE)
+  end
+
+  def warm
+    trap_signals
+
+    Burninator::Warmer.new(redis, channel, database).run
+  end
+
+  def broadcast
+    Burninator::Broadcaster.new(redis, channel, @percentage).run
+  end
+
+  def channel
+    ["burninator", database_id].join(":")
+  end
+
+  private
+
+  def trap_signals
+    trap(:INT) { abort }
+    trap(:TERM) { abort }
+  end
+
+  def redis
+    @redis ||= Redis.new(:url => redis_url)
+  end
+
+  def database
+    Connection.new(warm_target_url)
+  end
+
+  def database_id
+    Digest::SHA1.hexdigest(warm_target_url)
+  end
+
+  def warm_target_url
+    ENV.fetch("WARM_TARGET_URL")
+  rescue KeyError
+    raise ArgumentError,
+      "To use burninator, set WARM_TARGET_URL in your environment. See https://github.com/jpignata/burninator for more details."
+  end
+
+  def redis_url
+    ENV.fetch("REDIS_URL")
+  rescue KeyError
+    raise ArgumentError,
+      "To use burninator, set REDIS_URL in your environment. See https://github.com/jpignata/burninator for more details."
+  end
+end

metadata

@@ -1,37 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: burninator
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - John Pignata
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-14 00:00:00.000000000 Z
+date: 2013-04-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 3.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.13.0
-description: Uses a pub/sub channel for broadcasting SELECT queries for replay onto
-  follower databases
+        version: 0.13.3
+description: Plays SELECT queries to your Rails application on a follower database
+  to keep its caches warm.
 email:
 - john@pignata.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/burninator/broadcaster.rb
+- lib/burninator/connection.rb
+- lib/burninator/tasks/warm.rake
+- lib/burninator/tasks.rb
+- lib/burninator/warmer.rb
+- lib/burninator.rb
 - README.md
 - LICENSE
 homepage: http://github.com/jpignata/burninator
@@ -57,5 +91,5 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: Run queries to a Rails application on your standby databases
+summary: Keep your follower database warm
 test_files: []