simple_monitor 0.0.1 → 0.0.2

data/README.md

@@ -50,7 +50,7 @@ monitor = HighJobMonitor.new(:job_count_threshold => 99)
 monitor.check
 ```
 
-For a typical application, it could be desireable to define an
+For a typical application, it could be desirable to define an
 AppMonitor class with a default send_alert method, and have your
 individual monitor classes inherit from that.
 

data/lib/simple_monitor/version.rb

@@ -1,3 +1,3 @@
 module SimpleMonitor
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/simple_monitor.rb

@@ -4,9 +4,14 @@ module SimpleMonitor
   attr_reader :options
   attr_accessor :logger
 
+  # Sets if logging should only occur when
+  # you call it, skips implementation logging
+  attr_accessor :only_explicit_logging
+
   LOG_METHODS = %w[info warn error debug].freeze
 
   def initialize(options = {})
+    self.only_explicit_logging = options.delete(:only_explicit_logging)
     @options = options
   end
 
@@ -25,7 +30,9 @@ module SimpleMonitor
   end
 
   def warn_alert
-    warn(alert_log_message)
+    unless only_explicit_logging
+      warn(alert_log_message)
+    end
   end
 
   # Public: Message to log in case of an alert
@@ -38,7 +45,9 @@ module SimpleMonitor
   end
 
   def info_passed
-    info(passed_log_message)
+    unless only_explicit_logging
+      info(passed_log_message)
+    end
   end
 
   # Public: Message to log in case of a check passing

data/spec/simple_monitor_spec.rb

@@ -20,6 +20,11 @@ describe SimpleMonitor do
     monitor = TestMonitor.new(:foo => :bar)
     monitor.options[:foo].should == :bar
   end
+
+  it "extacts :only_explicit_logging from the passed options" do
+    TestMonitor.new.only_explicit_logging.should be_nil
+    TestMonitor.new(:only_explicit_logging => true).only_explicit_logging.should be_true
+  end
 end
 
 describe SimpleMonitor, "logger" do
@@ -66,6 +71,12 @@ describe SimpleMonitor, "running the check" do
       subject.check
     end
 
+    it "can bypass the logging if only_explicit_logging is set" do
+      subject.only_explicit_logging = true
+      logger.should_not_receive(:warn)
+      subject.check
+    end
+
     it "sends an alert" do
       subject.check
       subject.last_alert.should == "Test Monitor Alert"
@@ -84,6 +95,12 @@ describe SimpleMonitor, "running the check" do
       subject.check
     end
 
+    it "can bypass the logging if only_explicit_logging is set" do
+      subject.only_explicit_logging = true
+      logger.should_not_receive(:info)
+      subject.check
+    end
+
     it "doesn't send an alert" do
       subject.check
       subject.last_alert.should be_nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_monitor
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2160677420 !ruby/object:Gem::Requirement
+  requirement: &2155990900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160677420
+  version_requirements: *2155990900
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2160677000 !ruby/object:Gem::Requirement
+  requirement: &2155968720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,7 +33,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160677000
+  version_requirements: *2155968720
 description: ''
 email:
 - xternal1+github@gmail.com