collectd-interface 0.5.0 → 0.5.1

data/bin/collectd-interface-daemon

@@ -2,7 +2,6 @@
 
 require 'collectd/interface/options'
 require 'collectd/interface/config'
-require 'collectd/interface/service'
 
 exec_name = File.split(__FILE__)[-1]
 help = <<-EOF
@@ -34,6 +33,8 @@ Options
     Write the log output to PATH.
   --pid-file-path, -P PATH:
     Write the process ID to a file in PATH.
+  --plugin-path, -I PATH:
+    Path to additional graph and report plugins.
 
 Examples
 --------
@@ -64,6 +65,8 @@ begin
     $stdout.sync = true
     $stderr.reopen($stdout)
   end
+  # don't require Sinatra before options have been set in the configuration object!
+  require 'collectd/interface/service'
   Collectd::Interface::Service.run!
 
 rescue => exc

data/lib/collectd/interface/config.rb

@@ -6,81 +6,96 @@ require 'forwardable'
 module Collectd
   module Interface
     class Config
+
       include Singleton
+      
       def initialize
+        # Holds all configurations
         @data = Hash.new
-        defaults() 
-        find_graphs()
-        find_data()
-        find_reports()
+        # No debugging by default
+        @data['debug'] = false
+        # defaults for the Sinatra application
+        @data['service'] = Hash.new
+        @data['service']['port'] = 5000
+        @data['service']['pid_path'] = String.new
+        @data['service']['log_path'] = String.new
+        # User defined path to graphs and reports plug-ins 
+        @data['plugin_path'] = String.new
+        # find the application root directory relative to this configuration file
+        @data['root'] = File.expand_path(File.join(File.dirname(File.expand_path(__FILE__)),'..','..','..'))
+        _hostname = `hostname -f`.chop
+        # Path to the RRD file written by Collectd
+        @data['rrd_path'] = File.join('/var/lib/collectd/rrd/',_hostname)
+        graphs_add_build_ins()
+        reports_add_build_ins()
+        data_add_all_sources()
       end
-      # Hash like access to the internals
+
       def [](key); @data[key] end
       def []=(key,value); @data[key] = value end
-      # type casts & inspection
+
       def to_json; JSON.pretty_generate(@data) end   
+
       def inspect
         %Q[-- Config --\n#{self.to_json}\n------------] 
       end
-      # short cuts for attributes
-      def debug?; @data['debug'] end
-      # does the user wants to write a file containing the PID
+
+      # Is the application in debugging mode?
+      def debug?; self['debug'] end
+
+      # Path to the application root directory.
+      def root; self['root'] end
+
+      # Does the user wants to write a file containing the PID?
       def pid_file?
         self['service']['pid_path'].empty?
       end
+      # Path to the PID file.
       def pid_file(name)
         File.join(self['service']['pid_path'],"#{name}.pid")
       end
+      # Does the user wants to write a log file?
       def log_file?
         self['service']['log_path'].empty?
       end
+      # Path to the log file.
       def log_file(name)
         File.join(self['service']['log_path'],"#{name}.log")
       end
-      def root; @data['root'] end
+
+      # Add optional user plug-ins to the configuration, where
+      # _path_ is the path to the directory containing graph
+      # and report plug-ins.
+      def plugin_path(path)
+        # will be added to the Sinatra views array
+        self['plugin_path'] = path
+        # add all optional graphs
+        _path = File.join(path,'graphs')
+        if File.directory? _path
+          Dir["#{_path}/**/*.erb"].each do |file|
+            graphs_add_plugin(_path,file)
+          end
+        end
+        # add all optional reports
+        _path = File.join(path,'reports')
+        if File.directory? _path
+          Dir["#{_path}/**/*.erb"].each do |file|
+            reports_add_plugin(_path,file)
+          end
+        end
+      end
+
+      # Make sure all instance methods are accessible for client objects
       class << self
         extend Forwardable
         def_delegators :instance, *Config.instance_methods(false)
       end
+
       private
-      def defaults
-        @data['debug'] = false
-        # defaults for the Sinatra application
-        @data['service'] = Hash.new
-        @data['service']['port'] = 5000
-        @data['service']['pid_path'] = String.new
-        @data['service']['log_path'] = String.new
-        @data['service']['config_path'] = String.new
-        # find the application root directory relative to this configuration file
-        @data['root'] = File.expand_path(File.join(File.dirname(File.expand_path(__FILE__)),'..','..','..'))
-        _hostname = `hostname -f`.chop
-        @data['rrd_path'] = File.join('/var/lib/collectd/rrd/',_hostname)
-      end
-      def find_graphs
-        self['graphs'] = Hash.new
-        # path to the plug-ins shipped with this software
-        _path = File.join(self.root,'views','graphs')
-        Dir["#{_path}/**/*.erb"].each do |file|
-          # strip the template suffix
-          _name = file.gsub(/\.erb/,'')
-          # remove the path to the graph template directory
-          _name = _name.gsub(%r<#{_path}>,'')[1..-1]
-          # strip the application path from the file name
-          _file = file.gsub(%r<#{_path}/>,'').gsub(/\.erb/,'')
-          # does the plug-in supports URI parameters
-          if _name.include?('/')
-            @config = true
-            @rrd_path = self['rrd_path']
-            _supports = JSON.parse(ERB.new(File.read(file)).result(binding))
-            _supports.each do |path|
-              self['graphs']["#{_name}/#{path}"] = _file
-            end
-          else
-            self['graphs'][_name] = _file
-          end
-        end
-      end
-      def find_data
+
+      # Find all RRD files written by Collectd and construct 
+      # a list of URL paths used to access them.
+      def data_add_all_sources
         self['data'] = Array.new 
         Dir["#{self['rrd_path']}/**/*.rrd"].each do |file|
           plugin = file.gsub(%r<#{self['rrd_path']}>,'').split('/')[1]
@@ -90,28 +105,81 @@ module Collectd
           end
         end
       end
-      def find_reports
-        self['reports'] = Hash.new
-        _path = File.join(self.root,'views','reports')
-        Dir["#{_path}/**/*.erb"].each do |file|
-          # strip the template suffix
-          _name = file.gsub(/\.erb/,'')
-          # remove the path to the graph template directory
-          _name = _name.gsub(%r<#{_path}>,'')[1..-1]
-          # strip the application path from the file name
-          _file = file.gsub(%r<#{_path}/>,'').gsub(/\.erb/,'')
-          # path to the template file
-          if _name.include?('/')
-            @config = true
-            _supports = JSON.parse(ERB.new(File.read(file)).result(binding))
+
+      # Adds a graph plug-in to the configuration, where _path_ is the URL path 
+      # used to call it and _file_ is the location of the plug-in in the file-system. 
+      def graphs_add_plugin(path,file)
+        # strip the template suffix
+        _name = file.gsub(/\.erb/,'')
+        # remove the path to the graph template directory
+        _name = _name.gsub(%r<#{path}>,'')[1..-1]
+        # strip the application path from the file name
+        _file = file.gsub(%r<#{path}/>,'').gsub(/\.erb/,'')
+        # does the plug-in supports URI parameters
+        if _name.include?('/')
+          # ask the plug-in for supported paths
+          @config = true
+          @rrd_path = self['rrd_path']
+          _supports = JSON.parse(ERB.new(File.read(file)).result(binding))
+          if _supports.empty?
+            self['graphs'][_name] = _file
+          else
             _supports.each do |path|
-               self['reports']["#{_name}/#{path}"] = _file
+              self['graphs']["#{_name}/#{path}"] = _file
             end
-          else
+          end
+        else
+          self['graphs'][_name] = _file
+        end
+      end
+
+      # Searches for all graph plug-ins shipped with this application.
+      def graphs_add_build_ins
+        self['graphs'] = Hash.new
+        # path to the plug-ins shipped with this software
+        _path = File.join(self.root,'views','graphs')
+        Dir["#{_path}/**/*.erb"].each do |file|
+          graphs_add_plugin(_path,file)
+        end
+      end
+
+      # Adds a report plug-in to the configuration, where _path_ is the URL path 
+      # used to call it and _file_ is the location of the plug-in in the file-system. 
+      def reports_add_plugin(path,file)
+        # strip the template suffix
+        _name = file.gsub(/\.erb/,'')
+        # remove the path to the graph template directory
+        _name = _name.gsub(%r<#{path}>,'')[1..-1]
+        # strip the application path from the file name
+        _file = file.gsub(%r<#{path}/>,'').gsub(/\.erb/,'')
+        # if the plug-in lives inside a sub-directory
+        if _name.include?('/')
+          # ask the plug-in for its configuration
+          @config = true
+          _supports = JSON.parse(ERB.new(File.read(file)).result(binding))
+          # if the answer is empty the plug-in supports only a single URL path
+          if _supports.empty?
             self['reports'][_name] = _file
+          # otherwise add the list of paths to the configuration
+          else
+            _supports.each do |path|
+              self['reports']["#{_name}/#{path}"] = _file
+            end
           end
+        else
+          self['reports'][_name] = _file
         end
       end
+
+      # Searches for all reports shipped with this application.
+      def reports_add_build_ins
+        self['reports'] = Hash.new
+        _path = File.join(self.root,'views','reports')
+        Dir["#{_path}/**/*.erb"].each do |file|
+          reports_add_plugin(_path,file)
+        end
+      end
+
     end
   end
 end

data/lib/collectd/interface/options.rb

@@ -16,9 +16,9 @@ module Collectd
           ['--port','-p',GetoptLong::REQUIRED_ARGUMENT],
           ['--log-file-path','-l',GetoptLong::REQUIRED_ARGUMENT],
           ['--pid-file-path','-P',GetoptLong::REQUIRED_ARGUMENT],
-          ['--config-dump','-C',GetoptLong::NO_ARGUMENT],
-          ['--config','-c',GetoptLong::REQUIRED_ARGUMENT],
-          ['--version',GetoptLong::NO_ARGUMENT]
+          ['--plugin-path','-I',GetoptLong::REQUIRED_ARGUMENT],
+          ['--version',GetoptLong::NO_ARGUMENT],
+          ['--config-dump','-C',GetoptLong::NO_ARGUMENT]
         )
       end
       def parse
@@ -38,6 +38,13 @@ module Collectd
              else
                raise("#{arg} is not a directory!")
              end
+           when '--plugin-path'
+             _path = File.expand_path(arg)
+             if File.directory? arg
+               Config.plugin_path(_path)
+             else
+               raise("#{arg} is not a directory!")
+             end
            when '--config-dump'
              $stdout.puts Config.inspect
              exit 0
@@ -46,13 +53,6 @@ module Collectd
            when '--help'
              $stdout.puts @help
              exit 0
-           when '--config'
-             _config = File.expand_path(arg)
-             if File.directory? _config
-               Config['service']['config_path'] = _config
-             else
-               raise %Q[Configuration directory "#{config}" missing!]
-             end
            when '--version'
              $stdout.puts '0.5.0'
              exit 0 

data/lib/collectd/interface/service.rb

@@ -1,3 +1,4 @@
+require 'rubygems'
 require 'json'
 require 'sinatra/base'
 require 'collectd/interface/config'
@@ -14,6 +15,18 @@ module Collectd
         # read the configuration object and set the Sinatra defaults
         set :root, Config.root
         set :port, Config['service']['port']
+        # by default lookup templates in the application views/ directory
+        _views = [ File.join(Config.root,'views') ]
+        # optionally add a template directory defined by the user
+        _views << Config['plugin_path'] unless Config['plugin_path'].empty?
+        set :views, _views
+        # overwrite the template lookup method to cover all
+        # paths in views
+        def find_template(views, name, engine, &block)
+          Array(views).each do |path|
+            super(path, name, engine, &block)
+          end
+        end
         set :rrd_path, Config['rrd_path']
         set :public_folder, File.join(Config.root,'public')
         set :static, true

data/views/reports/processes.erb

@@ -1,4 +1,4 @@
-<% content = `ps -d -o pid,user,pcpu,pmem,state,time,args --sort pcpu | sed '/^ 0.0 /d' | tail -n 30` %>
+<% content = `ps -d -o pid,user,pcpu,pmem,state,time,args --sort pcpu | sed '/^ 0.0 /d'` %>
 <% if @type == 'text' then %>
 <%=  content.split("\n").reverse.join("\n") %>
 <% elsif @type == 'json' %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collectd-interface
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-13 00:00:00.000000000 +01:00
+date: 2012-03-15 00:00:00.000000000 +01:00
 default_executable: collectd-interface-daemon
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &14088680 !ruby/object:Gem::Requirement
+  requirement: &18048560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,7 +22,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *14088680
+  version_requirements: *18048560
 description: ''
 email: vic.penso@gmail.com
 executables:
@@ -36,82 +36,6 @@ files:
 - public/script/toggle.js
 - public/style/default.css
 - public/style/nav.css
-- public/images/load.png
-- public/images/network/packets/vnet3.png
-- public/images/network/packets/eth0.png
-- public/images/network/packets/vnet4.png
-- public/images/network/packets/lo.png
-- public/images/network/packets/vnet2.png
-- public/images/network/packets/vnet5.png
-- public/images/network/packets/nbr0.png
-- public/images/network/packets/vnet0.png
-- public/images/network/packets/nbr0-nic.png
-- public/images/network/packets/vnet1.png
-- public/images/network/packets/virbr0.png
-- public/images/network/traffic/vnet3.png
-- public/images/network/traffic/eth0.png
-- public/images/network/traffic/vnet4.png
-- public/images/network/traffic/lo.png
-- public/images/network/traffic/vnet2.png
-- public/images/network/traffic/vnet5.png
-- public/images/network/traffic/nbr0.png
-- public/images/network/traffic/vnet0.png
-- public/images/network/traffic/nbr0-nic.png
-- public/images/network/traffic/vnet1.png
-- public/images/network/traffic/virbr0.png
-- public/images/irqs.png
-- public/images/processes.png
-- public/images/users.png
-- public/images/device/traffic/sdh.png
-- public/images/device/traffic/sdh2.png
-- public/images/device/traffic/sdh1.png
-- public/images/device/traffic/sda6.png
-- public/images/device/traffic/sda9.png
-- public/images/device/traffic/sdh3.png
-- public/images/device/traffic/sr0.png
-- public/images/device/traffic/sdh4.png
-- public/images/device/traffic/sda.png
-- public/images/device/traffic/sda8.png
-- public/images/device/traffic/sdb.png
-- public/images/device/traffic/sda7.png
-- public/images/device/traffic/sda5.png
-- public/images/device/traffic/sda1.png
-- public/images/device/traffic/sda2.png
-- public/images/device/traffic/sdb1.png
-- public/images/device/ops/sdh.png
-- public/images/device/ops/sdh2.png
-- public/images/device/ops/sdh1.png
-- public/images/device/ops/sda6.png
-- public/images/device/ops/sda9.png
-- public/images/device/ops/sdh3.png
-- public/images/device/ops/sr0.png
-- public/images/device/ops/sdh4.png
-- public/images/device/ops/sda.png
-- public/images/device/ops/sda8.png
-- public/images/device/ops/sdb.png
-- public/images/device/ops/sda7.png
-- public/images/device/ops/sda5.png
-- public/images/device/ops/sda1.png
-- public/images/device/ops/sda2.png
-- public/images/device/ops/sdb1.png
-- public/images/device/time/sdh.png
-- public/images/device/time/sdh2.png
-- public/images/device/time/sdh1.png
-- public/images/device/time/sda6.png
-- public/images/device/time/sda9.png
-- public/images/device/time/sdh3.png
-- public/images/device/time/sr0.png
-- public/images/device/time/sdh4.png
-- public/images/device/time/sda.png
-- public/images/device/time/sda8.png
-- public/images/device/time/sdb.png
-- public/images/device/time/sda7.png
-- public/images/device/time/sda5.png
-- public/images/device/time/sda1.png
-- public/images/device/time/sda2.png
-- public/images/device/time/sdb1.png
-- public/images/cpus.png
-- public/images/memory.png
 - public/readme/user-interface.png
 - lib/collectd/interface/service/data.rb
 - lib/collectd/interface/service/graph.rb