collectd-interface 0.3.1 → 0.5.0

data/lib/collectd/interface/service/data.rb

@@ -0,0 +1,110 @@
+require 'sinatra/base'
+module Collectd
+  module Interface
+    class Service < Sinatra::Base
+      # give the user an interface to select data from the Collectd
+      # RRD file stored on disk
+      get '/data' do
+        @data = settings.data
+        # client has selected a specific data source
+        if params.has_key?('display')
+          @target = params['display']
+          # this URI parameter needs to be removed for the redirect
+          params.delete('display') 
+          # all other URI parameters will be passed on
+          p = Array.new; params.each_pair { |k,v| p << "#{k}=#{v}" }
+          @args = p.join('&')
+          # get the data
+          redirect "/data/#{@target}?#{@args}"
+        # REST style interface discovery to list all available data sources
+        elsif params.has_key?('format')
+          case params['format']
+          when 'json'
+            content_type :json
+            JSON.pretty_generate @data.map! { |d| "/data/#{d}" }
+          # present a clear text by default
+          else
+            content_type :plain
+            @data.join("\n")
+          end
+        # render the default view display the selection menu
+        else
+          @target = 'data'
+          erb :data, :layout => "template/default".to_sym
+        end
+      end
+      # interface to the data source 
+      get '/data/*' do |path|
+        redirect '/data' if path.empty?
+        # build the data sources file name
+        plugin,type,value = path.split("/")
+        file = "#{settings.rrd_path}/#{plugin}/#{type}.rrd" 
+        unless File.exists? file
+          "Couldn't find source file #{file}"
+        else
+          data = Array.new
+          # construct the RRD query
+          # return average bu default
+          function = 'AVERAGE'
+          if params.has_key? 'function'
+            param = params['function'].upcase
+            if %w(AVERAGE MIN MAX).include? param
+              function = param
+            end
+          end
+          # build the command line to read the RRD file
+          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'
+          # 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? 'format'
+            if params['format'] == 'json'
+              content_type :json
+              json = {'name'=>"#{plugin} #{file}",'data'=>data}
+              JSON.pretty_generate json
+            else
+              content_type 'text/plain'
+              output = String.new
+              data.each { |line| output << "#{line[0]}: #{line[1..-1].join(' ')}\n" }
+              output
+            end
+          else
+            @data = data
+            erb :show_values
+          end
+        end
+      end
+    end
+  end
+end

data/lib/collectd/interface/service/graph.rb

@@ -0,0 +1,106 @@
+require 'sinatra/base'
+require 'fileutils'
+
+module Collectd
+  module Interface
+    class Service < Sinatra::Base
+      ##
+      ## 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.graphs.keys.sort.map! { |g| "/graph/#{g}" }
+          if params['format'] == 'json'
+            content_type :json
+            JSON.pretty_generate graph_list
+          else
+            content_type :text
+            graph_list.join("\n")
+          end
+        # By default the web-interface will be displayed 
+        else
+          # by default each graph presents the last 12 hours
+          unless params.has_key? 'start' and params.has_key? 'end'
+            params['start'] = 'end-12h'
+            params['end'] = 'now' 
+          end
+          params['image'] = 'png' unless params.has_key?('image')
+          # 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')
+          # 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.graphs
+          # identifier for the template
+          @target = 'graph'
+          # render the templates
+          erb :graph, :layout => "template/default".to_sym
+        end
+      end
+
+      get '/graph/*' do |path|
+        unless settings.graphs.has_key? path
+          redirect '/'
+        else
+          # name of the template use to render the graph
+          _template = settings.graphs[path]
+          # path to the public directory to store the rendered image
+          _target_path = File.dirname(File.join(settings.public_folder,'images',path))
+          FileUtils.mkdir_p(_target_path) unless File.directory? _target_path 
+          # variables available to the plug-in
+          @color = {
+            :red_light => '#FF000044', :red_dark => '#FF0000AA',
+            :green_light => '#00F00022', :green_dark => '#00F000AA',
+            :yellow_light => '#FFFF0022', :yellow_dark => '#FFFF00AA',
+            :blue_light => '#0000FF22', :blue_dark => '#0000FFAA',
+            :orange_light => '#FF450022', :orange_dark => '#FF4500AA',
+            :cyan_light => '#00FFFF22', :cyan_dark => '#00FFFFAA',
+            :purple_light => '#FF00FF22', :purple_dark => '#FF00FFAA'
+          }
+          @type = params.has_key?('image') ? params['image'] : 'png'
+          if params.has_key? 'start' and params.has_key? 'end'
+            @start = params['start']
+            @end = params['end']
+          else
+            @start = 'end-24h'
+            @end = 'now'
+          end
+          # clients can query custom sized graphs, without legend
+          @graph_only = false
+          if params.has_key?('width') and params.has_key?('height') 
+            @width = params['width']
+            @height = params['height']
+            @graph_only = true 
+          # default graph size
+          else
+            @width = 400 
+            @height = 100
+          end
+          # name of the file to store the graph image into
+          @target = %Q[#{settings.public_folder}/images/#{path}.#{@type}]
+          # location of the Collectd RRD files
+          @rrd_path = settings.rrd_path + '/'
+          # last value of the URI path is parameter to the template
+          @param = path.split('/')[-1]
+          # run the plug-in the generate to image
+          command = erb :"graphs/#{_template}", :layout => :graph_header
+          puts command.chomp if $DEBUG
+          output = `#{command} > /dev/null 2>&1`
+          puts output.chomp if $DEBUG and not output.empty?
+          # redirect the client to the rendered image
+          redirect %Q[/images/#{path}.#{@type}]
+        end
+      end
+    end
+  end
+end

data/lib/collectd/interface/service/report.rb

@@ -0,0 +1,82 @@
+require 'uri'
+require 'net/http'
+require 'sinatra/base'
+
+module Collectd
+  module Interface
+    class Service < Sinatra::Base
+
+      get '/report' do
+        @reports = settings.reports.keys.sort 
+        # List all available path to reports
+        if params.has_key? 'format' 
+          report_list = @reports.map! { |r| "/report/#{r}" }
+          if params['format'] == 'json'
+            content_type :json
+            JSON.pretty_generate report_list
+          else # default is plain text
+            content_type :text
+            report_list.join("\n")
+          end
+        # Render a HTML representation of all/one report(s)
+        else
+          # list of the URLs to requested all reports selected by the client query
+          _reports_selected = Array.new
+          # the default report to display
+          unless params.has_key? 'display'
+            _reports_selected << '/report/storage?format=html'
+          # when a selection is passed by URI parameter
+          else 
+            _display = params['display']
+            # show all reports
+            if _display == 'all'
+              @reports.each do |path|
+                _reports_selected << "/report/#{path}?format=html"
+              end
+            # a report select by the client
+            else
+              not_fount unless settings.reports.has_key?(_display)
+              # query URL for this request
+              _reports_selected << "/report/#{_display}?format=html"
+            end
+          end
+          @target = 'report'
+          # actual reports requested by the client query
+          @reports_selected = Hash.new
+          _reports_selected.each do |path| 
+            __uri = URI.parse("http://localhost:#{settings.port}#{path}")
+            @reports_selected[path] = Net::HTTP.get_response(__uri).body
+          end
+          erb :report, :layout => :'template/default'
+        end
+      end
+
+      get '/report/*' do |path|
+        redirect '/report' if path.empty?
+        unless settings.reports.has_key?(path)
+          redirect '/report'
+        end
+        _template = settings.reports[path]
+        # user asks for a specific output format
+        if params.has_key?('format')
+          case params['format']
+          when 'json'
+            content_type :json
+            @type = 'json'
+          when 'html'
+            @type = 'html'
+          else 
+            content_type :plain 
+            @type = 'text'
+          end
+        else
+          content_type :plain
+          @type = 'text'
+        end
+        @param = path.split('/')[-1]
+        erb :"reports/#{_template}"
+      end
+   
+    end
+  end
+end

data/lib/collectd/interface/service.rb

@@ -0,0 +1,44 @@
+require 'json'
+require 'sinatra/base'
+require 'collectd/interface/config'
+require 'collectd/interface/service/data'
+require 'collectd/interface/service/graph'
+require 'collectd/interface/service/report'
+
+module Collectd
+  module Interface
+    class Service < Sinatra::Base
+      configure do
+        mime_type :json, 'application/json'
+        mime_type :plain, 'text/plain'
+        # read the configuration object and set the Sinatra defaults
+        set :root, Config.root
+        set :port, Config['service']['port']
+        set :rrd_path, Config['rrd_path']
+        set :public_folder, File.join(Config.root,'public')
+        set :static, true
+        set :environment, :production
+        set :graphs, Config['graphs']
+        set :data, Config['data']
+        set :reports, Config['reports']
+      end
+      get '/' do
+        redirect '/graph'
+      end
+      get '/config/:name' do
+        if settings.respond_to?(params[:name])
+          _data = settings.send(params[:name])
+          if %w(graphs reports data).include? params[:name]
+            content_type :json
+            JSON.pretty_generate(_data)
+          else
+            content_type :text
+            _data
+          end
+        else
+          not_found
+        end
+      end
+    end
+  end
+end