db_mon 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c7aec1564fd1a3250a73ff614f6faa8e72110576
+  data.tar.gz: c88966ae796c48ca953285e009978e7189e01edf
+SHA512:
+  metadata.gz: cfa0df816c9bef767c7a6286fc8a623a34da83bc20de9793cab9de90f2be78b92ba3fc38e57c19a7e09082a59cb798480003724bd489a6ca62b481e514a6a2e5
+  data.tar.gz: c2218b2e5b11825bcc15e226a30d7c86a823a8fd8e9bfee870f28c495abdea0d830252f0b6a2e1facb0776b571023b1c0d2f4f865dc0e8664cf640b8a7efdff4

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in db_mon.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Steve Lewis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+# DBMon
+
+DBMon is a simple database monitoring daemon that watches a given table for writes.  If it doesn't detect a certain amount of writes within a specific period of time, it triggers an alert.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dbmon'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dbmon
+
+## Usage
+
+The gem comes with a command-line utility, <code>dbmon</code>, that starts and stops the monitor in addition to other daemon tasks.  To start the monitor, simply invoke the <code>dbmon start</code> command and point to your configuration file:
+
+```
+dbmon start -- -C /path/to_your/config.yml
+```
+
+This will invoke the script as a daemon, putting it in the background.
+
+You can stop the monitor at any time by invoking <code>dbmon stop</code>
+
+
+## Configuration
+
+The configuration file for DBMon is a YAML file that allows you to specify many of the aspects of DBmon's behavior.  An example config is below:
+
+```
+interval: 10
+threshold: 1
+adapter: 'pg'
+database: 'is_development'
+table: 'users'
+username: 'stlewis'
+password: 'dbpass'
+notify: 'steve.lewis@moduspowered.com'
+delivery_method: 'smtp'
+
+```
+
+The purpose of these options is described below:
+
+**interval**
+
+How often (in seconds) to check the table for new writes. DBMon will query the table in question for writes that occurred between NOW() and <code>interval</code> ago.
+
+**threshold**
+
+This is the minimum number of records that must have been added to the database within the interval specified to avoid triggering an alert.
+
+**adapter**
+
+The database adapter to use for making connections.  Currently supported options are mysql2 and pg. Note that you must have either the mysql2 gem or the pg gem in order to use it as an adapter.
+
+**database**
+
+The name of the database to connect to.
+
+**table**
+
+The name of the table you want to monitor.
+
+**username**
+
+The database username
+
+**password**
+
+The database password
+
+**notify**
+
+The email address you would like to receive a notification when an alert is triggered.
+
+**delivery_method**
+
+This option is passed directly to the Mail gem, and determines how you would like messages delivered. The default is 'smtp', but if you would like to test email delivery, you can use 'test' as a value.
+
+
+## TODO
+
+* Make more options available for Mail configuration
+* Monitoring for multiple tables

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/dbmon

@@ -0,0 +1,9 @@
+#! /usr/bin/env ruby
+require 'optparse'
+require 'yaml'
+require 'daemons'
+
+
+path_to_file = File.expand_path('../../lib/db_mon.rb', __FILE__) 
+puts path_to_file
+Daemons.run(path_to_file, dir_mode: :normal, dir: '/tmp')

data/db_mon.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'db_mon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "db_mon"
+  spec.version       = DbMon::VERSION
+  spec.authors       = ["Steve Lewis"]
+  spec.email         = ["steve.lewis@moduspowered.com"]
+  spec.summary       = %q{DBMon is a simple daemon that monitors writes to a database table.}
+  spec.description   = %q{In many cases, one of the primary indicators of system and application health is whether or not a certain table is receiving a consistent number of writes over time.  DBMon helps to monitor database tables, and sends alerts if it doesn't see enough writes over time.}
+  spec.homepage      = "https://www.github.com/JJCOINCWEBDEV/db_mon"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/db_mon/monitor.rb

@@ -0,0 +1,77 @@
+require 'mail'
+
+
+module DbMon
+
+  class Monitor
+    
+    def initialize(options = {})
+      @interval  = options['interval']     
+      @threshold = options['threshold']
+      @database  = options['database']
+      @username  = options['username']
+      @password  = options['password']
+      @table     = options['table']
+      @notify    = options['notify']
+      @time_column = options['time_column'] || 'created_at'
+
+
+      Mail.defaults do 
+        delivery_method options['delivery_method'].to_sym
+      end
+    end
+
+
+    def monitor_table
+      while true
+        sleep @interval.to_i
+        result = query_table 
+        
+        unless result.count >= @threshold
+          send_alert_email
+        end
+      end
+    end
+
+    def query_table
+      raise "Must be implemented on child classes" 
+    end
+  
+    def send_alert_email
+      table     = @table
+      database  = @database
+      threshold = @threshold
+      interval  = @interval
+      notify    = @notify
+      
+      mail = Mail.deliver do 
+        from 'database_monitor@modustools.com'
+        to notify
+        subject 'Database Monitor Alert'
+
+        html_part do
+          content_type 'text/html; charset=UTF-8'
+          body <<-EOM
+            <h2>Database Alert</h2>
+
+            <p>
+              The #{table} table on #{database} has had less than #{threshold} record(s) 
+              added to it in the last #{interval} seconds. This may be an indication that 
+              there is a problem with the service(s) responsible for creating these records.
+            </p>
+            <p>
+             #{interval} seconds is:
+            </p>
+            #{interval/60.0} minutes<br />
+            #{(interval/60.0)/60.0} hours<br />
+            #{((interval/60.0)/60.0)/24.0} days<br />
+          EOM
+        end
+      end
+
+      p 
+
+    end
+  
+  end
+end

data/lib/db_mon/mysql_monitor.rb

@@ -0,0 +1,15 @@
+require 'mysql2'
+module DbMon
+
+  class MysqlMonitor < Monitor
+    def initialize(options)
+      super(options)
+      @connection = Mysql2::Client.new(host: 'localhost', username: @username, password: @password)    
+    end
+
+    def query_table
+      return @connection.query("SELECT #{@time_column} FROM #{@table} WHERE #{@time_column} BETWEEN '#{@interval.seconds.ago}' AND '#{Time.now}' ORDER BY #{@time_column}")
+    end
+  end
+
+end

data/lib/db_mon/pg_monitor.rb

@@ -0,0 +1,18 @@
+require 'pg'
+module DbMon
+
+  class PgMonitor < Monitor
+
+    def initialize(options)
+      super(options)
+      @connection = PG.connect(dbname: @database, user: @username, password: @password)    
+    end
+
+    def query_table
+      @connection.exec("SELECT #{@time_column} FROM #{@table} WHERE #{@time_column} BETWEEN '#{Time.now - @interval}' AND '#{Time.now}' ORDER BY #{@time_column}").values
+    end
+
+
+
+  end
+end

data/lib/db_mon/runner.rb

@@ -0,0 +1,29 @@
+require_relative 'monitor'
+
+module DbMon
+
+  class Runner
+    attr_reader :monitor
+
+
+    def initialize(options = {})
+      @monitor = nil
+      case options['adapter']
+      when 'mysql2'
+        require_relative 'mysql_monitor'
+        @monitor = MysqlMonitor.new(options)
+      when 'pg'
+        require_relative 'pg_monitor'
+        @monitor = PgMonitor.new(options)
+      when 'sqlite'
+        raise "SQLite Monitor not implemented"
+        @monitor = SqliteMonitor.new(options)
+      else
+        raise 'Unsupported Adapter'
+      end
+
+    end
+  
+  end
+
+end

data/lib/db_mon/version.rb

@@ -0,0 +1,3 @@
+module DbMon
+  VERSION = "0.0.1"
+end

data/lib/db_mon.rb

@@ -0,0 +1,21 @@
+require_relative "db_mon/version"
+require_relative 'db_mon/runner'
+
+module DbMon
+end
+
+
+options = {}
+
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: dbmon -C <path to config file>"
+  opts.on('-C', '--config FILE', 'Full path to configuration file') do |file|
+    options[:config_file] = file
+  end
+end
+optparse.parse!
+
+raise "No config file provided" unless options[:config_file]
+config  = YAML::load(File.read(options[:config_file]))
+monitor = DbMon::Runner.new(config).monitor
+monitor.monitor_table

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: db_mon
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steve Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: In many cases, one of the primary indicators of system and application
+  health is whether or not a certain table is receiving a consistent number of writes
+  over time.  DBMon helps to monitor database tables, and sends alerts if it doesn't
+  see enough writes over time.
+email:
+- steve.lewis@moduspowered.com
+executables:
+- dbmon
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/dbmon
+- db_mon.gemspec
+- lib/db_mon.rb
+- lib/db_mon/monitor.rb
+- lib/db_mon/mysql_monitor.rb
+- lib/db_mon/pg_monitor.rb
+- lib/db_mon/runner.rb
+- lib/db_mon/version.rb
+homepage: https://www.github.com/JJCOINCWEBDEV/db_mon
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: DBMon is a simple daemon that monitors writes to a database table.
+test_files: []