mysql-heartbeat 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6e93ade565eea9f1b66486408985bfb44d5b79ac
+  data.tar.gz: 9646d80688a80acbceabac57b5b50aa596fa878e
+SHA512:
+  metadata.gz: ed5e41132f88501024905824e6cf6ff5a99e55c592d38f1170658c74a7bfce9b00ca8ec8f72b0f8fa4914fbada56403cd3faf6aa60845c8e7587e1a0b7c25311
+  data.tar.gz: 3efd5f6234c8b32451821f4d23017b8dbb052b1085dcc5d26f5f47d6d82cd8b180d18a6fbbbfc3ebae86539ec12ed43fd1464cdff28860d7ed89ffb82ba8237f

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+bundler_args: ""
+rvm:
+  - 2.0.0
+  - 1.9.3
+env:
+  - "RACK_ENV=test"
+script:
+  - bundle exec rspec --color --format progress
+  - bundle exec rubocop

data/Gemfile

@@ -0,0 +1,20 @@
+source 'http://rubygems.org'
+gem 'sinatra'
+gem 'mysql2'
+gem 'celluloid'
+gem 'thin'
+
+group :test, :development do
+  gem 'rspec'
+end
+ 
+group :development do
+  gem 'guard'
+  gem 'guard-rubocop'
+  gem 'guard-rspec'
+end
+
+group :test do
+  gem 'rubocop'
+  gem 'rack-test'
+end

data/Gemfile.lock

@@ -0,0 +1,87 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ast (1.1.0)
+    celluloid (0.15.2)
+      timers (~> 1.1.0)
+    coderay (1.0.9)
+    daemons (1.1.9)
+    diff-lcs (1.2.4)
+    eventmachine (1.0.3)
+    ffi (1.9.3)
+    formatador (0.2.4)
+    guard (2.2.2)
+      formatador (>= 0.2.4)
+      listen (~> 2.1)
+      lumberjack (~> 1.0)
+      pry (>= 0.9.12)
+      thor (>= 0.18.1)
+    guard-rspec (4.0.3)
+      guard (>= 2.1.1)
+      rspec (~> 2.14)
+    guard-rubocop (1.0.0)
+      guard (~> 2.0)
+      rubocop (~> 0.10)
+    listen (2.2.0)
+      celluloid (>= 0.15.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+    lumberjack (1.0.4)
+    method_source (0.8.2)
+    mysql2 (0.3.13)
+    parser (2.0.0)
+      ast (~> 1.1)
+      slop (~> 3.4, >= 3.4.5)
+    powerpack (0.0.9)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rack (1.5.2)
+    rack-protection (1.5.1)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rainbow (1.1.4)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    rubocop (0.14.1)
+      parser (~> 2.0)
+      powerpack (~> 0.0.6)
+      rainbow (>= 1.1.4)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.4.6)
+    thin (1.6.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.0.0)
+    thor (0.18.1)
+    tilt (1.4.1)
+    timers (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  celluloid
+  guard
+  guard-rspec
+  guard-rubocop
+  mysql2
+  rack-test
+  rspec
+  rubocop
+  sinatra
+  thin

data/Guardfile

@@ -0,0 +1,29 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -0,0 +1,57 @@
+[![Dependency Status](https://gemnasium.com/johnbarney/mysql-heartbeat.png)](https://gemnasium.com/johnbarney/mysql-heartbeat)
+[![Build Status](https://secure.travis-ci.org/johnbarney/mysql-heartbeat.png)](http://travis-ci.org/johnbarney/mysql-heartbeat)
+[![Gem Version](https://badge.fury.io/rb/mysql-heartbeat.png)](http://badge.fury.io/rb/mysql-heartbeat)
+# MySQL Heartbeat
+
+A health monitor for MySQL replication. This can be used in tandem with applications like HAProxy to check the health of replication, and load balance across read slaves.
+
+Installation
+------------
+
+Installation is as easy as installing a gem.
+
+	$ gem install mysql-heartbeat
+	$ mysql-heartbeat yourconfig.yml
+
+Configuration
+-------------
+
+Make a copy of database.yml for each MySQL instance you want to watch. You can launch as many of these instances as you like as long as they each use a different local port.
+
+custom.yml:
+
+	host: "localhost"              # Address of MySQL instance
+	username: "health"             # Username of MySQL user
+	password: "health99"               # Password of MySQL user
+	health_port: 6977              # Port this instance of MySQL health resides on
+	tolerance: 5                   # How far behind MySQL replication can be before healthchecks fail
+
+	$ ruby heartbeat.rb custom.yml
+
+Note: The user must have REPLICATION CLIENT privileges for mysql_heartbeat to function.
+
+Example:
+
+	mysql> create user 'health'@'localhost' identified by 'health99';
+
+	mysql> grant REPLICATION CLIENT on *.* to 'health'@'localhost';
+
+Process Control
+---------------
+
+I would recommend either [Supervisord](http://supervisord.org/ "Supervisord") or [Bluepill](https://github.com/bluepill-rb/bluepill "Bluepill") to manage forking and management of instances.
+
+HAProxy Configuration
+---------------------
+
+Coming Soon!
+
+Work in Progress
+----------------
+
+This project is primarily to teach myself how to write tests, and integrate with Travis. It's still a long way from complete. Contributions and suggestions are always welcome.
+
+Contributing
+------------
+
+See GitHub's ["Fork A Repo"](https://help.github.com/articles/fork-a-repo "Forking a project") for more information.

data/bin/mysql-heartbeat

@@ -0,0 +1,15 @@
+#! /usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+if RUBY_VERSION >= '1.9.3'
+  if ARGV[0].nil? && ENV['RACK_ENV'] != 'test'
+    puts 'No configuration file specified'
+    exit 1
+  end
+  $LOAD_PATH.unshift(File.dirname(File.realpath(__FILE__)) + '/../lib')
+  require 'mysql-heartbeat'
+  HeartBeat.run!
+else
+  puts 'mysql-heartbeat supports only Ruby 1.9.3+'
+  exit(-1)
+end

data/config/example_mysql.yml

@@ -0,0 +1,5 @@
+host: "localhost"
+username: "health"
+password: "check99"
+tolerance: 5
+health_port: 6977

data/config/travis.yml

@@ -0,0 +1,5 @@
+host: 'localhost'
+username: 'travis'
+password: ''
+tolerance: 5
+health_port: 6977

data/lib/mysql-heartbeat.rb

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require 'sinatra/base'
+require 'yaml'
+require 'rack/test' if ENV['RACK_ENV'] == 'test'
+require 'mysql-heartbeat/health'
+require 'mysql-heartbeat/worker'
+require 'mysql-heartbeat/version'
+
+# Heartbeat Class
+class HeartBeat < Sinatra::Base
+  configure do
+    if ENV['RACK_ENV'] == 'test'
+      config = YAML.load_file("#{File.dirname(__FILE__)}/../config/travis.yml")
+    else
+      config = YAML.load_file(ARGV[0])
+    end
+    set :port, config['health_port'].to_i
+    set :bind, '0.0.0.0'
+    set :server, 'thin'
+    set :process, HeartbeatWorker.new(config)
+  end
+
+  options '/' do
+    settings.process.current_health
+  end
+end

data/lib/mysql-heartbeat/health.rb

@@ -0,0 +1,55 @@
+# -*- encoding: utf-8 -*-
+require 'mysql2'
+
+# Is MySQL healthy?
+class Health
+  def initialize(config)
+    @conn = Mysql2::Client.new(host: config['host'],
+                               username: config['username'],
+                               password: config['password']
+    )
+    @tolerance = config[:tolerance]
+    get_status
+  rescue => ex
+    puts ex
+    puts 'Could not connect to MySQL.'
+  end
+
+  def get_status
+    results      = @conn.query('show slave status;')
+    results.each do |row|
+      @sec_behind  = row['Seconds_Behind_Master'].to_i
+      @slave_sql   = row['Slave_SQL_Running'] == 'Yes'
+      @slave_io    = row['Slave_IO_Running'] == 'Yes'
+      @last_error  = row['Last_Error']
+    end
+  rescue => ex
+    puts ex
+    puts 'Could not query slave status.'
+  end
+
+  def replicating?
+    @slave_sql && @slave_io
+  end
+
+  def behind?
+    @sec_behind > @tolerance unless @sec_behind.nil?
+  end
+
+  def healthy?
+    if replicating? && !behind?
+      return [200, "OK\n"]
+    else
+      reason = "Replication is not healthy!
+      \nSlave_IO running: #{@slave_io}
+      \nSlave_SQL running: #{@slave_sql}
+      \nSeconds Behind: #{@sec_behind}
+      \nLast Error: #{@last_error}"
+      return [503, reason]
+    end
+  end
+
+  def conn_close
+    @conn.close unless @conn.nil?
+  end
+end

data/lib/mysql-heartbeat/version.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+# Version
+module MysqlHeartBeat
+  VERSION = '0.1.1'.freeze
+end

data/lib/mysql-heartbeat/worker.rb

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require 'celluloid'
+
+# Celluloid worker
+class HeartbeatWorker
+  include Celluloid
+  attr_reader :current_health
+
+  def initialize(config)
+    @config = config
+    async.worker
+  end
+
+  def worker
+    loop do
+      begin
+        db = Health.new(@config)
+        @current_health = db.healthy?
+        sleep 15
+      ensure
+        db.conn_close unless db.nil?
+      end
+    end
+  end
+end

data/mysql-heartbeat.gemspec

@@ -0,0 +1,29 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+require "mysql-heartbeat/version"
+
+Gem::Specification.new do |s|
+  s.name        = 'mysql-heartbeat'
+  s.version     = MysqlHeartBeat::VERSION.dup
+  s.date        = '2013-10-28'
+  s.summary     = "Queries the replication health of a MySQL server."
+  s.description = <<-EOF
+    Queries the replication health of a MySQL server.
+    A health monitor for MySQL replication. This can be used 
+    in tandem with applications like HAProxy to check the
+    health of replication, and load balance across read slaves.
+  EOF
+
+  s.add_dependency 'sinatra', '~> 1.4'
+  s.add_dependency 'mysql2', '~> 0.3'
+  s.add_dependency 'celluloid', '~> 0.15'
+  s.add_dependency 'thin', '~> 1.6'
+
+  s.authors     = ["John Barney"]
+  s.email       = 'johnb0011@gmail.com'
+  s.required_ruby_version = '>= 1.9.3'
+  s.platform    = Gem::Platform::RUBY
+  s.files       = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.homepage    = 'http://github.com/johnb0011/mysql_heartbeat'
+end

data/spec/requests/base_spec.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+# spec/features/base_spec.rb
+require_relative '../spec_helper'
+
+describe 'Root Path' do
+  describe 'OPTIONS /' do
+    before { options '/' }
+
+    it 'is successful' do
+      # Yep. I wrote a test to pass on a 503. Deal with it. (This will change)
+      expect(last_response.status).to eq(503)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+# spec/spec_helper.rb
+ENV['RACK_ENV'] = 'test'
+
+require_relative File.join('..', 'lib/mysql-heartbeat')
+
+RSpec.configure do |config|
+  include Rack::Test::Methods
+
+  def app
+    HeartBeat
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: mysql-heartbeat
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- John Barney
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: "    Queries the replication health of a MySQL server.\n    A health
+  monitor for MySQL replication. This can be used \n    in tandem with applications
+  like HAProxy to check the\n    health of replication, and load balance across read
+  slaves.\n"
+email: johnb0011@gmail.com
+executables:
+- mysql-heartbeat
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- Guardfile
+- README.md
+- bin/mysql-heartbeat
+- config/example_mysql.yml
+- config/travis.yml
+- lib/mysql-heartbeat.rb
+- lib/mysql-heartbeat/health.rb
+- lib/mysql-heartbeat/version.rb
+- lib/mysql-heartbeat/worker.rb
+- mysql-heartbeat.gemspec
+- spec/requests/base_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/johnb0011/mysql_heartbeat
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Queries the replication health of a MySQL server.
+test_files: []