nagios-zfs 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p385

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nagios-zfs.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber' do
+  watch(%r{^bin/.+$})
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('lib/nagios/zfs.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Björn Albers
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# Nagios-ZFS
+
+Check ZFS Zpool health and capacity via Nagios.
+
+**NOTE: This is an early prototype!**
+
+## Installation
+
+Install it via RubyGems:
+
+    $ gem install nagios-zfs
+
+## Usage
+
+Nagios-ZFS provices ships with a binary to check the status of your ZFS
+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
+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...
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Copyright
+
+Copyright (c) 2013 Björn Albers

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/check_zpool

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'nagios/zfs'
+
+Nagios::ZFS::ZpoolPlugin.new.check!

data/features/check_zpool_capacity.feature

@@ -0,0 +1,27 @@
+Feature: Check zpool capacity
+
+  In order to sleep well
+  As the "data storage guy"
+  I want to check the used capacity of my ZFS storage pools.
+
+  Background:
+    Given the zpool "tank" has a capacity of 80%
+
+  Scenario: Critical threshold reached
+    When I run `check_zpool -p tank -w 79 -c 80`
+    Then the status should be critical
+
+  Scenario: Warning threshold reached
+    When I run `check_zpool -p tank -w 80 -c 81`
+    Then the status should be warning
+
+  Scenario: Capacity below thresholds
+    When I run `check_zpool -p tank -w 81 -c 82`
+    Then the status should be ok
+
+  #NOTE: This currently does not work!
+  #Scenario: Unknown zpool name
+    #When I run `check_zpool -p foo -w 81 -c 82`
+    #Then the status should be unknown
+    #And the stdout should contain "unknown zpool foo"
+

data/features/step_definitions/dev_steps.rb

@@ -0,0 +1,19 @@
+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
+
+Then(/^the status should be (unknown|critical|warning|ok)$/) do |status|
+  exit_status =
+    case status
+    when 'unknown'  then 3
+    when 'critical' then 2
+    when 'warning'  then 1
+    when 'ok'       then 0
+    end
+  steps %Q(
+    Then the exit status should be #{exit_status}
+    And the stdout should contain "#{status.upcase}"
+  )
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'aruba-doubles/cucumber'

data/lib/nagios/zfs.rb

@@ -0,0 +1,5 @@
+require 'nagiosplugin'
+require 'mixlib/cli'
+require 'nagios/zfs/version'
+require 'nagios/zfs/zpool'
+require 'nagios/zfs/zpool_plugin'

data/lib/nagios/zfs/version.rb

@@ -0,0 +1,5 @@
+module Nagios
+  module ZFS
+    VERSION = '0.0.1'
+  end
+end

data/lib/nagios/zfs/zpool.rb

@@ -0,0 +1,17 @@
+module Nagios
+  module ZFS
+    class Zpool
+      def initialize(name)
+        @name = name
+      end
+
+      def capacity
+        query.split("\t").last[/^(\d+)/,1].to_i
+      end
+
+      def query
+        @query ||= `zpool list -H -o name,cap #{@name}`
+      end
+    end
+  end
+end

data/lib/nagios/zfs/zpool_plugin.rb

@@ -0,0 +1,61 @@
+module Nagios
+  module ZFS
+    class ZpoolPlugin < NagiosPlugin::Plugin
+      include Mixlib::CLI
+
+      option :zpool,
+        :short => '-p ZPOOL_NAME',
+        :long  => '--pool ZPOOL_NAME'
+
+      option :critical,
+        :short => '-c CRITICAL_CAPACITY',
+        :short => '--critical CRITICAL_CAPACITY',
+        :proc  => Proc.new { |config| config.to_i }
+
+      option :warning,
+        :short => '-w WARNING_CAPACITY',
+        :long  => '--warning WARNING_CAPACITY',
+        :proc  => Proc.new { |config| config.to_i }
+
+      def initialize
+        super
+        parse_options(argv)
+      end
+
+      def critical?
+        critical_capacity?
+      end
+
+      def warning?
+        warning_capacity?
+      end
+
+      # No explicite ok check.
+      def ok?
+        true
+      end
+
+    private
+
+      def critical_capacity?
+        zpool.capacity >= config[:critical]
+      end
+
+      def warning_capacity?
+        zpool.capacity >= config[:warning]
+      end
+
+      def zpool
+        @zpool ||= Zpool.new(config[:zpool])
+      end
+
+      # Array of command-line arguments
+      #
+      # This is only used for stubbing ARGV during tests which isn't so
+      # easy with mixlib-cli.
+      def argv
+        ARGV
+      end
+    end
+  end
+end

data/nagios-zfs.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nagios/zfs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'nagios-zfs'
+  spec.version       = Nagios::ZFS::VERSION
+  spec.authors       = ['Björn Albers']
+  spec.email         = ['bjoernalbers@googlemail.com']
+  spec.description   = 'Check ZFS Zpool health and capacity via Nagios.'
+  spec.summary       = "#{spec.name}-#{spec.version}"
+  spec.homepage      = 'https://github.com/bjoernalbers/nagios-zfs'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'nagiosplugin', '~> 2.0'
+  spec.add_dependency 'mixlib-cli', '~> 1.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'guard-cucumber'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'aruba-doubles'
+end

data/spec/nagios/zfs/zpool_plugin_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+module Nagios
+  module ZFS
+    describe ZpoolPlugin do
+      let(:plugin) { ZpoolPlugin.new }
+      let(:argv)   { [] }
+
+      before do
+        ZpoolPlugin.any_instance.stub(:argv).and_return(argv)
+      end
+
+      describe '#critical?' do
+        it 'returns 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
+          plugin.should_receive(:critical_capacity?).and_return(false)
+          expect(plugin.critical?).to be(false)
+        end
+      end
+
+      describe '#critical_capacity?' do
+        let(:zpool) { double('zpool') }
+
+        before do
+          plugin.stub(:zpool).and_return(zpool)
+          plugin.stub(:config).and_return({:critical => 80})
+        end
+
+        it 'returns 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
+          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') }
+
+        before do
+          plugin.stub(:zpool).and_return(zpool)
+          plugin.stub(:config).and_return({:warning => 80})
+        end
+
+        it 'returns 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
+          zpool.should_receive(:capacity).and_return(79)
+          expect(plugin.send(:warning_capacity?)).to be(false)
+        end
+      end
+
+      describe '#ok?' do
+        it 'always returns true' do
+          expect(plugin.ok?).to eq(true)
+        end
+      end
+
+      describe '#zpool' do
+        let(:zpool) { double('zpool') }
+
+        before do
+          plugin.stub(:config).and_return({:zpool => 'tank'})
+        end
+
+        it 'returns and caches the zpool' do
+          Zpool.should_receive(:new).with('tank').once.and_return(zpool)
+          expect(plugin.send(:zpool)).to eq(zpool)
+          expect(plugin.send(:zpool)).to eq(zpool)
+        end
+      end
+
+      describe '#config' do
+        %w(-p --pool).each do |opt|
+          name = 'tank'
+          context "with #{opt} #{name}" do
+            let(:argv) { [opt, name] }
+
+            it { expect(plugin.config[:zpool]).to eq(name) }
+          end
+        end
+
+        %w(-c --critical).each do |opt|
+          threshold = 42
+          context "with #{opt} #{threshold}" do
+            let(:argv) { [opt, threshold.to_s] }
+
+            it { expect(plugin.config[:critical]).to eq(threshold) }
+          end
+        end
+
+        %w(-w --warning).each do |opt|
+          threshold = 42
+          context "with #{opt} #{threshold}" do
+            let(:argv) { [opt, threshold.to_s] }
+
+            it { expect(plugin.config[:warning]).to eq(threshold) }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/nagios/zfs/zpool_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+module Nagios
+  module ZFS
+    describe Zpool do
+      let(:zpool) { Zpool.new('tank') }
+
+      before do
+        Zpool.any_instance.stub(:`).and_return('')
+      end
+
+      describe '#capacity' do
+        it 'returns the capacity' do
+          zpool.should_receive(:query).and_return("tank\t87%\n")
+          expect(zpool.capacity).to eq(87)
+        end
+      end
+
+      describe '#query' do
+        it 'runs and caches the zpool query for the given pool' do
+          zpool.should_receive(:`).with('zpool list -H -o name,cap tank').
+            once.and_return('chunky bacon')
+          2.times { expect(zpool.send(:query)).to eq('chunky bacon') }
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'nagios/zfs'

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: nagios-zfs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Björn Albers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nagiosplugin
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: mixlib-cli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba-doubles
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Check ZFS Zpool health and capacity via Nagios.
+email:
+- bjoernalbers@googlemail.com
+executables:
+- check_zpool
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/check_zpool
+- features/check_zpool_capacity.feature
+- features/step_definitions/dev_steps.rb
+- features/support/env.rb
+- lib/nagios/zfs.rb
+- lib/nagios/zfs/version.rb
+- lib/nagios/zfs/zpool.rb
+- lib/nagios/zfs/zpool_plugin.rb
+- nagios-zfs.gemspec
+- spec/nagios/zfs/zpool_plugin_spec.rb
+- spec/nagios/zfs/zpool_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/bjoernalbers/nagios-zfs
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4547917835531828401
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4547917835531828401
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: nagios-zfs-0.0.1
+test_files:
+- features/check_zpool_capacity.feature
+- features/step_definitions/dev_steps.rb
+- features/support/env.rb
+- spec/nagios/zfs/zpool_plugin_spec.rb
+- spec/nagios/zfs/zpool_spec.rb
+- spec/spec_helper.rb