okcomputer 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 348a7006a93a67bfd12d4e4c67c955b29d810a0f
-  data.tar.gz: 72f3d48f7f3890f501e347b35c5d291bf8d18b19
+  metadata.gz: 8f2e2e1fbf0bd12e43eeed9987395392fefc5820
+  data.tar.gz: 071f6f634691d45b44c5f134c2d3b87534834199
 SHA512:
-  metadata.gz: b42f71808c913eb59b258654f17056c3927b17e0e13c0de1fabac2fe95fe21ab7ba1737af3f45655edc6296faef43d0625e6da4cba7b9afb33e5a994a317cdaf
-  data.tar.gz: 461fd07b2a27b6b36370ee96f8dd281a96a3e874d85a602c71c27eabafb51bceff41064ad348fc1f64f296cfc41600e20ad75d31f022b91ea79eb12f27dc7b47
+  metadata.gz: 36ef20a1ceae3441cb1ed24f5b78d1596b51724aad107a62f5b5850901b0138a1fa3e686307469749247e91ac129a0c8c574f3d152c6f5633d9aea34a66be658
+  data.tar.gz: 8f6dd78954876861034bd82052159cd7b759bfa4a7b7e25845a4d90ea86908e57c78e579bb9928510f44b3dc2b1b25e7af206045cba2050dd8351ac15f794271

data/lib/ok_computer/built_in_checks/elasticsearch_check.rb

@@ -6,17 +6,17 @@ module OkComputer
   # or red). A cluster status of red is reported as a failure, since this means
   # one or more primary shards are unavailable. Note that the app may still
   # be able to perform some queries on the available indices/shards.
-  class ElasticsearchCheck < Check
-    attr_accessor :host
-    attr_accessor :request_timeout
+  class ElasticsearchCheck < HttpCheck
+    attr_reader :host
 
     # Public: Initialize a new elasticsearch check.
     #
     # host - The hostname of elasticsearch
     # request_timeout - How long to wait to connect before timing out. Defaults to 5 seconds.
     def initialize(host, request_timeout = 5)
-      self.host = host
-      self.request_timeout = request_timeout.to_i
+      @host = URI(host)
+      health_url = URI("#{host}/_cluster/health")
+      super(health_url, request_timeout)
     end
 
     # Public: Return the status of the elasticsearch cluster
@@ -28,23 +28,15 @@ module OkComputer
       end
 
       mark_message "Connected to elasticseach cluster '#{cluster_health[:cluster_name]}', #{cluster_health[:number_of_nodes]} nodes, status '#{cluster_health[:status]}'"
-    rescue ConnectionFailed => e
+    rescue => e
       mark_failure
       mark_message "Error: '#{e}'"
     end
 
     # Returns a hash from elasticsearch's cluster health API
     def cluster_health
-      response = timeout(request_timeout) { health_url.read(read_timeout: request_timeout) }
+      response = perform_request
       JSON.parse(response, symbolize_names: true)
-    rescue => e
-      raise ConnectionFailed, e
     end
-
-    def health_url
-      @health_url ||= URI.join(host, '_cluster/health')
-    end
-
-    ConnectionFailed = Class.new(StandardError)
   end
 end

data/lib/ok_computer/built_in_checks/http_check.rb

@@ -0,0 +1,45 @@
+require "open-uri"
+
+module OkComputer
+  # Performs a health check by reading a URL over HTTP.
+  # A successful response is considered passing.
+  # To implement your own pass/fail criteria, inherit from this
+  # class, override #check, and call #perform_request to get the
+  # response body.
+  class HttpCheck < Check
+    ConnectionFailed = Class.new(StandardError)
+
+    attr_accessor :url
+    attr_accessor :request_timeout
+
+    # Public: Initialize a new HTTP check.
+    #
+    # url - The URL to check
+    # request_timeout - How long to wait to connect before timing out. Defaults to 5 seconds.
+    def initialize(url, request_timeout = 5)
+      self.url = URI(url)
+      self.request_timeout = request_timeout.to_i
+    end
+
+    # Public: Return the status of the HTTP check
+    def check
+      if perform_request
+        mark_message "HTTP check successful"
+      end
+    rescue => e
+      mark_message "Error: '#{e}'"
+      mark_failure
+    end
+
+    # Public: Actually performs the request against the URL.
+    # Returns response body if the request was successful.
+    # Otherwise raises a HttpCheck::ConnectionFailed error.
+    def perform_request
+      timeout(request_timeout) do
+        url.read(read_timeout: request_timeout)
+      end
+    rescue => e
+      raise ConnectionFailed, e
+    end
+  end
+end

data/lib/ok_computer/built_in_checks/solr_check.rb

@@ -0,0 +1,36 @@
+module OkComputer
+  # This class performs a health check on Solr instance using the
+  # admin/ping handler.
+  class SolrCheck < HttpCheck
+    attr_reader :host
+
+    # Public: Initialize a new Solr check.
+    #
+    # host - The hostname of Solr
+    # request_timeout - How long to wait to connect before timing out. Defaults to 5 seconds.
+    def initialize(host, request_timeout = 5)
+      @host = URI(host)
+      ping_url ||= URI("#{host}/admin/ping")
+      super(ping_url, request_timeout)
+    end
+
+    # Public: Return the status of Solr
+    def check
+      if ping?
+        mark_message "Solr ping reported success"
+      else
+        mark_failure
+        mark_message "Solr ping reported failure"
+      end
+    rescue => e
+      mark_failure
+      mark_message "Error: '#{e}'"
+    end
+
+    # Public: Returns true if Solr's ping returned OK, otherwise false
+    def ping?
+      response = perform_request
+      !!(response =~ %r(<str name="status">OK</str>))
+    end
+  end
+end

data/lib/ok_computer/version.rb

@@ -1,3 +1,3 @@
 module OkComputer
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/lib/okcomputer.rb

@@ -6,6 +6,8 @@ require "ok_computer/registry"
 
 # and the built-in checks
 require "ok_computer/built_in_checks/size_threshold_check"
+require "ok_computer/built_in_checks/http_check"
+
 require "ok_computer/built_in_checks/active_record_check"
 require "ok_computer/built_in_checks/app_version_check"
 require "ok_computer/built_in_checks/cache_check"
@@ -13,6 +15,7 @@ require "ok_computer/built_in_checks/default_check"
 require "ok_computer/built_in_checks/delayed_job_backed_up_check"
 require "ok_computer/built_in_checks/generic_cache_check"
 require "ok_computer/built_in_checks/elasticsearch_check"
+require "ok_computer/built_in_checks/solr_check"
 require "ok_computer/built_in_checks/mongoid_check"
 require "ok_computer/built_in_checks/mongoid_replica_set_check"
 require "ok_computer/built_in_checks/resque_backed_up_check"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Patrick Byrne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-30 00:00:00.000000000 Z
+date: 2015-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
@@ -74,6 +74,7 @@ files:
 - lib/ok_computer/built_in_checks/delayed_job_backed_up_check.rb
 - lib/ok_computer/built_in_checks/elasticsearch_check.rb
 - lib/ok_computer/built_in_checks/generic_cache_check.rb
+- lib/ok_computer/built_in_checks/http_check.rb
 - lib/ok_computer/built_in_checks/mongoid_check.rb
 - lib/ok_computer/built_in_checks/mongoid_replica_set_check.rb
 - lib/ok_computer/built_in_checks/resque_backed_up_check.rb
@@ -82,6 +83,7 @@ files:
 - lib/ok_computer/built_in_checks/ruby_version_check.rb
 - lib/ok_computer/built_in_checks/sidekiq_latency_check.rb
 - lib/ok_computer/built_in_checks/size_threshold_check.rb
+- lib/ok_computer/built_in_checks/solr_check.rb
 - lib/ok_computer/check.rb
 - lib/ok_computer/check_collection.rb
 - lib/ok_computer/configuration.rb