stethoscope 0.2.2 → 0.2.3

data/.gitignore

@@ -1,3 +1,9 @@
 pkg/*
 *.gem
-.bundle
+
+/.bundle
+bundle/
+.DS_Store
+/.env
+
+.rvmrc

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stethoscope (0.2.1)
+    stethoscope (0.2.3)
       dictionary (>= 1.0)
       rack (> 1.0)
       tilt (>= 1.0)
@@ -17,8 +17,7 @@ GEM
     rack-test (0.5.4)
       rack (>= 1.0)
     rake (0.8.7)
-    rspec-core (2.0.0.beta.20)
-    tilt (1.3.4)
+    tilt (1.3.5)
 
 PLATFORMS
   ruby
@@ -30,5 +29,4 @@ DEPENDENCIES
   nanotest_extensions
   rack-test
   rake
-  rspec-core (>= 2.0.0.beta.20)
   stethoscope!

data/README.md

@@ -1,6 +1,6 @@
 # Stethoscope
 
-Stethoscope is Rack Middelware that provides heartbeats for your application.  Heartbeats are used to check that your application is functioning correctly.
+Stethoscope is Rack Middleware that provides heartbeats for your application.  Heartbeats are used to check that your application is functioning correctly.
 
 Typically, a tool like Nagios will monitor a heartbeat URL which will return a 200 OK status if everything is ok, or a 500 response for any issues.
 
@@ -18,7 +18,7 @@ Typically, a tool like Nagios will monitor a heartbeat URL which will return a 2
 
 ### Rails 3
 
-Just require Stethoscope in your application. Stethoscope has a Railtie that will configure Stethoscope to work
+Just require Stethoscope in your application. Stethoscope has a Railtie that will configure Stethoscope to work.
 
 ## Customizing Stethoscope
 
@@ -57,6 +57,24 @@ Returning a response _:status_ outside 200..299 will trigger Stethoscope to retu
 
 Any exceptions are caught and added to the response with the _:error_ key.  The template can then handle them appropriately
 
+Checks can be placed into buckets to target specific checks.
+
+    Stethoscope.check :database, :critical, :quick do |response|
+      ActiveRecord::Base.connection.execute("select 1")
+    end
+
+    Stethoscope.check :something_big, :critical, :expensive do |response|
+      do_something_expensive
+    end
+
+Now you have the put into buckets, you can choose which checks you want to execute. By default, all check are performed, but if you want to check only one type of check (all the checks in a given bucket) then you can just append the bucket name onto the url.
+
+#### Example
+
+    curl http://my.awesomeapp.com/heartbeat/critical.json # check the critical checks only
+    curl http://my.awesomeapp.com/heartbeat/quick.json    # check the quick checks only
+    curl http://my.awesomeapp.com/heartbeat.json          # check all the things
+
 #### Defaults
 
 * ActiveRecord
@@ -85,3 +103,21 @@ By default, Stethoscope provides a simple template to render the responses of th
 You can overwrite the template used:
 
     Stethoscope.template = Tilt.new("my_new_tempalte_file.haml")
+
+
+## Testing
+
+_How do I run the project's automated tests?_
+
+### Run Tests
+
+* `bundle exec rake test`
+
+## Contributing changes
+
+* Fork it.
+* Create a branch (git checkout -b my_changes)
+* Commit your changes (git commit -am "Added Some Changes")
+* Push to the branch (git push origin my_changes)
+* Open a Pull Request
+* Enjoy a refreshing Dr. Pepper© and wait

data/lib/stethoscope.rb

@@ -2,6 +2,7 @@ require 'dictionary'
 require 'tilt'
 require 'json'
 require 'stethoscope/rails'
+require 'set'
 
 # Stethoscope is Rack middleware that provides a heartbeat function to an application.
 #
@@ -16,6 +17,22 @@ require 'stethoscope/rails'
 #
 # @see Rack
 class Stethoscope
+  class Buckets < Hash
+    def []=(key,val)
+      super(key.to_s, val)
+    end
+
+    def [](key)
+      super(key.to_s)
+    end
+  end
+
+  @buckets = Buckets.new { |h, k| h[k.to_s] = Set.new }
+
+  def self.buckets
+    @buckets
+  end
+
   # Set the url to check for the heartbeat in this application
   #
   # @example
@@ -40,7 +57,7 @@ class Stethoscope
   # @see Stethoscope.check
   # @api public
   def self.checks
-    @checks ||= Dictionary.new
+    @checks ||= {}
   end
 
   # Add a check to Stethoscope
@@ -63,7 +80,10 @@ class Stethoscope
   #
   # @see Stethoscope.check
   # @api public
-  def self.check(name, &blk)
+  def self.check(name, *_buckets_, &blk)
+    _buckets_.each do |bucket|
+      buckets[bucket] << name
+    end
     checks[name] = blk
   end
 
@@ -74,6 +94,9 @@ class Stethoscope
   # @see Stethoscope.check
   # @api public
   def self.remove_check(name)
+    buckets.each do |bucket, _checks_|
+      _checks_.delete(name)
+    end
     checks.delete(name)
   end
 
@@ -81,6 +104,7 @@ class Stethoscope
   # @see Stethoscope.check
   # @api public
   def self.clear_checks
+    buckets.clear
     checks.clear
   end
 
@@ -116,7 +140,9 @@ class Stethoscope
       h[k] = {:status => 200}
     end
 
-    Stethoscope.checks.each do |name, check|
+    _checks_ = checks_to_run(request.path)
+
+    _checks_.each do |name, check|
       begin
         check.call(responses[name])
       rescue => e
@@ -142,12 +168,27 @@ class Stethoscope
   end
 
   private
+  def checks_to_run(path)
+    bucket = find_bucket_to_check(path)
+    return Stethoscope.checks if bucket.nil?
+    Stethoscope.buckets[bucket].inject({}){|h, name| h[name] = Stethoscope.checks[name]; h}
+  end
+
+  def find_bucket_to_check(path)
+    path =~ %r|#{self.class.url}\/([^\/\.]+)(\.(json))?$|
+    $1
+  end
+
   def check_heartbeat?(path)
-    path == self.class.url || path == (self.class.url + '.json')
+    regexps = [ %r|#{self.class.url}(\.json)?| ]
+    self.class.buckets.each do |name, _|
+      regexps << %r|#{File.join(self.class.url, name)}(\.json)|
+    end
+    regexps.any?{|r| path =~ r}
   end
 
   def format(path)
-    return :json if path == (self.class.url + '.json')
+    return :json if path =~ /\.json$/
     :html
   end
 end

data/lib/stethoscope/checks/active_record.rb

@@ -1,7 +1,7 @@
 require 'stethoscope'
 
 # Provides a check for active record databases
-Stethoscope.check :database do |response|
+Stethoscope.check :database, :critical do |response|
   query = "SELECT 1"
   response["query"] = query.inspect
   ActiveRecord::Base.connection.execute(query)

data/lib/stethoscope/checks/data_mapper.rb

@@ -1,7 +1,7 @@
 require 'stethoscope'
 
 # Provides a check for datamapper databases
-Stethoscope.check :database do |response|
+Stethoscope.check :database, :critical do |response|
   query = "SELECT 1"
   response["query"] = query.inspect
   DataMapper.repository.adapter.execute(query)

data/lib/stethoscope/checks/mongoid2.rb

@@ -1,7 +1,7 @@
 require 'stethoscope'
 
 # Provides a check for mongoid databases
-Stethoscope.check :database do |response|
+Stethoscope.check :database, :critical do |response|
   collection_names = Mongoid.database.collection_names
   response["collection count"] = collection_names.size
   response["Mongoid"] = "OK"

data/lib/stethoscope/checks/mongoid3.rb

@@ -1,7 +1,7 @@
 require 'stethoscope'
 
 # Provides a check for mongoid databases
-Stethoscope.check :database do |response|
+Stethoscope.check :database, :critical do |response|
   collections = Mongoid::Sessions.default.collections
   response["collection count"] = collections.size
   response["Mongoid"] = "OK"

data/lib/stethoscope/version.rb

@@ -1,3 +1,3 @@
 class Stethoscope
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/stethoscope.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.authors     = ['Daniel Neighman']
   s.email       = ['has.sox@gmail.com']
-  s.homepage    = "http://rubygems.org/gems/stethoscope"
+  s.homepage    = "http://github.com/hassox/stethoscope"
   s.summary     = "Heartbeat middleware for responding to heartbeat pings"
   s.description = "Heartbeat middleware for responding to heartbeat pings"
 
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.add_dependency              "tilt",          ">= 1.0"
 
   s.add_development_dependency  "bundler",     ">= 1.0.0"
-  s.add_development_dependency  "rspec-core",  ">= 2.0.0.beta.20"
   s.add_development_dependency  "nanotest"
   s.add_development_dependency  "nanotest_extensions"
   s.add_development_dependency  "rake"

data/test/test_stethoscope.rb

@@ -101,6 +101,29 @@ class TestStethoscope
         response = get "/heartbeat"
         assert { response.status == 500 }
       end
+
+      test do
+        Stethoscope.check(:foo, :foo, :bar){ |response| response[:status] = 200; response[:foo] = :test1 }
+        Stethoscope.check(:bar, :bar){ |response| response[:status] = 200; response[:bar] = :test2 }
+
+        response = get "/heartbeat/foo.json"
+        results = JSON.parse(response.body)
+        assert { response.status == 200 }
+        assert { results['checks']['foo']['foo'] == 'test1' }
+        assert { !results['checks'].key?('bar') }
+
+        response = get "/heartbeat/bar.json"
+        results = JSON.parse(response.body)
+        assert { response.status == 200 }
+        assert { results['checks']['foo']['foo'] == 'test1' }
+        assert { results['checks']['bar']['bar'] == 'test2' }
+
+        response = get "/heartbeat.json"
+        results = JSON.parse(response.body)
+        assert { response.status == 200 }
+        assert { results['checks']['foo']['foo'] == 'test1' }
+        assert { results['checks']['bar']['bar'] == 'test2' }
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stethoscope
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-13 00:00:00.000000000 Z
+date: 2013-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -75,22 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
-- !ruby/object:Gem::Dependency
-  name: rspec-core
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0.beta.20
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.0.0.beta.20
 - !ruby/object:Gem::Dependency
   name: nanotest
   requirement: !ruby/object:Gem::Requirement
@@ -179,7 +163,6 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .rvmrc
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -197,7 +180,7 @@ files:
 - stethoscope.gemspec
 - test/test_helper.rb
 - test/test_stethoscope.rb
-homepage: http://rubygems.org/gems/stethoscope
+homepage: http://github.com/hassox/stethoscope
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -209,6 +192,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4133514826087754687
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -217,9 +203,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: stethoscope
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Heartbeat middleware for responding to heartbeat pings
 test_files: []
-has_rdoc: 

data/.rvmrc

@@ -1,7 +0,0 @@
-
-if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
-  && -s "${rvm_path:-$HOME/.rvm}/environments/ruby-1.8.7-p302@stethoscope" ]] ; then
-  \. "${rvm_path:-$HOME/.rvm}/environments/ruby-1.8.7-p302@stethoscope"
-else
-  rvm --create use  "ruby-1.8.7-p302@stethoscope"
-fi