collectd-interface 0.1.0 → 0.2.1

data/README.md

@@ -4,21 +4,27 @@ By Victor Penso
 Description
 ===========
 
-_Collectd-Interface_ serves a web user-interface to data stored 
-by [Collectd](http://collectd.org/). Furthermore it provides REST 
-access to all data.
+_Collectd-Interface_ provides a web user-interface to data stored 
+by Collectd. Furthermore it serves a REST 
+interface to all RRD files of Collectd.
+
+![Screenshot of User-Interface](https://github.com/vpenso/collectd-interface/raw/master/public/readme/user-interface.png  "Screenshot of the User-Interface")
 
 Installation
 ============
 
-Download and install Collectd following the instructions 
+Download and install [Collectd](http://collectd.org/) following the instructions 
 from the developers. 
 
 On Debian flavored Linux use:
 
     apt-get install collectd rrdtool
 
-You will need the [RRDtool](http://oss.oetiker.ch/rrdtool/) too.
+You will need [RRDtool](http://oss.oetiker.ch/rrdtool/) too.
+
+Install the Collectd-Interface RubyGem:
+
+    gem install collectd-interface
 
 Usage
 =====
@@ -31,7 +37,9 @@ Start the Collectd Interface in fore-ground:
 
     collectd-interface-daemon
 
-Open the web-interface <a href='localhost:4567'>localhost:4567</a>.
+Open the web-interface at <a href='localhost:4567'>localhost:4567</a>.
+Collectd-Interface expects the RRD file in `/var/lib/collectd/rrd/`
+by default. Overwrite it with the option `-f PATH`.
 
 Start the Collectd Interface as daemon:
 
@@ -41,14 +49,14 @@ Start the Collectd Interface as daemon:
 Interfaces
 ==========
 
-Collectd-Interface servers three different kinds of output:
+Collectd-Interface servers three different interfaces:
 
 1. `/graph` is the user-interface showing line charts of many
    of the data accumulated by Collectd.
 2. `/report` presents tables of system specific information
-   like disk capacity of a list of network sockets.
+   like disk capacity or a list of network sockets.
 3. `/data` servers an REST API to all data available from 
-   Collectd.
+   Collectd RRD files.
 
 All content from `/graph`, `/report` and `/data` is accessible 
 by a REST interface, to allow embedding this content into other
@@ -57,13 +65,10 @@ applications.
 Graph
 -----
 
-![Screenshot of User-Interface](https://github.com/vpenso/collectd-interface/raw/master/public/readme/user-interface.png  "Screenshot of the User-Interface")
-
 You can select individual graphs using the drop-down menu followed by 
 clicking the "Show" button. In case you just want to have the image, to
-embed it into another web-page, use the links beneath the graph.
-
-Once the graph is generated the caller will be redirected to `/image/`.
+embed it into another web-page, use the links beneath the graph. Once 
+the graph is generated the caller will be redirected to `/image/`.
 
 **Parameters**
 
@@ -76,27 +81,6 @@ This simple example:
 
 Requests an SVG image with the memory graph for the last week.
 
-**Plugin**
-
-You can create add a custom graph rendering data from Collectd
-by creating a template which is used to generate the <tt>rrdtool graph</tt>.
-Take a look to the <tt>graphs/</tt> and <tt>disabled/graphs/</tt> directories 
-for examples. I recommend you the start the Collectd-Interface in
-debug mode (option <tt>-d</tt>) while you develop new graph templates.
-
-In case you want to enable graphs from <tt>disabled/graphs/</tt> create 
-a soft link from <tt>graphs/</tt>. The <tt>collectd-interface</tt> daemon will 
-automatically recognize new templates within <tt>graphs</tt> on start.
-
-Report
-------
-
-Reports a basically wrappers around commands like <tt>df -l</tt> or
-<tt>ss -ar</tt>. The output is available as HTML in the "Report" section
-of the user-interface. 
-
-TODO
-
 Data
 ----
 

data/bin/collectd-interface-daemon

@@ -137,10 +137,11 @@ class CollectdInterface < Sinatra::Base
     
     # Load all graphic plug-ins available 
     graphs = Hash.new
-    Dir["#{settings.root}/graphs/*.erb"].each do |file|
+    Dir["#{settings.root}/views/graphs/*.erb"].each do |file|
       graphs[File.basename(file,'.erb')] = file 
     end
     set :plugins, graphs
+
     # List all RRD files available
     rrd_values = Array.new
     Dir["#{settings.rrd_path}/**/*.rrd"].each do |file|
@@ -156,7 +157,6 @@ class CollectdInterface < Sinatra::Base
     reports = Hash.new
     Dir["#{settings.root}/views/reports/*.erb"].each { |f| reports[File.basename(f,'.erb')] = f }
     set :reports, reports
-
   end
 
   get '/data' do
@@ -254,7 +254,12 @@ class CollectdInterface < Sinatra::Base
     end
   end
 
+  ##
+  ## Web-Interface to all graphs generated from the Collectd RRD files
+  ##
   get '/graph' do
+    # Clients can discover a list of available graphs using the 
+    # format parameters
     if params.has_key? 'format'
       graph_list = settings.plugins.keys.sort.map! { |g| "/graph/#{g}" }
       if params['format'] == 'json'
@@ -264,17 +269,28 @@ class CollectdInterface < Sinatra::Base
         content_type :text
         graph_list.join("\n")
       end
+    # By default the web-interface will be displayed 
     else
       # default parameters
       params['last'] = '12h' unless params.has_key?('last')
       params['image'] = 'png' unless params.has_key?('image')
-      @display = params.has_key?('display') ? params['display'] : ['all'] 
-      # this parameters should not be inherited to /graph/*
+      # display only a subset of the graphs by default
+      unless params.has_key?('display')
+        params['display'] = [ 'cpus', 'memory', 'load', ]
+      end
+      # pass the list of graphs to display into the template
+      @display = params['display']
+      # remove it from the parameter list
       params.delete('display') if params.has_key?('display')
-      @graphs = settings.plugins
+      # all other parameters will be appended for the graph
+      # generation.
       p = Array.new; params.each_pair { |k,v| p << "#{k}=#{v}" }
       @args = p.join('&')
+      # list of all available graphs for the drop down menu
+      @graphs = settings.plugins
+      # identifier for the template
       @target = 'graph'
+      # render the templates
       erb :graph, :layout => "template/default".to_sym
     end
   end
@@ -283,7 +299,7 @@ class CollectdInterface < Sinatra::Base
     unless settings.plugins.has_key? path
       redirect '/'
     else
-      color = {
+      @color = {
         :red_light => '#FF000044', :red_dark => '#FF0000AA',
         :green_light => '#00F00022', :green_dark => '#00F000AA',
         :yellow_light => '#FFFF0022', :yellow_dark => '#FFFF00AA',
@@ -292,14 +308,14 @@ class CollectdInterface < Sinatra::Base
         :cyan_light => '#00FFFF22', :cyan_dark => '#00FFFFAA',
         :purple_light => '#FF00FF22', :purple_dark => '#FF00FFAA'
       }
-      type = params.has_key?('image') ? params['image'] : 'png'
-      last = params.has_key?('last') ? params['last'] : '10800s'
-      target = %Q[#{settings.public_folder}/images/#{path}.#{type}]
-      rrd_path = settings.rrd_path
-      command = ERB.new(File.read(settings.plugins[path])).result(binding)
+      @type = params.has_key?('image') ? params['image'] : 'png'
+      @last = params.has_key?('last') ? params['last'] : '10800s'
+      @target = %Q[#{settings.public_folder}/images/#{path}.#{@type}]
+      @rrd_path = settings.rrd_path
+      command = erb "graphs/#{path}".to_sym, :layout => :graph_header
       puts command if $DEBUG
       system("#{command} > /dev/null 2>&1")
-      redirect %Q[/images/#{path}.#{type}]
+      redirect %Q[/images/#{path}.#{@type}]
     end
   end
 
@@ -317,11 +333,10 @@ class CollectdInterface < Sinatra::Base
       end
     # Render a HTML representation of all/a single report(s)
     else
-      if params.has_key? 'display' and params['display'] != 'all'
-        @display = params['display']
-      else
-        @display = 'all'
+      unless params.has_key? 'display'
+        params['display'] = 'disk-free'
       end
+      @display = params['display']
       @target = 'report'
       erb :report, :layout => "template/default".to_sym
     end
@@ -352,13 +367,7 @@ class CollectdInterface < Sinatra::Base
     redirect '/graph'
   end
 
-  get '/help' do
-    @target = 'readme'
-    erb :readme, :layout => "template/default".to_sym
-  end
-
-  error do
-    flash[:error] = env['sinatra.error'].to_s
+  error 404 do
     redirect '/'
   end
 

data/bin/collectd-interface-plugins

@@ -7,7 +7,7 @@ application_root = File.expand_path(File.join(File.dirname(File.expand_path(__FI
 
 name = File.basename(__FILE__)
 
-graphs = "#{application_root}/graphs"
+graphs = "#{application_root}/views/graphs"
 reports = "#{application_root}/views/reports"
 
 def list(path)

data/views/README.md

@@ -4,21 +4,27 @@ By Victor Penso
 Description
 ===========
 
-_Collectd-Interface_ serves a web user-interface to data stored 
-by [Collectd](http://collectd.org/). Furthermore it provides REST 
-access to all data.
+_Collectd-Interface_ provides a web user-interface to data stored 
+by Collectd. Furthermore it serves a REST 
+interface to all RRD files of Collectd.
+
+![Screenshot of User-Interface](https://github.com/vpenso/collectd-interface/raw/master/public/readme/user-interface.png  "Screenshot of the User-Interface")
 
 Installation
 ============
 
-Download and install Collectd following the instructions 
+Download and install [Collectd](http://collectd.org/) following the instructions 
 from the developers. 
 
 On Debian flavored Linux use:
 
     apt-get install collectd rrdtool
 
-You will need the [RRDtool](http://oss.oetiker.ch/rrdtool/) too.
+You will need [RRDtool](http://oss.oetiker.ch/rrdtool/) too.
+
+Install the Collectd-Interface RubyGem:
+
+    gem install collectd-interface
 
 Usage
 =====
@@ -31,7 +37,9 @@ Start the Collectd Interface in fore-ground:
 
     collectd-interface-daemon
 
-Open the web-interface <a href='localhost:4567'>localhost:4567</a>.
+Open the web-interface at <a href='localhost:4567'>localhost:4567</a>.
+Collectd-Interface expects the RRD file in `/var/lib/collectd/rrd/`
+by default. Overwrite it with the option `-f PATH`.
 
 Start the Collectd Interface as daemon:
 
@@ -41,14 +49,14 @@ Start the Collectd Interface as daemon:
 Interfaces
 ==========
 
-Collectd-Interface servers three different kinds of output:
+Collectd-Interface servers three different interfaces:
 
 1. `/graph` is the user-interface showing line charts of many
    of the data accumulated by Collectd.
 2. `/report` presents tables of system specific information
-   like disk capacity of a list of network sockets.
+   like disk capacity or a list of network sockets.
 3. `/data` servers an REST API to all data available from 
-   Collectd.
+   Collectd RRD files.
 
 All content from `/graph`, `/report` and `/data` is accessible 
 by a REST interface, to allow embedding this content into other
@@ -57,13 +65,10 @@ applications.
 Graph
 -----
 
-![Screenshot of User-Interface](https://github.com/vpenso/collectd-interface/raw/master/public/readme/user-interface.png  "Screenshot of the User-Interface")
-
 You can select individual graphs using the drop-down menu followed by 
 clicking the "Show" button. In case you just want to have the image, to
-embed it into another web-page, use the links beneath the graph.
-
-Once the graph is generated the caller will be redirected to `/image/`.
+embed it into another web-page, use the links beneath the graph. Once 
+the graph is generated the caller will be redirected to `/image/`.
 
 **Parameters**
 
@@ -76,27 +81,6 @@ This simple example:
 
 Requests an SVG image with the memory graph for the last week.
 
-**Plugin**
-
-You can create add a custom graph rendering data from Collectd
-by creating a template which is used to generate the <tt>rrdtool graph</tt>.
-Take a look to the <tt>graphs/</tt> and <tt>disabled/graphs/</tt> directories 
-for examples. I recommend you the start the Collectd-Interface in
-debug mode (option <tt>-d</tt>) while you develop new graph templates.
-
-In case you want to enable graphs from <tt>disabled/graphs/</tt> create 
-a soft link from <tt>graphs/</tt>. The <tt>collectd-interface</tt> daemon will 
-automatically recognize new templates within <tt>graphs</tt> on start.
-
-Report
-------
-
-Reports a basically wrappers around commands like <tt>df -l</tt> or
-<tt>ss -ar</tt>. The output is available as HTML in the "Report" section
-of the user-interface. 
-
-TODO
-
 Data
 ----
 

data/views/graph_header.erb

@@ -0,0 +1,6 @@
+rrdtool graph <%= @target %> \
+-a <%= @type.upcase %> \
+--end now --start=end-<%= @last %> \
+--grid-dash 1:1 --width=400 --height=100 \
+--tabwidth=10 --border=0 --color=BACK#FFFFFF \
+<%= yield %>

data/views/graphs/cpus.erb

@@ -0,0 +1,73 @@
+<% 
+
+lines = String.new
+areas = String.new
+cores = `grep -c processor /proc/cpuinfo`.to_i
+limit = cores*100
+
+if cores > 1
+  cores = "#{cores} cores"
+else
+  cores = "#{cores} core"
+end
+
+def define(name,files,function = "AVERAGE")
+  defs = String.new
+  cdef = "CDEF:#{name}="
+  tail = String.new
+  cpu  = 1
+  files.each do |f|
+    n = "#{name}_#{cpu}"
+    defs << %Q[DEF:#{n}=#{f}:value:#{function} ] 
+    cdef << "#{n},"
+    tail << "+,"
+    cpu += 1
+  end
+  return defs << cdef << tail.chop.chop.chop << ' '
+end
+
+definitions = define('sys_av',Dir["#{@rrd_path}cpu*/cpu-system.rrd"] )
+definitions << define('sys_min',Dir["#{@rrd_path}cpu*/cpu-system.rrd"],'MIN' )
+definitions << define('sys_max',Dir["#{@rrd_path}cpu*/cpu-system.rrd"],'MAX' )
+lines << %Q[LINE1:sys_av#{@color[:green_dark]}:'System\t\t\t\t\t' GPRINT:sys_min:MIN:"Min. %4.0lf" GPRINT:sys_av:AVERAGE:"Avg. %4.0lf" GPRINT:sys_max:MAX:"Max. %4.0lf" GPRINT:sys_av:LAST:'Last %4.0lf'  ]
+
+
+definitions << define('user_av',Dir["#{@rrd_path}cpu*/cpu-user.rrd"] )
+definitions << define('user_min',Dir["#{@rrd_path}cpu*/cpu-user.rrd"],'MIN' )
+definitions << define('user_max',Dir["#{@rrd_path}cpu*/cpu-user.rrd"],'MAX' )
+lines << %Q[LINE1:user_av#{@color[:blue_dark]}:'User\t\t\t\t\t\t\t' GPRINT:user_min:MIN:"Min. %4.0lf" GPRINT:user_av:AVERAGE:"Avg. %4.0lf" GPRINT:user_max:MAX:'Max. %4.0lf' GPRINT:user_av:LAST:'Last %4.0lf' ]
+
+definitions << define('idle_av',Dir["#{@rrd_path}cpu*/cpu-idle.rrd"] )
+definitions << define('idle_min',Dir["#{@rrd_path}cpu*/cpu-idle.rrd"],'MIN' )
+definitions << define('idle_max',Dir["#{@rrd_path}cpu*/cpu-idle.rrd"],'MAX' )
+areas << %Q[AREA:idle_av#F5F5F588 ] 
+lines << %Q[LINE1:idle_av#CCCCCCAA:'Idle\t\t\t\t\t\t\t' GPRINT:idle_min:MIN:"Min. %4.0lf" GPRINT:idle_av:AVERAGE:"Avg. %4.0lf" GPRINT:idle_max:MAX:"Max. %4.0lf" GPRINT:idle_av:LAST:'Last %4.0lf' ]
+
+definitions << define('nice_av',Dir["#{@rrd_path}cpu*/cpu-nice.rrd"] )
+definitions << define('nice_min',Dir["#{@rrd_path}cpu*/cpu-nice.rrd"],'MIN' )
+definitions << define('nice_max',Dir["#{@rrd_path}cpu*/cpu-nice.rrd"],'MAX' )
+lines << %Q[LINE1:nice_av#{@color[:yellow_dark]}:'Nice\t\t\t\t\t\t\t' GPRINT:nice_min:MIN:"Min. %4.0lf" GPRINT:nice_av:AVERAGE:"Avg. %4.0lf" GPRINT:nice_max:MAX:"Max. %4.0lf" GPRINT:nice_av:LAST:'Last %4.0lf' ]
+
+definitions << define('wait_av',Dir["#{@rrd_path}cpu*/cpu-wait.rrd"] )
+definitions << define('wait_min',Dir["#{@rrd_path}cpu*/cpu-wait.rrd"],'MIN' )
+definitions << define('wait_max',Dir["#{@rrd_path}cpu*/cpu-wait.rrd"],'MAX' )
+lines << %Q[LINE1:wait_av#{@color[:orange_dark]}:'Wait (IO)\t\t\t' GPRINT:wait_min:MIN:"Min. %4.0lf" GPRINT:wait_av:AVERAGE:"Avg. %4.0lf" GPRINT:wait_max:MAX:"Max. %4.0lf" GPRINT:wait_av:LAST:"Last %4.0lf" ]
+
+definitions << define('steal_av',Dir["#{@rrd_path}cpu*/cpu-steal.rrd"] )
+definitions << define('steal_min',Dir["#{@rrd_path}cpu*/cpu-steal.rrd"],'MIN' )
+definitions << define('steal_max',Dir["#{@rrd_path}cpu*/cpu-steal.rrd"],'MAX' )
+lines << %Q[LINE1:steal_av#{@color[:red_dark]}:'Steal\t\t\t\t\t\t' GPRINT:steal_min:MIN:"Min. %4.0lf" GPRINT:steal_av:AVERAGE:"Avg. %4.0lf" GPRINT:steal_max:MAX:"Max. %4.0lf" GPRINT:steal_av:LAST:"Last %4.0lf" ]
+
+
+definitions << define('int_av',Dir["#{@rrd_path}cpu*/cpu-interrupt.rrd"] )
+definitions << define('int_min',Dir["#{@rrd_path}cpu*/cpu-interrupt.rrd"],'MIN' )
+definitions << define('int_max',Dir["#{@rrd_path}cpu*/cpu-interrupt.rrd"],'MAX' )
+lines << %Q[LINE1:int_av#{@color[:cyan_dark]}:'IRQ\t\t\t\t\t\t\t\t' GPRINT:int_min:MIN:"Min. %4.0lf" GPRINT:int_av:AVERAGE:"Avg. %4.0lf" GPRINT:int_max:MAX:"Max. %4.0lf" GPRINT:int_av:LAST:"Last %4.0lf" ]
+
+definitions << define('sint_av',Dir["#{@rrd_path}cpu*/cpu-softirq.rrd"] )
+definitions << define('sint_min',Dir["#{@rrd_path}cpu*/cpu-softirq.rrd"],'MIN' )
+definitions << define('sint_max',Dir["#{@rrd_path}cpu*/cpu-softirq.rrd"],'MAX' )
+lines << %Q[LINE1:sint_av#{@color[:purple_dark]}:'IRQ (soft)\t\t\t' GPRINT:sint_min:MIN:"Min. %4.0lf" GPRINT:sint_av:AVERAGE:"Avg. %4.0lf" GPRINT:sint_max:MAX:"Max. %4.0lf" GPRINT:sint_av:LAST:"Last %4.0lf" ]
+
+
+%> --title="CPU Usage (<%= cores %>)" --vertical-label="Jiffies" --units-exponent=k --lower-limit=0 --legend-position=south --force-rules-legend --slope-mode --upper-limit <%= limit %>  <%= definitions %> <%= areas %> <%= lines %>

data/views/graphs/disk-traffic-root.erb

@@ -0,0 +1,24 @@
+<% name = '/' %>
+<% device = `df -l #{name} | grep '/dev/'`.split[0].split('/')[-1] %>
+--title='Disk Traffic "<%= name %>"' --vertical-label="Bytes" \
+--alt-autoscale-max --base 1024 \
+DEF:read_av=<%= @rrd_path %>disk-<%= device %>/disk_octets.rrd:read:AVERAGE \
+DEF:read_min=<%= @rrd_path %>disk-<%= device %>/disk_octets.rrd:read:MIN \
+DEF:read_max=<%= @rrd_path %>disk-<%= device %>/disk_octets.rrd:read:MAX \
+DEF:write_av=<%= @rrd_path %>disk-<%= device %>/disk_octets.rrd:write:AVERAGE \
+DEF:write_min=<%= @rrd_path %>disk-<%= device %>/disk_octets.rrd:write:MIN \
+DEF:write_max=<%= @rrd_path %>disk-<%= device %>/disk_octets.rrd:write:MAX \
+AREA:read_max<%= @color[:green_light] %> \
+AREA:read_min#ffffff \
+AREA:write_max<%= @color[:blue_light] %> \
+AREA:write_min#ffffff \
+LINE1:read_av<%= @color[:green_dark] %>:"Read\t\t\t" \
+GPRINT:read_min:MIN:"Min. %3.0lf%sB" \
+GPRINT:read_av:AVERAGE:"Avg. %3.0lf%sB" \
+GPRINT:read_max:MAX:"Max. %3.0lf%sB" \
+GPRINT:read_av:LAST:"Last %3.0lf%sB" \
+LINE1:write_av<%= @color[:blue_dark] %>:"Write\t\t" \
+GPRINT:write_min:MIN:"Min. %3.0lf%sB" \
+GPRINT:write_av:AVERAGE:"Avg. %3.0lf%sB" \
+GPRINT:write_max:MAX:"Max. %3.0lf%sB" \
+GPRINT:write_av:LAST:"Last %3.0lf%sB" \