collectd-rest-server 0.0.1

data/bin/collectd-rest-server

@@ -0,0 +1,334 @@
+#!/usr/bin/env ruby
+
+#---------------------------------------------------------------
+#
+# REST interface to the RRD stored by Collectd
+#
+# This is free software: you can redistribute it
+# and/or modify it under the terms of the GNU General Public
+# License as published by the Free Software Foundation,
+# either version 3 of the License, or (at your option) any
+# later version.
+#
+# This program is distributed in the hope that it will be 
+# useful, but WITHOUT ANY WARRANTY; without even the implied 
+# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
+# PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public 
+# License along with this program. If not, see 
+#
+#   <http://www.gnu.org/licenses/>.
+#
+#----------------------------------------------------------------
+# Author: Victor Penso
+# Copyright 2011
+# Version: 0.0.1
+#----------------------------------------------------------------
+
+
+require 'rubygems'
+require 'json'
+require 'getoptlong'
+require 'ostruct'
+
+exec_name = File.split(__FILE__)[-1]
+
+help = <<-EOF
+Synopsis
+========
+
+#{exec_name}: Run a REST interface to your local Collectd.
+
+Usage
+-----
+
+#{exec_name} [OPTIONS]
+
+  OPTIONS: see below.
+
+Options
+-------
+
+  --help,-h:
+    Show this help information.
+  --debug, -d:
+    More verbose output while running this.
+  --port,-p NUMBER:
+    Start the REST server at port NUMBER.
+  --log,-l PATH:
+    Write the log output to PATH.
+  --files, -f PATH:
+    RRD files are located in PATH.
+    Default is /var/lib/collectd/rrd 
+  --pid-file, -P PATH:
+    Write the process ID to a file in PATH.
+
+Examples
+--------
+
+Run the stuff in debug-mode:
+
+    #{exec_name} -d
+
+Start the server as root service:
+
+
+    #{exec_name} -p 5000 -l /var/log/ -P /var/run/
+
+REST
+====
+
+List all available values:
+
+    http://../list-values
+
+Get a the time-series of a specific value.
+
+    http://../interface/if_packets-eth0/rx
+
+By default the severs will answer with averages 
+of all data-points and an HTML document.
+
+Parameters
+----------
+
+    http://../value?last=36h&resolution=3600
+
+Request only values from the last 36 hours, with a
+data point resolution of 1 hour (3600 seconds).
+Default resolution is the highest possible and you
+will get by default values of the last 24 hours.
+In the time specification you can also use (w)eeks,
+(d)ays and (m)inutes.
+
+    http://../rx?function=max&format=json
+
+Request the maximum of all data points for the past
+in the JSON format. Other consolidation functions
+are average (default) and min, for the smallest value
+in a time-frame.
+
+    http://../value?callback=parseResponse 
+
+The server then wraps its JSON response with this 
+prefix, or "padding", before sending it to the browser.
+
+EOF
+
+options = OpenStruct.new
+options.debug = false
+options.port = 4567
+options.log = nil
+options.files = '/var/lib/collectd/rrd'
+options.pid_file = nil
+
+GetoptLong.new(
+  ['--help','-h',GetoptLong::NO_ARGUMENT],
+  ['--debug','-d',GetoptLong::NO_ARGUMENT],
+  ['--port','-p',GetoptLong::REQUIRED_ARGUMENT],
+  ['--log','-l',GetoptLong::REQUIRED_ARGUMENT],
+  ['--files','-f',GetoptLong::REQUIRED_ARGUMENT],
+  ['--pid-file','-P',GetoptLong::REQUIRED_ARGUMENT]
+).each do |opt,arg|
+  case opt
+  when '--port'
+    options.port = arg
+  when '--log'
+    options.log = arg
+  when '--files'
+    options.files = arg
+  when '--pid-file'
+    options.pid_file = arg
+  when '--debug'
+    options.debug = true
+    $DEBUG = true
+  when '--help'
+    $stdout.puts help
+    exit 0
+  end
+end
+
+# Didn't found a better way to pass configuration to the Sinatra instance
+ENV['COLLECTD_RRD_FILES'] = options.files
+
+# Make sure to parse ARGV before loading Sinatra! 
+require 'sinatra'
+
+#---------------------------------------------------------------
+# REST provider
+#---------------------------------------------------------------
+
+class Collecter < Sinatra::Base
+
+  configure do 
+    mime_type :json, 'application/json'  # JSON as supported output format
+    enable :inline_templates             # HTML templates at the bottom of this file
+    enable :run                          # this will be executed by wrapper scripts
+    hostname = `hostname -f`.chop
+    set :path, "#{ENV['COLLECTD_RRD_FILES']}/#{hostname}/"
+    # list available RRD databases of this host
+    values = Array.new
+    Dir["#{settings.path}/**/*.rrd"].each do |file|
+      plugin = file.gsub(%r<#{settings.path}>,'').split('/')[1]
+      rrd = File.basename(file,'.rrd')
+      `rrdtool info #{file}`.scan(%r{ds\[(\w*)\]}).uniq.flatten.each do |set|
+        values << "#{plugin}/#{rrd}/#{set}"
+      end
+    end
+    set :values, values	
+  end
+
+  get '/list-values' do
+     if params.has_key? 'callback'
+       content_type :js
+       json = JSON.pretty_generate settings.values
+       response = "#{params['callback']}(#{json})" 
+       response
+     elsif params['format'] == 'json'
+       content_type :json
+       JSON.pretty_generate settings.values
+     else
+       @data = settings.values
+       erb :values
+     end
+  end
+
+  get '/*' do |path|
+    redirect '/list-values' unless settings.values.include?(path)
+    plugin,type,value = path.split("/")
+    file = "#{settings.path}/#{plugin}/#{type}.rrd"
+    if File.exists? file
+      data = Array.new
+      # construct the RRD query
+      function = 'AVERAGE'
+      if params.has_key? 'function'
+        param = params['function'].upcase
+        puts param
+        if %w(AVERAGE MIN MAX).include? param
+          function = param
+        end
+      end
+      command = "rrdtool fetch #{file} #{function}"
+      command << " --end Now --start Now-#{params['last']}" if params.has_key? 'last'
+      command << " --r #{params['resolution']}"if params.has_key? 'resolution'
+      $stderr.puts command if $DEBUG
+      # get the data
+      output = `#{command}`.split("\n")
+      # select the value of interest
+      headers = output.shift.split # remove header
+      key = headers.index(value)
+      output.delete_at 0 # remove empty line
+      # collect the data
+      output.each do |line|
+        line = line.delete(':').split
+        time = line[0].to_i
+        value = line[key+1].to_f # omit time stamp
+        lv = data[-1]
+        data << [time, value]
+      end
+      #remove most time wrong elements
+      data.slice!(0)
+      data.slice!(-1)
+      #filter values which are the same for multiple timestamps
+      final_data = []
+      data.each_index do |el|
+        cur_e = data[el][1]
+        if data[el-1] != nil and data[el+1] != nil and el != 0 and el != data.size-1
+          last_e = data[el-1][1]
+          next_e = data[el+1][1]
+          if cur_e != last_e or cur_e != next_e then
+            final_data.push(data[el])
+          end
+        else
+          final_data.push(data[el])
+        end
+      end
+      data = final_data
+      if params.has_key? 'callback'
+        content_type :js
+        json = {'name'=>"#{plugin} #{type}",'type'=>'spline' ,'data'=>data, 'stack'=>"#{plugin}"}
+        json = JSON.pretty_generate json
+        response = "#{params['callback']}(#{json})" 
+        response
+      elsif params['format'] == 'json'
+        content_type :json
+        json = {'name'=>"#{plugin} #{file}",'type'=>'spline' ,'data'=>data, 'stack'=>"#{plugin}"}
+        JSON.pretty_generate json
+      else
+        @data = data
+        erb :data
+      end
+    end
+  end
+
+  error do
+    flash[:error] = env['sinatra.error'].to_s
+    redirect '/list-values'
+  end
+end
+
+#--------------------------------------------------------------
+# Main program
+#--------------------------------------------------------------
+
+
+begin
+
+  unless options.log.nil?
+    file = File.join(options.log,"#{exec_name}.log")
+    $stdout.reopen(file, 'w')
+    $stdout.sync = true
+    $stderr.reopen($stdout)
+  end
+
+  unless options.pid_file.nil?
+    File.open(File.join(options.pid_file,"#{exec_name}.pid"),'w') do |f| 
+      f.puts $$ 
+    end
+  end
+
+  # start the REST interface
+  Collecter.run!( :port => options.port )
+
+rescue => exc
+  $stderr.puts "ERROR: #{exc.message}"
+  $stderr.puts "  use -h for detailed instructions"
+  if options.debug
+    $stderr.puts '-- Stack Trace --'
+    $stderr.puts exc.backtrace
+  else
+    $stderr.puts 'You may want run this in debug mode with \'-d\''
+  end
+  exit 1
+end
+
+exit 0
+
+#--------------------------------------------------------
+# Templates for the REST provider
+#--------------------------------------------------------
+
+__END__
+@@ layout
+<html>
+  <body>
+    <%= yield %>
+  </body>
+</html>
+
+@@ values
+   <ul style='list-style-type:none'>
+     <% for val in @data %>
+     <li><%= val %></li>
+     <% end %>
+   </ul>
+
+@@ data
+   <table> 
+     <% for entry in @data %>
+     <tr><td><%= entry[0] %></td><td><%= entry[1]%></td></tr>
+     <% end %>
+   </table>
+
+

data/init.d/collectd-rest-server

@@ -0,0 +1,50 @@
+#!/bin/bash
+
+HOME=/opt/collectd
+PORT=5000
+LOG_PATH=/var/log
+PID_PATH=/var/run
+TIME=`date +'%Y-%m-%d %H:%M'`
+
+PID=-1 # non existing
+PID_FILE=$PID_PATH/collectd-rest-server.pid
+if [ -e $PID_FILE ]; then
+  PID=$(cat $PID_FILE)
+fi
+
+start() {
+    $HOME/collectd-rest-server -p $PORT -l $LOG_PATH -P $PID_PATH &
+}
+stop() {
+  if ps -p $PID > /dev/null 2>&1; then
+    kill -TERM ${PID}
+  fi
+}
+
+case "$1" in
+  start)
+    start
+    ;;
+  stop)
+    stop
+    rm $PID_FILE
+    ;;
+  restart)
+    stop
+    sleep 2
+    start
+    ;;
+  status)
+    if [ -e /proc/${PID} -a /proc/${PID}/exe ]; then
+      exit 0
+    else
+      exit 1
+    fi
+    ;;
+  *)
+    echo "Usage: $0 start|stop|restart|status"
+    exit 1
+    ;;
+esac
+
+exit 0

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: collectd-rest-server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Victor Penso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-01 00:00:00.000000000 +02:00
+default_executable: collectd-rest-server
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: &19329200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: *19329200
+description: ''
+email: v.penso@gsi.de
+executables:
+- collectd-rest-server
+extensions: []
+extra_rdoc_files: []
+files:
+- init.d/collectd-rest-server
+- bin/collectd-rest-server
+has_rdoc: true
+homepage: ''
+licenses:
+- GPLv3
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Collectd-Rest-Server
+require_paths:
+- ''
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- Collectd  (http://collectd.org)
+rubyforge_project: collectd-rest-server
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Servers a REST interface exposing data from RRD files stored by Collectd
+test_files: []