check 0.2.0

data/Gemfile

@@ -0,0 +1,19 @@
+ruby "1.9.3"
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'awesome_print', '~> 1.1.0'
+  gem 'benchmark-ips', '~> 1.2.0'
+  gem 'pry', '~> 0.9.10'
+  gem 'rake', '~> 0.9.2.2'
+end
+
+group :test do
+  gem 'guard-minitest', '~> 0.5.0'
+  gem 'minitest', '~> 4.2.0'
+  gem 'rack-test', '~> 0.6.2'
+  gem 'redis_gun', '~> 0.1.0'
+  gem 'turn', '~> 0.9.6'
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) Gerhard Lazu
+
+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,75 @@
+# Check
+
+[![travis][1]][2]
+
+Redis backed service for monitoring metric data streams against
+pre-defined thresholds.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'check'
+
+And then run:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install check
+
+## Usage
+
+Check the examples directory. To run a specific example:
+
+    $ ruby examples/metric_check.rb
+
+NB: you will need to have all gems in the `development` group installed.
+
+## Benchmarks
+
+Check the benchmarks directory. To run a specific benchmark:
+
+    $ ruby benchmarks/metric_check.rb
+
+NB: you will need to have all gems in `development` group installed.
+
+## API
+
+The gem comes with a self-contained API. It's powered by grape and
+it includes a config.ru and unicorn.conf (check the examples folder).
+
+Unicorn is **not** declared as a dependency, feel free to choose
+whichever ruby web server you prefer in the service implementing this
+gem.
+
+If you have the gem repository cloned and want to test out the API:
+
+    unicorn -c examples/unicorn.conf.rb examples/config.ru
+
+## Notifications
+
+Check uses redis pub/sub to notify of new positives. There is a
+`Check::Notifications` class which should make it easy to set up and
+configure your own subscriber. It the simplest form, it looks like this:
+
+```ruby
+require 'check/notifications'
+
+Check::Notifications.new
+```
+
+The default notifications subscriber is highly customizable, but if this
+isn't enough, feel free to use it as an example for rolling your own.
+
+## 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
+
+[1]: https://secure.travis-ci.org/gosquared/check.png
+[2]: http://travis-ci.org/gosquared/check

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => [:test]

data/benchmarks/benchmark.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'benchmark/ips'
+require 'pry'
+
+require_relative '../test/support/redis'
+
+at_exit { stop_test_redis_server }

data/benchmarks/metric_check.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require_relative 'benchmark'
+require_relative '../lib/check/metric'
+
+metric1 = Check::Metric.new(
+  name: "metric1",
+  lower: 5,
+  matches_for_positive: 1000,
+  suspend_after_positives: 10
+).save
+
+metric2 = Check::Metric.new(
+  name: "metric2",
+  lower: 5,
+  matches_for_positive: 10,
+  suspend_after_positives: 2
+).save
+
+metric3 = Check::Metric.new(
+  name: "metric3"
+).save
+metric3.disable!
+
+below_lower = (0..4).to_a
+
+Benchmark.ips(1) do |x|
+  x.report("Check always") do
+    Check::Metric.find(name: "metric1").check(
+      value: below_lower.sample
+    )
+  end
+
+  x.report("Check suspended") do
+    Check::Metric.find(name: "metric2").check(
+      value: below_lower.sample
+    )
+  end
+
+  x.report("Check disabled") do
+    Check::Metric.find(name: "metric3").check(
+      value: below_lower.sample
+    )
+  end
+
+  x.report("Check inexistent") do
+    Check::Metric.find(name: "metric4").check(
+      value: below_lower.sample
+    )
+  end
+end

data/benchmarks/metric_crud.rb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+require_relative 'benchmark'
+require_relative '../lib/check/metric'
+
+range = (1..10000).to_a
+10000.times do |i|
+  Check::Metric.new(name: "metric-#{i}", lower: i).save
+  Check::Metric.new(name: "metric-delete", lower: range.sample).save
+end
+
+Benchmark.ips(1) do |x|
+  x.report("Create unique") do
+    i = 0
+    Check::Metric.new(
+      name:          "metric#{i}",
+      lower:         10,
+      upper:         100,
+      over_seconds:  120
+    ).save
+    i += 1
+  end
+
+  x.report("Create similar") do
+    i = 0
+    Check::Metric.new(
+      name:          "metric",
+      lower:         10,
+      upper:         100,
+      over_seconds:  120
+    ).save
+    i += 1
+  end
+
+  x.report("Delete unique") do
+    Check::Metric.new(name: "metric-delete", lower: range.sample).delete
+  end
+
+  x.report("Delete similar") do
+    sample = range.sample
+    Check::Metric.new(name: "metric-#{sample}", lower: sample).delete
+  end
+end

data/check.gemspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env gem build
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'check'
+  gem.version       = '0.2.0'
+  gem.authors       = ['Gerhard Lazu']
+  gem.email         = ['gerhard@lazu.co.uk']
+  gem.description   = 'Redis backed service for monitoring metric data streams against pre-defined thresholds'
+  gem.summary       = 'Data stream monitor'
+  gem.homepage      = 'https://github.com/gosquared/osprey'
+
+  gem.files         = Dir['lib/**/*', 'examples/**/*', 'benchmarks/**/*', 'Gemfile', 'check.gemspec', 'Rakefile', 'README.md', 'LICENSE']
+  gem.executables   = Dir['bin/*']
+  gem.test_files    = Dir['test/**/*']
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'hashr', '~> 0.0.21'
+  gem.add_runtime_dependency 'hiredis', '~> 0.4.5'
+  gem.add_runtime_dependency 'msgpack', '~> 0.4.7'
+  gem.add_runtime_dependency 'redis', '~> 3.0.2'
+  gem.add_runtime_dependency 'redis-objects', '~> 0.6.1'
+
+  ## API
+  gem.add_runtime_dependency 'grape', '~> 0.2.2'
+  gem.add_runtime_dependency 'grape-swagger', '~> 0.3.0'
+end

data/examples/config.ru

@@ -0,0 +1,4 @@
+require'bundler/setup'
+require 'check/api'
+
+run Check::API

data/examples/example.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'awesome_print'
+require 'pry'
+
+require_relative '../test/support/redis'
+
+def exemplify(description, object)
+  puts "\n::: #{description} ".ljust(70, ":::")
+  ap(object, indent: -2)
+end
+
+at_exit { stop_test_redis_server }

data/examples/metric_check.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+
+require_relative 'example'
+require_relative '../lib/check/metric'
+
+metric = Check::Metric.new(
+  name: "metric1",
+  lower: 5,
+  upper: 10,
+  matches_for_positive: 2,
+  suspend_after_positives: 1,
+  suspend_for_seconds: 60
+).save
+
+exemplify("Default metric check matches", metric.matches.values)
+
+metric.check(value: 4)
+exemplify("Metric check matches after first match", metric.matches.values)
+exemplify("Is this metric checking suspended?", metric.suspended?)
+
+metric.check(value: 3)
+exemplify("Metric check matches after second match", metric.matches.values)
+exemplify("Metric check positives after second match", metric.positives.values)
+exemplify("Is this metric checking suspended?", metric.suspended?)
+
+metric.check(value: 2)
+exemplify("As the metric check is suspended, new matches will be ignored", metric.matches.values)
+exemplify("Deleting all positives will unsuspend it", metric.delete_positives)
+
+exemplify("Metric checking manually disabled", metric.disable!)
+metric.check(value: 1)
+exemplify("As the metric check is disabled, new matches will be ignored", metric.matches.values)
+
+exemplify("Metric checking manually enabled", metric.enable!)
+metric.check(value: 0)
+exemplify("New matches no longer ignored", metric.matches.values)

data/examples/metric_crud.rb

@@ -0,0 +1,21 @@
+require_relative 'example'
+require_relative '../lib/check/metric'
+
+metric_check = Check::Metric.new(name: "metric1", lower: 10, upper: 100, over_seconds: 120).save
+exemplify("Check::Metric from hash", metric_check)
+
+metric_check = Check::Metric.new(name: metric_check[:name])
+metric_check.lower = 100
+metric_check.upper = 1000
+metric_check.over_seconds = 3600
+metric_check.matches_for_positive = 1
+metric_check.save
+exemplify("Check::Metric from attributes", metric_check)
+
+exemplify("Creating a new metric with the same name as the existing one will group them together", metric_check.similar)
+
+metric_check.delete
+exemplify("Similar metrics after metric.delete", metric_check.similar)
+
+Check::Metric.delete_all(metric_check.name)
+exemplify("Similar metrics after Metric.delete_all(name)", metric_check.similar)

data/examples/unicorn.conf.rb

@@ -0,0 +1,41 @@
+# See http://unicorn.bogomips.org/Unicorn/Configurator.html for complete
+# documentation.
+
+# Use at least one worker per core if you're on a dedicated server,
+# more will usually help for _short_ waits on databases/caches.
+worker_processes ENV.fetch('API_INSTANCES') { 1 }
+
+# listen on both a Unix domain socket and a TCP port,
+#
+# The backlog is for the listen() syscall.
+# Some operating systems allow negative values here to specify the
+# maximum allowable value. In most cases, this number is only
+# recommendation and there are other OS-specific tunables and variables
+# that can affect this number. See the listen(2) syscall documentation
+# of your OS for the exact semantics of this.
+# The shorter backlog ensures quicker failover when busy, and helps the
+# load balancer spread requests evenly.
+listen ENV.fetch('PORT') { 9000 }, backlog: ENV.fetch('TCP_BACKLOG') { 128 }.to_i
+listen ENV.fetch('SOCKET') { '/tmp/check_api.sock' }, backlog: ENV.fetch('UNIX_BACKLOG') { 128 }.to_i
+
+# Sets the timeout of worker processes to seconds. Workers handling the
+# request/app.call/response cycle taking longer than this time period
+# will be forcibly killed (via SIGKILL). This timeout is enforced by the
+# master process itself and not subject to the scheduling limitations by
+# the worker process. Due the low-complexity, low-overhead
+# implementation, timeouts of less than 3.0 seconds can be considered
+# inaccurate and unsafe.
+# For running Unicorn behind nginx, it is recommended to set
+# "fail_timeout=0" for in your nginx configuration like this to have
+# nginx always retry backends that may have had workers SIGKILL-ed due
+# to timeouts.
+timeout ENV.fetch('API_TIMEOUT') { 30 }
+
+# PID of the unicorn master process
+pid ENV.fetch('API_PID') { '/tmp/check_api.pid' }
+
+# By default, the Unicorn logger will write to stderr.
+# Additionally, some applications/frameworks log to stderr or stdout,
+# so prevent them from going to /dev/null when daemonized here:
+stderr_path ENV.fetch('API_STDERR') { $STDERR }
+stdout_path ENV.fetch('API_STDOUT') { $STDOUT }

data/lib/check.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'redis'
+
+module Check
+  extend self
+
+  # Can be either redis:// or unix://
+  REDIS_URI = ENV.fetch('REDIS_URI', "redis://localhost:6379")
+  REDIS_DB  = ENV.fetch('REDIS_DB', 0).to_i
+  REDIS_NOTIFICATIONS = ENV.fetch('REDIS_NOTIFICATIONS', "check_notifications")
+
+  Redis.current = Redis.new(
+    url:     Check::REDIS_URI,
+    db:      Check::REDIS_DB,
+    driver:  :hiredis
+  )
+end

data/lib/check/api.rb

@@ -0,0 +1,50 @@
+require 'grape'
+#require 'grape-swagger'
+
+require_relative 'api/metrics'
+
+module Check
+  class API < Grape::API
+    default_format :json
+    error_format :json
+    format :json
+
+    KEY = ENV.fetch('API_KEY') { false }
+
+    helpers do
+      def authorize!
+        if API::KEY
+          unless params[:key] == API::KEY
+            throw :error,
+                  :message => { :errors => { :key => ['invalid'] } },
+                  :status  => 401
+          end
+        end
+      end
+    end
+
+    before { authorize! }
+
+    mount Metrics
+    # add_swagger_documentation(mount_path: '/swagger')
+    #
+    # TODO: would have been very nice to get this working, but grape-swagger
+    # looks broken and I can't look into a fix for the initial release.
+    #
+    #   1. All REST methods get .json format hardcoded
+    #
+    #   2. When testing, all requests get sent with the OPTIONS method, even
+    #   though they are clearly defined as POST, DELETE etc.
+    #
+    # In the meantime, let's expose all routes
+    resources :routes do
+      # This should have been the default route, but grape requires a fix for this:
+      # https://github.com/intridea/grape/issues/86
+      desc 'The current page, showing details about all available routes'
+      get do
+        Metrics.routes.map { |route| route.instance_variable_get(:@options) }
+      end
+    end
+
+  end
+end