web-monitor 0.9.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Piotr Macuk
+
+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,42 @@
+# WebMonitor
+
+Website monitoring tool by response time and status
+
+## Installation
+
+Install
+
+    gem install web-monitor
+
+Create config.yml file with following options
+
+    $ cat config.yml
+    response_time_limit: 3.0          # in seconds
+    alert_mail: login@somedomain.com  # errors will be sent there
+    urls_file: urls.csv               # file with site list to monitor
+    log_file: web-monitor.log         # file with logs
+    delay: 1.0                        # delay between requests (in seconds)
+
+Create urls.csv file to monitor
+
+    $ cat urls.csv
+    google,https://www.google.pl
+    bbc,http://www.bbc.co.uk
+    err1,http://aaa.bbb.ccc.ddd.com
+    err2,https://wp.pl
+
+Execute
+
+    $ web-monitor config.yml
+
+Read logfile
+
+    $ cat web-monitor.log
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/web-monitor

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+require 'web-monitor'
+
+monitor = WebMonitor::Monitor.new(ARGV.first || 'config.yml')
+monitor.process

data/config.yml

@@ -0,0 +1,5 @@
+response_time_limit: 3       # in seconds
+alert_mail: alert@domain.com # errors will be sent there
+urls_file: urls.csv          # sites to monitor
+log_file: web-monitor.log    # file with logs
+delay: 1                     # delay between requests

data/lib/web-monitor.rb

@@ -0,0 +1,8 @@
+require 'web-monitor/version'
+
+require 'web-monitor/config'
+require 'web-monitor/logger'
+require 'web-monitor/mailer'
+require 'web-monitor/monitor'
+require 'web-monitor/requester'
+require 'web-monitor/response_validator'

data/lib/web-monitor/config.rb

@@ -0,0 +1,35 @@
+module WebMonitor
+  class Config
+    require 'yaml'
+    require 'ostruct'
+
+    DEFAULTS = {
+      response_time_limit: 3.0,
+      alert_mail: nil,
+      urls_file: 'urls.csv',
+      log_file: 'web-monitor.log',
+      delay: 1.0,
+    }
+
+    def initialize(config_file)
+      struct = YAML::load(File.open(config_file))
+      @config = OpenStruct.new(struct)
+    end
+
+    def method_missing(method, *args, &block)
+      out = @config.send(method)
+      if out.nil?
+        return DEFAULTS[method]
+      else
+        case method
+        when :response_time_limit
+          out.to_f
+        when :delay
+          out.to_f
+        else
+          out
+        end
+      end
+    end
+  end
+end

data/lib/web-monitor/logger.rb

@@ -0,0 +1,29 @@
+module WebMonitor
+  class Logger
+    require 'logger'
+
+    def initialize(config)
+      @log = ::Logger.new(config.log_file)
+      @log.datetime_format = "%Y-%m-%d %H:%M:%S"
+      @log.formatter = proc do |severity, datetime, progname, msg|
+        "#{datetime} #{severity} #{msg}\n"
+      end
+    end
+
+    def info(msg)
+      @log.info(msg)
+    end
+
+    def error(msg)
+      @log.error(msg)
+    end
+
+    def fatal(msg)
+      @log.fatal(msg)
+    end
+
+    def close
+      @log.close
+    end
+  end
+end

data/lib/web-monitor/mailer.rb

@@ -0,0 +1,12 @@
+module WebMonitor
+  class Mailer
+    def initialize(config)
+      @email = config.alert_mail
+    end
+
+    def send(msg)
+      return unless @email
+      system %(echo '' | mail -s "#{msg}" #{@email})
+    end
+  end
+end

data/lib/web-monitor/monitor.rb

@@ -0,0 +1,32 @@
+module WebMonitor
+  class Monitor
+    require 'csv'
+
+    def initialize(config_file)
+      @config = Config.new(config_file)
+      @logger = Logger.new(@config)
+      @mailer = Mailer.new(@config)
+      @requester = Requester.new(@config)
+    end
+
+    def process
+      CSV.foreach(@config.urls_file) do |name, url|
+        begin
+          @requester.check(url)
+        rescue Exception => e
+          @logger.fatal("#{name} (#{url}): #{e.class} #{e.message}")
+          @mailer.send("#{name} #{e.class}")
+          next
+        end
+        v = ResponseValidator.new(@requester.time, @requester.status, @config)
+        if v.valid?
+          @logger.info("#{name} (#{url}): %.1fs" % @requester.time)
+        else
+          @logger.error("#{name} (#{url}): #{v.error_msg}")
+          @mailer.send("#{name} #{v.error_msg}")
+        end
+        sleep @config.delay
+      end
+    end
+  end
+end

data/lib/web-monitor/requester.rb

@@ -0,0 +1,37 @@
+module WebMonitor
+  # Request URL and return time and status
+  class Requester
+    require 'net/http'
+    require 'benchmark'
+    require 'timeout'
+
+    attr_reader :time, :status
+    attr_writer :benchmark
+
+    def initialize(config)
+      @limit = config.response_time_limit
+      @timeout = @limit + 1.0
+      @benchmark = Benchmark
+    end
+
+    def check(url)
+      Timeout::timeout(@timeout) do
+        time = @benchmark.measure { get(url.strip) }
+        @time = time.real.to_f
+      end
+    rescue Timeout::Error
+      @time = @timeout
+      @status = 0
+    end
+
+    protected
+      def get(url)
+        uri = URI.parse(url)
+        Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
+          request = Net::HTTP::Get.new uri.request_uri
+          response = http.request request
+          @status = response.code.to_i
+        end
+      end
+  end
+end

data/lib/web-monitor/response_validator.rb

@@ -0,0 +1,29 @@
+module WebMonitor
+  # Validate response time and status
+  class ResponseValidator
+    attr_accessor :time, :status
+
+    def initialize(time, status, config)
+      @time, @status = time.to_f, status.to_i
+      @limit = config.response_time_limit
+    end
+
+    def valid?
+      validate_status and validate_time
+    end
+
+    def error_msg
+      return "Status=#{@status}" unless validate_status
+      return "Time=%.1fs" % @time unless validate_time
+    end
+
+    protected
+      def validate_time
+        @time <= @limit
+      end
+
+      def validate_status
+        @status == 200
+      end
+  end
+end

data/lib/web-monitor/version.rb

@@ -0,0 +1,3 @@
+module WebMonitor
+  VERSION = "0.9.1"
+end

data/test/config_test.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'web-monitor/config'
+require 'ostruct'
+
+class ConfigTest < MiniTest::Unit::TestCase
+  def test_file_settings
+    config = WebMonitor::Config.new('test/test-config.yml')
+    assert_equal 2.5, config.response_time_limit
+    assert_equal 'test@domain-test.com', config.alert_mail
+    assert_equal 'url-list.csv', config.urls_file
+    assert_equal 'monitor.log', config.log_file
+    assert_equal 1.5, config.delay
+  end
+
+  def test_default_values
+    config = WebMonitor::Config.new('test/test-minimal-config.yml')
+    assert_equal 3.0, config.response_time_limit
+    assert_equal 'test-min@domain-test.com', config.alert_mail
+    assert_equal 'urls.csv', config.urls_file
+    assert_equal 'web-monitor.log', config.log_file
+    assert_equal 1.0, config.delay
+  end
+end

data/test/logger_test.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'web-monitor/logger'
+require 'ostruct'
+
+class LoggerTest < MiniTest::Unit::TestCase
+  def setup
+    @config = OpenStruct.new(log_file: '/tmp/test.log')
+    @l = WebMonitor::Logger.new(@config)
+  end
+
+  def test_info
+    @l.info('test')
+    @l.close
+    content = File.read(@config.log_file)
+    assert_match /INFO/, content
+    assert_match /test/, content
+  end
+end

data/test/requester_test.rb

@@ -0,0 +1,36 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+require 'web-monitor/requester'
+require 'ostruct'
+
+class RequesterTest < MiniTest::Unit::TestCase
+  def setup
+    @config = OpenStruct.new(response_time_limit: 3)
+    @r = WebMonitor::Requester.new(@config)
+  end
+
+  def test_check_200
+    @r.check 'https://www.google.pl'
+    assert @r.time < 1.0
+    assert_equal 200, @r.status
+  end
+
+  def test_check_404
+    @r.check 'http://www.google.pl/abc'
+    assert @r.time < 1.0
+    assert_equal 404, @r.status
+  end
+
+  class MyBenchmark
+    def measure; sleep 5; end
+  end
+
+  def test_timeout
+    config = OpenStruct.new(response_time_limit: 0.5)
+    r = WebMonitor::Requester.new(config)
+    r.benchmark = MyBenchmark.new
+    r.check 'https://www.google.pl'
+    assert_equal 1.5, r.time
+    assert_equal 0, r.status
+  end
+end

data/test/response_validator_test.rb

@@ -0,0 +1,41 @@
+require 'minitest/autorun'
+require 'web-monitor/response_validator'
+require 'ostruct'
+
+class ResponseValidatorTest < MiniTest::Unit::TestCase
+  def setup
+    @config = OpenStruct.new(response_time_limit: 3)
+    @v = WebMonitor::ResponseValidator.new(1, 200, @config)
+  end
+
+  def test_when_valid
+    assert @v.valid?
+  end
+
+  def test_when_timeout
+    @v.time = 10
+    assert_equal false, @v.valid?
+  end
+
+  def test_when_wrong_status
+    @v.status = 404
+    assert_equal false, @v.valid?
+  end
+
+  def test_time_error_msg
+    @v.time = 10.18315
+    assert_match /Time=10.2s/, @v.error_msg
+  end
+
+  def test_status_error_msg
+    @v.status = 500
+    assert_match /Status=500/, @v.error_msg
+  end
+
+  def test_time_as_float
+    @v.time = 0.2
+    assert @v.valid?
+    @v.time = 3.2
+    assert_equal false, @v.valid?
+  end
+end

data/test/test-config.yml

@@ -0,0 +1,5 @@
+response_time_limit: 2.5
+alert_mail: test@domain-test.com
+urls_file: url-list.csv
+log_file: monitor.log
+delay: 1.5

data/test/test-minimal-config.yml

@@ -0,0 +1 @@
+alert_mail: test-min@domain-test.com

data/urls.csv

@@ -0,0 +1,4 @@
+google,https://www.google.pl
+bbc,http://www.bbc.co.uk
+err1,http://aaa.bbb.ccc.ddd.com
+err2,https://wp.pl

data/web-monitor.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/web-monitor/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Piotr Macuk"]
+  gem.email         = ["piotr@macuk.pl"]
+  gem.description   = %q{Website monitoring tool by response time and status}
+  gem.summary       = %q{Website monitoring tool}
+  gem.homepage      = "https://github.com/macuk/web-monitor"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "web-monitor"
+  gem.require_paths = ["lib"]
+  gem.version       = WebMonitor::VERSION
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: web-monitor
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
+platform: ruby
+authors:
+- Piotr Macuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-12 00:00:00.000000000 Z
+dependencies: []
+description: Website monitoring tool by response time and status
+email:
+- piotr@macuk.pl
+executables:
+- web-monitor
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/web-monitor
+- config.yml
+- lib/web-monitor.rb
+- lib/web-monitor/config.rb
+- lib/web-monitor/logger.rb
+- lib/web-monitor/mailer.rb
+- lib/web-monitor/monitor.rb
+- lib/web-monitor/requester.rb
+- lib/web-monitor/response_validator.rb
+- lib/web-monitor/version.rb
+- test/config_test.rb
+- test/logger_test.rb
+- test/requester_test.rb
+- test/response_validator_test.rb
+- test/test-config.yml
+- test/test-minimal-config.yml
+- urls.csv
+- web-monitor.gemspec
+homepage: https://github.com/macuk/web-monitor
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Website monitoring tool
+test_files:
+- test/config_test.rb
+- test/logger_test.rb
+- test/requester_test.rb
+- test/response_validator_test.rb
+- test/test-config.yml
+- test/test-minimal-config.yml