okcomputer 1.10.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cffefefce81a4dfb7e940984b9da870a89bb2b03
-  data.tar.gz: 2e8a2e50d9f589decc65db5e2bc695f1ec10a71b
+  metadata.gz: 5e2e3f9c41d2f33dae8b0c4150153002bd0ac548
+  data.tar.gz: 04f39dab21da2e5e854afd1690a35857fe1f0aaa
 SHA512:
-  metadata.gz: 0e9acf93048fadf4a129af1fc4606b9bca79de89d99f0d284fe88e0d86b7fff3822d396dc915b1c9062bb5fd7ccba89777e816bbc1a56374f17edc646d4092ac
-  data.tar.gz: 2758851b5e9f7ca6045de6059d91dc943f5571636ab10c52fb68c3eb572d5b5075b6cebf76e0eb8ac327ce60ec854e7b7a855054b4eedb79830f547dd863b308
+  metadata.gz: 7cc80015fab9fdfb41e2b7f10ce0c864ee288282f0c48f7e7477a13c19dae3161fdfe5dfe78b87a9e50f80e9e05da9e2b6a44c2e3132a486c9bb7244b42578b2
+  data.tar.gz: 3cb175228a439530547d779bc9efb4ed5b8f3909bcf25f52a7220bdc32e429cc2c49b7e91a0a9e73b3641474b75baae502c50714a264eaabf19aeac52feea488

data/README.markdown

@@ -126,6 +126,20 @@ end
 OkComputer::Registry.register "check_for_odds", MyCustomCheck.new
 ```
 
+### Registering Optional Checks
+
+Register an optional check like so:
+
+```ruby
+# ...
+OkComputer::Registry.register "some_optional_check", OkComputer::ResqueBackedUpCheck.new("critical", 100)
+# ...
+
+OkComputer.make_optional %w(some_optional_check another_optional_check)
+```
+
+This check will run and report its status, but will not affect the HTTP status code returned.
+
 ### Customizing plain-text output
 
 The plain-text output flows through Rails' internationalization framework.

data/config/locales/okcomputer.en.yml

@@ -1,5 +1,5 @@
 en:
   okcomputer:
     check:
-      passed: "%{registrant_name}: PASSED %{message}"
-      failed: "%{registrant_name}: FAILED %{message}"
+      passed: "%{registrant_name}: PASSED %{message} (%{time})"
+      failed: "%{registrant_name}: FAILED %{message} (%{time})"

data/lib/ok_computer/built_in_checks/optional_check.rb

@@ -0,0 +1,19 @@
+require 'delegate'
+
+module OkComputer
+  # This check wraps another check and forces it to be successful so as to
+  # avoid triggering alerts.
+  class OptionalCheck < SimpleDelegator
+    # Public: Always successful
+    def success?
+      true
+    end
+
+    # Public: The text output of performing the check
+    #
+    # Returns a String
+    def to_text
+      "#{__getobj__.to_text} (OPTIONAL)"
+    end
+  end
+end

data/lib/ok_computer/check.rb

@@ -1,3 +1,5 @@
+require "benchmark"
+
 module OkComputer
   class Check
     # to be set by Registry upon registration
@@ -6,11 +8,15 @@ module OkComputer
     attr_accessor :failure_occurred
     # nil by default, set by #check to control the output
     attr_accessor :message
+    # Float::NAN by default, set by #run to the elapsed time to run #check
+    attr_accessor :time
 
     # Public: Run the check
     def run
       clear
-      check
+      with_benchmarking do
+        check
+      end
     end
 
     # Private: Perform the appropriate check
@@ -27,7 +33,7 @@ module OkComputer
     # Returns a String
     def to_text
       passfail = success? ? "passed" : "failed"
-      I18n.t("okcomputer.check.#{passfail}", registrant_name: registrant_name, message: message)
+      I18n.t("okcomputer.check.#{passfail}", registrant_name: registrant_name, message: message, time: "#{time ? sprintf('%0.000f', time) : '?'}s")
     end
 
     # Public: The JSON output of performing the check
@@ -36,7 +42,7 @@ module OkComputer
     def to_json(*args)
       # NOTE swallowing the arguments that Rails passes by default since we don't care. This may prove to be a bad idea
       # Rails passes stuff like this: {:prefixes=>["ok_computer", "application"], :template=>"show", :layout=>#<Proc>}]
-      {registrant_name => {:message => message, :success => success?}}.to_json
+      {registrant_name => {:message => message, :success => success?, :time => time}}.to_json
     end
 
     # Public: Whether the check passed
@@ -62,6 +68,14 @@ module OkComputer
     def clear
       self.failure_occurred = false
       self.message = nil
+      self.time = Float::NAN
+    end
+
+    # Private: Benchmark the time it takes to run the block
+    def with_benchmarking
+      self.time = Benchmark.realtime do
+        yield
+      end
     end
 
     CheckNotDefined = Class.new(StandardError)

data/lib/ok_computer/configuration.rb

@@ -40,6 +40,13 @@ module OkComputer
     username && password
   end
 
+  # Public: Mark listed checks as optional
+  def self.make_optional(checks)
+    checks.each do |check|
+      OkComputer::Registry.register check, OkComputer::OptionalCheck.new(OkComputer::Registry.fetch(check))
+    end
+  end
+
   class << self
     # Public: The route to automatically mount the OkComputer engine. Setting to false
     # prevents OkComputer from automatically mounting itself.

data/lib/ok_computer/version.rb

@@ -1,3 +1,3 @@
 module OkComputer
-  VERSION = '1.10.0'
+  VERSION = '1.11.0'
 end

data/lib/okcomputer.rb

@@ -19,6 +19,7 @@ require "ok_computer/built_in_checks/elasticsearch_check"
 require "ok_computer/built_in_checks/mongoid_check"
 require "ok_computer/built_in_checks/neo4j_check"
 require "ok_computer/built_in_checks/mongoid_replica_set_check"
+require "ok_computer/built_in_checks/optional_check"
 require "ok_computer/built_in_checks/rabbitmq_check"
 require "ok_computer/built_in_checks/redis_check"
 require "ok_computer/built_in_checks/resque_backed_up_check"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: okcomputer
 version: !ruby/object:Gem::Version
-  version: 1.10.0
+  version: 1.11.0
 platform: ruby
 authors:
 - Patrick Byrne
@@ -83,6 +83,7 @@ files:
 - 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/neo4j_check.rb
+- lib/ok_computer/built_in_checks/optional_check.rb
 - lib/ok_computer/built_in_checks/rabbitmq_check.rb
 - lib/ok_computer/built_in_checks/redis_check.rb
 - lib/ok_computer/built_in_checks/resque_backed_up_check.rb