munin-plugin 0.0.2

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*~

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in munin-plugin.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,72 @@
+= munin
+
+* http://github.com/albanpeignier/munin/
+
+== DESCRIPTION:
+
+The munin gem provides a base class to create munin plugins in ruby.
+
+== FEATURES/PROBLEMS:
+
+* create munin plugin config output from class attributes
+* format munin plugin output from a map of values
+* support configuration based on filename
+
+== SYNOPSIS:
+
+  require 'rubygems'
+  require 'munin'
+
+  class FetchmailMailVolume < Munin::Plugin
+
+    graph_attributes "Fetchmail bytes throughput", 
+    :category => 'Mail',
+    :info => 'This graph shows the volume of mails retrieved by fetchmail'
+
+    declare_field :volume, 
+    :label => 'throughput', :type => :derive, :min => 0
+
+    def retrieve_values
+      volume = 0
+      File.open('/var/log/mail.log','r') do |f|
+        while line = f.gets
+          if line.match(/fetchmail\[[0-9]+\]: reading message .*\(([0-9]+) octets\)/)
+            volume = volume + $1.to_i
+          end
+        end
+      end
+      { :volume => volume }
+    end
+
+  end
+
+  FetchmailMailVolume.new.run
+
+== INSTALL:
+
+* sudo gem install munin
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Alban Peignier
+
+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/Rakefile

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

data/lib/munin/version.rb

@@ -0,0 +1,3 @@
+module Munin
+  VERSION = '0.0.2'
+end

data/lib/munin.rb

@@ -0,0 +1,282 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+include 'munin/version'
+
+module Munin
+
+  # Base class to create Munin plugin
+  #
+  #   class ActiveRecordSessionPlugin << Munin::Plugin
+  #     graph_attributes "Rails Sessions", 
+  #       :category => 'Application',
+  #       :info => 'This graph shows the rails application session count'
+  #
+  #     declare_field :count, :label => 'session count', :min => 0
+  #
+  #     def retrieve_values
+  #       count = ...
+  #       { :count => count }
+  #     end
+  #   end
+  #   
+  #   ActiveRecordSessionPlugin.run
+  class Plugin
+
+    class << self
+
+      @@fields = []
+
+      # Sets the graph attributes of the plugin
+      #
+      # ==== Attributes
+      # * +title+: - The title of the graph, defaults to the plugin's name (munin global attribute graph_title)
+      # * +options+: - Other graph attributes for the plugin (munin global attribute graph_*)
+      # 
+      # ==== Examples
+      #
+      #   # Set classic graph attributes
+      #   graph_attributes "Fetchmail bytes throughput", 
+      #     :category => 'Mail',
+      #     :info => 'This graph shows the volume of mails retrieved by fetchmail'
+      def graph_attributes(title, options = {})
+        @@graph_options = { :title => title, :args => '--base 1000' }.merge(options)
+      end
+
+      # Declare a data source / field of the plugin
+      #
+      # ==== Attributes
+      # * +name+: - The field name
+      # * +options+: - The field attributes
+      # 
+      # ==== Examples
+      #
+      #   # Set a derive field
+      #     declare_field :volume, :label => 'throughput', :type => :derive, :min => 0
+      def declare_field(name, options = {})
+        @@fields << Field.new(name, options)
+      end
+
+      # An elegant way to share common options
+      #
+      # ==== Attributes
+      # * +options+: - The common options
+      # 
+      # ==== Examples
+      #
+      #   # Share field attributes
+      #   with :type => :derive, :min => 0 do
+      #     declare_field :input, :label => "download"
+      #     declare_field :output, :label => "upload"
+      #   end
+      def with_options(options)
+        yield OptionMerger.new(self, options)
+      end
+
+    end
+
+    attr_reader :fields
+
+    def initialize(config = {})
+      @config = config.symbolize_keys
+
+      if self.class.respond_to?(:config_from_filename)
+        @config.merge!(self.class.config_from_filename.symbolize_keys)
+      end
+
+      @fields = @@fields.dup
+
+      after_initialize if respond_to?(:after_initialize)
+    end
+
+    # Prints plugin configuration by using the munin format
+    def print_config
+      output 'host_name', hostname unless hostname.nil?
+
+      GRAPH_ATTRIBUTES.each do |graph_attribute|
+        graph_option = @@graph_options[graph_attribute.to_sym]
+        output "graph_#{graph_attribute}", graph_option unless graph_option.nil?
+      end
+
+      fields.each do |field|
+        field.config.each_pair { |key, value| output key, value }
+      end
+    end
+
+    # Prints plugin values by using the munin format
+    def print_values
+      retrieve_values.each_pair do |name, value|
+        output "#{name}.value", value
+      end
+    end
+
+    # Create and executes the plugin
+    def self.run
+      self.new.run
+    end
+
+    # Executes the plugin
+    def run
+      case ARGV.first
+        when "config"
+          print_config
+        else
+          print_values
+      end
+    end
+
+    def declare_field(name, options = {})
+      @fields << Field.new(name, options)
+    end
+
+    protected
+
+    attr_accessor :hostname
+
+    def output(key, value)
+      puts "#{key} #{value}"
+    end
+
+    def config_value(key)
+      @config[key]
+    end
+
+    GRAPH_ATTRIBUTES = %w{ title args category info order vlabel total scale period vtitle width height printf }
+
+    private
+
+    def method_missing(method, *arguments, &block)
+      case method.id2name
+        when /^graph_([_a-z]+)$/
+          @@graph_options[$1.to_sym]
+        when /^graph_([_a-z]+)=$/
+          @@graph_options[$1.to_sym] = arguments
+        else super
+      end
+    end
+
+  end
+
+  class Field
+
+    attr_reader :name, :options
+
+    def initialize(name, options = {})
+      @name, @options = name.to_s, options
+
+      @options[:label] ||= default_label(name)
+    end
+
+    def default_label(name)
+      name.to_s.gsub('_',' ')
+    end
+
+    def option(key)
+      @options[key]
+    end
+
+    DATA_SOURCE_ATTRIBUTES = %w{ label cdef draw graph extinfo max min negative type warning critical colour skipdraw sum stack line }
+
+    def config
+      DATA_SOURCE_ATTRIBUTES.inject({}) do |config, attribute|
+        attribute = attribute.to_sym
+        attribute_value = @options[attribute]
+
+        unless attribute_value.nil?
+          case attribute
+            when :type
+              attribute_value = attribute_value.to_s.upcase
+          end
+          config["#{name}.#{attribute}"] = attribute_value
+        end
+
+        config
+      end
+    end
+
+    def ==(other)
+      other and name == other.name and options == other.options
+    end
+
+  end
+
+  class OptionMerger # from ActiveSupport
+    instance_methods.each do |method|
+      undef_method(method) if method !~ /^(__|instance_eval|class|object_id)/
+    end
+
+    def initialize(context, options)
+      @context, @options = context, options
+    end
+
+    private
+      def method_missing(method, *arguments, &block)
+        merge_argument_options! arguments
+        @context.send(method, *arguments, &block)
+      end
+
+      def merge_argument_options!(arguments)
+        arguments << if arguments.last.respond_to? :to_hash
+          @options.merge(arguments.pop)
+        else
+          @options.dup
+        end
+      end
+  end
+
+  module Hash
+    module Keys
+      # Return a new hash with all keys converted to strings.
+      def stringify_keys
+        inject({}) do |options, (key, value)|
+          options[key.to_s] = value
+          options
+        end
+      end
+
+      # Destructively convert all keys to strings.
+      def stringify_keys!
+        keys.each do |key|
+          unless key.class.to_s == "String" # weird hack to make the tests run when string_ext_test.rb is also running
+            self[key.to_s] = self[key]
+            delete(key)
+          end
+        end
+        self
+      end
+
+      # Return a new hash with all keys converted to symbols.
+      def symbolize_keys
+        inject({}) do |options, (key, value)|
+          options[key.to_sym || key] = value
+          options
+        end
+      end
+
+      # Destructively convert all keys to symbols.
+      def symbolize_keys!
+        self.replace(self.symbolize_keys)
+      end
+
+      alias_method :to_options,  :symbolize_keys
+      alias_method :to_options!, :symbolize_keys!
+
+      # Validate all keys in a hash match *valid keys, raising ArgumentError on a mismatch.
+      # Note that keys are NOT treated indifferently, meaning if you use strings for keys but assert symbol
+      # as keys, this will fail.
+      # examples:
+      #   { :name => "Rob", :years => "28" }.assert_valid_keys(:name, :age) # => raises "ArgumentError: Unknown key(s): years"
+      #   { :name => "Rob", :age => "28" }.assert_valid_keys("name", "age") # => raises "ArgumentError: Unknown key(s): years, name"
+      #   { :name => "Rob", :age => "28" }.assert_valid_keys(:name, :age) # => passes, raises nothing
+      def assert_valid_keys(*valid_keys)
+        unknown_keys = keys - [valid_keys].flatten
+        raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+      end
+    end
+  end
+
+end
+
+class Hash #:nodoc:
+  include Munin::Hash::Keys
+end

data/munin-plugin.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "munin/version"
+
+Gem::Specification.new do |s|
+  s.name        = "munin-plugin"
+  s.version     = Munin::VERSION
+  s.authors     = ["Alban Peignier"]
+  s.email       = ["alban@tryphon.eu"]
+  s.homepage    = "http://github.com/albanpeignier/munin/"
+  s.summary     = %q{Create munin plugins in ruby}
+  s.description = %q{The munin gem provides a base class to create munin plugins in ruby}
+
+  s.rubyforge_project = "munin-plugin"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  # s.add_runtime_dependency "rest-client"
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/munin.rb'}"
+puts "Loading munin gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/munin_spec.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+class TestPlugin < Munin::Plugin
+
+end
+
+describe Munin::Plugin do
+
+  before(:each) do
+    @plugin =  TestPlugin.new
+  end
+
+  it "should have a new field with declare_field" do
+    class TestPlugin 
+      declare_field :test
+    end
+    @plugin.fields.should == [ Munin::Field.new(:test) ]
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'munin'
+

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: munin-plugin
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alban Peignier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: rake
+  version_requirements: *id001
+description: The munin gem provides a base class to create munin plugins in ruby
+email: 
+- alban@tryphon.eu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/munin.rb
+- lib/munin/version.rb
+- munin-plugin.gemspec
+- script/console
+- script/destroy
+- script/generate
+- spec/munin_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/rspec.rake
+homepage: http://github.com/albanpeignier/munin/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: munin-plugin
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Create munin plugins in ruby
+test_files: 
+- spec/munin_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb