system_health 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02c8f10c789589d9abbf508df45a999669078ac2
-  data.tar.gz: 4345ed99e704e61313d7d49a547b94df92970664
+  metadata.gz: d46611b2952413881bc6835fc6346b1402a37184
+  data.tar.gz: e212f39b22d9953e4ad666f2641a20d36c7d379d
 SHA512:
-  metadata.gz: 33e7b601530912039ab5bd375be38564727652f42005a449b44101508768e617f5c1fc7716c0557135e826be2d96684dbb87c23cefded7837e58e664494c5b99
-  data.tar.gz: bf692fcb93e96ee7327bdec30e5298f3e7bcbd35c02a906ba8329c4d21cc9ead7995e58400f428259259f46ec9bb57ae42db128f83788cf5b26de5004c83db91
+  metadata.gz: 8126d5f48e50ffe19475d5a5d450dbe254b247b4e3979ff07a28e5f0899b65776fa05e5a6ec5399586eae76530110982437019b307298607a325fcebf739b7ef
+  data.tar.gz: e37475da47ef504d25037d600957d2f4bbd55012f0d4569916fe489146a02854e331c992dc18b284bd9ac4235fa267e3529f88d1ca4cb4419695927d540176c0

data/README.md

@@ -20,79 +20,80 @@ Or install it yourself as:
 
 and then...
 
-1. Create your monitor classes
+### Create your monitor classes
 
-  All monitoring classes require a public instance method named `description`.
-  This method should return a string describing the bad data condition that is
-  being tested.
+All monitoring classes require a public instance method named `description`.
+This method should return a string describing the bad data condition that is
+being tested.
 
-## Generic monitoring class
+#### Generic monitoring class
 
-  For example, in lib/system_health/monitors/bad_data.rb create:
+For example, in lib/system_health/monitors/bad_data.rb create:
 
-  ```ruby
-  module SystemHealth
-    module Monitors
-      class BadData < Base
-        def description
-          'Bad data was discovered'
-        end
+```ruby
+module SystemHealth
+  module Monitors
+    class BadData < Base
+      def description
+        'Bad data was discovered'
+      end
 
-        private
+      private
 
-        def bad_data?
-          # return true from this method if there is bad data
-        end
+      def bad_data?
+        # return true from this method if there is bad data
       end
     end
   end
-  ```
+end
+```
 
-  define a private instance method `bad_data?` that should return true
-  when bad data exists.
+the private instance method `bad_data?` should return true
+when bad data exists.  Note: this class inherits from `Base`.
 
-## SQL monitoring class
+#### SQL monitoring class
 
-  For example, in lib/system_health/monitors/bad_sql_data.rb create:
+For example, in lib/system_health/monitors/bad_sql_data.rb create:
 
-  ```ruby
-  module SystemHealth
-    module Monitors
-      class BadSqlData < Sql
-        def description
-          'Bad data was discovered through a SQL query'
-        end
+```ruby
+module SystemHealth
+  module Monitors
+    class BadSqlData < Sql
+      def description
+        'Bad data was discovered through a SQL query'
+      end
 
-        private
+      private
 
-        def sql
-          <<-SQL
-            SELECT *
-            FROM some_table
-            WHERE bad_data is true
-          SQL
-        end
+      def sql
+        <<-SQL
+          SELECT *
+          FROM some_table
+          WHERE bad_data is true
+        SQL
       end
     end
   end
-  ```
+end
+```
 
-  this type of monitor requires an additional private instance method
-  named `sql`.  This SQL statement should return rows for any data
-  integrity problem.  I.e. no rows means no problem.  Rows returned means
-  there is a problem.
+the private instance method `sql` should include the string version of
+the SQL to use in the system health check.  This SQL should return rows
+when there is bad data.  I.e. no rows returned means no system health problem.
+Rows returned means there is a problem.  Note: this class inherits from
+`Sql`.
 
 
-2. create an initializer in config/initializers/system_health.rb
+### Create an initializer in config/initializers/system_health.rb
 
-  ```ruby
-  SystemHealth.configure do |config|
-    config.monitor_classes = [
-      SystemHealth::Monitors::BadData,
-      SystemHealth::Monitors::BadSqlData
-    ]
-  end
-  ```
+```ruby
+SystemHealth.configure do |config|
+  config.monitor_classes = [
+    SystemHealth::Monitors::BadData,
+    SystemHealth::Monitors::BadSqlData
+  ]
+end
+```
 
 ## Usage
 
@@ -106,6 +107,16 @@ mon.error_messages
 mon.error_count
 ```
 
+by default SystemHealth::Monitor.new uses those classes defined in your
+initializer but you can initialize with your own classes, if you wish:
+
+```ruby
+mon =
+SystemHealth::Monitor.new([SystemMonitor::Monitors::SomeSpecialClass])
+mon.error_messages
+mon.error_count
+```
+
 ## To do?
 
 1. Add concept of notifiers to make it more seamless to email or report

data/lib/system_health/version.rb

@@ -1,3 +1,3 @@
 module SystemHealth
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: system_health
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Stirling Olson