nagios-zfs 0.1.1 → 0.2.0

data/README.md

@@ -2,8 +2,6 @@
 
 Check ZFS Zpool health and capacity via Nagios.
 
-**NOTE: This is an early prototype!**
-
 ## Installation
 
 Install it via RubyGems:
@@ -18,11 +16,16 @@ Zpools.
     $ check_zpool --help
 
 A Zpool is in a critical state if the pool capacity jumps over a certain
-rate (performance usually starts to suck near 80%) or when the pool is
+rate (performance usually starts to suck at 80%) or when the pool is
 faulted.
-The status will be warning if your Zpool is degraded (not implemented
-yet!) or if the capacity breaks your warning threshold.
-Take a look at the features...
+The status will be warning if your Zpool is degraded or if the capacity
+breaks your warning threshold.
+Take a look at the
+[features](https://github.com/bjoernalbers/nagios-zfs/tree/master/features)
+...
+
+This plugin works successfully under Oracle Solaris 11 (ZFS VERSION:
+11.11,REV=2009.11.11).
 
 ## Contributing
 

data/features/check_zpool_capacity.feature

@@ -20,8 +20,8 @@ Feature: Check zpool capacity
     Then the status should be ok
 
   Scenario: Display actual capacity
-    When I run `check_zpool -p tank -w 79 -c 80`
-    Then the stdout should contain "tank 80%"
+    When I run `check_zpool -p tank -w 81 -c 82`
+    Then the stdout should contain "80%"
 
   #NOTE: This currently does not work!
   #Scenario: Unknown zpool name

data/features/check_zpool_health.feature

@@ -0,0 +1,19 @@
+Feature: Check zpool health
+
+  In order to sleep well
+  As the "data storage guy"
+  I want to check the health of my ZFS storage pools.
+
+  Scenario Outline:
+    Given the zpool "tank" has a capacity of 80%
+      And  the health from zpool "tank" is "<health>"
+    When I run `check_zpool -p tank -w 81 -c 82`
+    Then the status should be <status>
+      And the stdout should contain "<health>"
+
+    Examples:
+      | health   | status   |
+      | FAULTED  | critical |
+      | DEGRADED | warning  |
+      | ONLINE   | ok       |
+      | SICK     | unknown  |

data/features/step_definitions/dev_steps.rb

@@ -1,9 +1,18 @@
+Before do
+  @aruba_timeout_seconds = 10
+end
+
 Given(/^the zpool "(.*?)" has a capacity of (\d+)%$/) do |name, capacity|
   cmd = "zpool list -H -o name,cap #{name}"
   out = "#{name}\t#{capacity}%\n"
   double_cmd(cmd, :puts => out)
 end
 
+Given(/^the health from zpool "(.*?)" is "(.*?)"$/) do |name, health|
+  cmd = "zpool list -H -o health #{name}"
+  double_cmd(cmd, :puts => "#{health}\n")
+end
+
 Then(/^the status should be (unknown|critical|warning|ok)$/) do |status|
   exit_status =
     case status

data/lib/nagios/zfs/version.rb

@@ -1,5 +1,5 @@
 module Nagios
   module ZFS
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/nagios/zfs/zpool.rb

@@ -1,6 +1,8 @@
 module Nagios
   module ZFS
     class Zpool
+      KNOWN_POOL_HEALTHS = %(ONLINE DEGRADED FAULTED)
+
       attr_reader :name
 
       def initialize(name)
@@ -13,7 +15,14 @@ module Nagios
       end
 
       def query
-        @query ||= `zpool list -H -o name,cap #{@name}`
+        @query ||= `zpool list -H -o name,cap #{name}`
+      end
+
+      def health
+        @health ||= `zpool list -H -o health #{name}`.strip
+        raise "unknown health: #{@health}" unless
+          KNOWN_POOL_HEALTHS.include?(@health)
+        @health
       end
     end
   end

data/lib/nagios/zfs/zpool_plugin.rb

@@ -24,11 +24,11 @@ module Nagios
       end
 
       def critical?
-        critical_capacity?
+        critical_capacity? || critical_health?
       end
 
       def warning?
-        warning_capacity?
+        warning_capacity? || warning_health?
       end
 
       # No explicite ok check.
@@ -37,7 +37,7 @@ module Nagios
       end
 
       def message
-        "#{zpool.name} #{zpool.capacity}%"
+        "#{zpool.name} #{zpool.health} (#{zpool.capacity}%)"
       end
 
     private
@@ -50,6 +50,14 @@ module Nagios
         zpool.capacity >= config[:warning]
       end
 
+      def critical_health?
+        zpool.health == 'FAULTED'
+      end
+
+      def warning_health?
+        zpool.health == 'DEGRADED'
+      end
+
       def zpool
         @zpool ||= Zpool.new(config[:zpool])
       end

data/spec/nagios/zfs/zpool_plugin_spec.rb

@@ -14,20 +14,64 @@ module Nagios
         let(:argv) { [] }
 
         it 'raises an error without pool name' do
+          ZpoolPlugin.any_instance.stub(:puts) # Don't mess up our spec output.
           expect { plugin }.to raise_error(SystemExit)
         end
       end
 
       describe '#critical?' do
-        it 'returns true when capacity is critical' do
+        before do
+          plugin.stub(:critical_capacity?).and_return(false)
+          plugin.stub(:critical_health?).and_return(false)
+        end
+
+        it 'is true when capacity is critical' do
           plugin.should_receive(:critical_capacity?).and_return(true)
           expect(plugin.critical?).to be(true)
         end
 
-        it 'returns false when capacity is not critical' do
+        it 'is true when health is critical' do
+          plugin.should_receive(:critical_health?).and_return(true)
+          expect(plugin.critical?).to be(true)
+        end
+
+        it 'is false when capacity is not critical' do
           plugin.should_receive(:critical_capacity?).and_return(false)
           expect(plugin.critical?).to be(false)
         end
+
+        it 'is false when health is not critical' do
+          plugin.should_receive(:critical_health?).and_return(false)
+          expect(plugin.critical?).to be(false)
+        end
+
+      end
+
+      describe '#warning?' do
+        before do
+          plugin.stub(:warning_capacity?).and_return(false)
+          plugin.stub(:warning_health?).and_return(false)
+        end
+
+        it 'is true when capacity is warning' do
+          plugin.should_receive(:warning_capacity?).and_return(true)
+          expect(plugin.warning?).to be(true)
+        end
+
+        it 'is true when health is warning' do
+          plugin.should_receive(:warning_health?).and_return(true)
+          expect(plugin.warning?).to be(true)
+        end
+
+        it 'is false when capacity is not warning' do
+          plugin.should_receive(:warning_capacity?).and_return(false)
+          expect(plugin.warning?).to be(false)
+        end
+
+        it 'is false when health is not warning' do
+          plugin.should_receive(:warning_health?).and_return(false)
+          expect(plugin.warning?).to be(false)
+        end
       end
 
       describe '#critical_capacity?' do
@@ -38,29 +82,17 @@ module Nagios
           plugin.stub(:config).and_return({:critical => 80})
         end
 
-        it 'returns true when capacity exceeds critical threshold' do
+        it 'is true when capacity exceeds critical threshold' do
           zpool.should_receive(:capacity).and_return(80)
           expect(plugin.send(:critical_capacity?)).to be(true)
         end
 
-        it 'returns false when capacity does not exceed critical threshold' do
+        it 'is false when capacity does not exceed critical threshold' do
           zpool.should_receive(:capacity).and_return(79)
           expect(plugin.send(:critical_capacity?)).to be(false)
         end
       end
 
-      describe '#warning?' do
-        it 'returns true when capacity is warning' do
-          plugin.should_receive(:warning_capacity?).and_return(true)
-          expect(plugin.warning?).to be(true)
-        end
-
-        it 'returns false when capacity is not warning' do
-          plugin.should_receive(:warning_capacity?).and_return(false)
-          expect(plugin.warning?).to be(false)
-        end
-      end
-
       describe '#warning_capacity?' do
         let(:zpool) { double('zpool') }
 
@@ -69,17 +101,49 @@ module Nagios
           plugin.stub(:config).and_return({:warning => 80})
         end
 
-        it 'returns true when capacity exceeds warning threshold' do
+        it 'is true when capacity exceeds warning threshold' do
           zpool.should_receive(:capacity).and_return(80)
           expect(plugin.send(:warning_capacity?)).to be(true)
         end
 
-        it 'returns false when capacity does not exceed warning threshold' do
+        it 'is false when capacity does not exceed warning threshold' do
           zpool.should_receive(:capacity).and_return(79)
           expect(plugin.send(:warning_capacity?)).to be(false)
         end
       end
 
+      describe '#critical_health?' do
+        let(:zpool) { double('zpool') }
+
+        before { plugin.stub(:zpool).and_return(zpool) }
+
+        it 'is true with a faulted pool' do
+          zpool.should_receive(:health).and_return('FAULTED')
+          expect(plugin.send(:critical_health?)).to be(true)
+        end
+
+        it 'is false without a faulted pool' do
+          zpool.should_receive(:health).and_return('DEGRADED')
+          expect(plugin.send(:critical_health?)).to be(false)
+        end
+      end
+
+      describe '#warning_health?' do
+        let(:zpool) { double('zpool') }
+
+        before { plugin.stub(:zpool).and_return(zpool) }
+
+        it 'is true with a degraded pool' do
+          zpool.should_receive(:health).and_return('DEGRADED')
+          expect(plugin.send(:warning_health?)).to be(true)
+        end
+
+        it 'is false without a degraded pool' do
+          zpool.should_receive(:health).and_return('ONLINE')
+          expect(plugin.send(:warning_health?)).to be(false)
+        end
+      end
+
       describe '#ok?' do
         it 'always returns true' do
           expect(plugin.ok?).to eq(true)
@@ -87,12 +151,13 @@ module Nagios
       end
 
       describe '#message' do
-        it 'includes the pool name and capcity' do
+        it 'includes the pool name, health and capcity' do
           zpool = double('zpool')
           zpool.should_receive(:name).and_return('tank')
+          zpool.should_receive(:health).and_return('ONLINE')
           zpool.should_receive(:capacity).and_return(42)
           plugin.stub(:zpool).and_return(zpool)
-          expect(plugin.message).to eq('tank 42%')
+          expect(plugin.message).to eq('tank ONLINE (42%)')
         end
       end
 

data/spec/nagios/zfs/zpool_spec.rb

@@ -35,6 +35,21 @@ module Nagios
           2.times { expect(zpool.send(:query)).to eq('chunky bacon') }
         end
       end
+
+      describe '#health' do
+        it 'returns and caches the health by command-line' do
+          zpool.should_receive(:`).with('zpool list -H -o health tank').
+            once.and_return("ONLINE\n")
+          2.times { expect(zpool.health).to eq('ONLINE') }
+        end
+
+        it 'raises an error with an unknown health' do
+          zpool.stub(:`).and_return("SICK\n")
+          expect { zpool.health }.to raise_error /unknown health: SICK/
+        end
+
+        it 'raises an error when the command returns a non-zero exit code'
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nagios-zfs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nagiosplugin
@@ -157,6 +157,7 @@ files:
 - Rakefile
 - bin/check_zpool
 - features/check_zpool_capacity.feature
+- features/check_zpool_health.feature
 - features/step_definitions/dev_steps.rb
 - features/support/env.rb
 - lib/nagios/zfs.rb
@@ -182,7 +183,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2614810607798314703
+      hash: -1902865877853825615
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -191,15 +192,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2614810607798314703
+      hash: -1902865877853825615
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: nagios-zfs-0.1.1
+summary: nagios-zfs-0.2.0
 test_files:
 - features/check_zpool_capacity.feature
+- features/check_zpool_health.feature
 - features/step_definitions/dev_steps.rb
 - features/support/env.rb
 - spec/nagios/zfs/zpool_plugin_spec.rb